JavaScript/jQuery Draggable Methods
Methods of the DomComponent object.
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Draggable UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxDraggable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Draggable properties
}
});Angular
import Draggable from "devextreme/ui/draggable";
// ...
export class AppComponent {
constructor () {
Draggable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Draggable properties
}
});
}
}Vue
<template>
<div>
<DxDraggable id="draggable1" />
<DxDraggable id="draggable2" />
</div>
</template>
<script>
import DxDraggable from "devextreme-vue/draggable";
import Draggable from "devextreme/ui/draggable";
Draggable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Draggable properties
}
});
export default {
components: {
DxDraggable
}
}
</script>React
import React, {useEffect} from "react";
import dxDraggable from "devextreme/ui/draggable";
import Draggable from "devextreme-react/draggable";
export default function App() {
useEffect(() => {
dxDraggable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Draggable properties
}
})
});
return (
<div>
<Draggable id="draggable1" />
<Draggable id="draggable2" />
</div>
)
}dispose()
Disposes of all the resources allocated to the Draggable instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myDraggable").dxDraggable("dispose");
$("#myDraggable").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-draggable ...
*ngIf="condition">
</dx-draggable>Vue
<template>
<DxDraggable ...
v-if="condition">
</DxDraggable>
</template>
<script>
import DxDraggable from 'devextreme-vue/draggable';
export default {
components: {
DxDraggable
}
}
</script>React
import React from 'react';
import Draggable from 'devextreme-react/draggable';
function DxDraggable(props) {
if (!props.shouldRender) {
return null;
}
return (
<Draggable ... >
</Draggable>
);
}
class App extends React.Component {
render() {
return (
<DxDraggable shouldRender="condition" />
);
}
}
export default App;See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Draggable instance found in an element with the myDraggable ID:
// Modular approach
import Draggable from "devextreme/ui/draggable";
...
let element = document.getElementById("myDraggable");
let instance = Draggable.getInstance(element) as Draggable;
// Non-modular approach
let element = document.getElementById("myDraggable");
let instance = DevExpress.ui.dxDraggable.getInstance(element);See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
option(options)
Updates the values of several properties.
Options with their new values.
resetOption(optionName)
Resets a property to its default value.
A property's name.