JavaScript/jQuery Sortable Methods
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)
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 Sortable UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxSortable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Sortable properties
}
});Angular
import Sortable from "devextreme/ui/sortable";
// ...
export class AppComponent {
constructor () {
Sortable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Sortable properties
}
});
}
}Vue
<template>
<div>
<DxSortable id="sortable1" />
<DxSortable id="sortable2" />
</div>
</template>
<script>
import DxSortable from "devextreme-vue/sortable";
import Sortable from "devextreme/ui/sortable";
Sortable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Sortable properties
}
});
export default {
components: {
DxSortable
}
}
</script>React
import React, {useEffect} from "react";
import dxSortable from "devextreme/ui/sortable";
import Sortable from "devextreme-react/sortable";
export default function App() {
useEffect(() => {
dxSortable.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Sortable properties
}
})
});
return (
<div>
<Sortable id="sortable1" />
<Sortable id="sortable2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#mySortable").dxSortable("dispose");
$("#mySortable").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-sortable ...
*ngIf="condition">
</dx-sortable>Vue
<template>
<DxSortable ...
v-if="condition">
</DxSortable>
</template>
<script>
import DxSortable from 'devextreme-vue/sortable';
export default {
components: {
DxSortable
}
}
</script>React
import React from 'react';
import Sortable from 'devextreme-react/sortable';
function DxSortable(props) {
if (!props.shouldRender) {
return null;
}
return (
<Sortable ... >
</Sortable>
);
}
class App extends React.Component {
render() {
return (
<DxSortable shouldRender="condition" />
);
}
}
export default App;See Also
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Sortable instance found in an element with the mySortable ID:
// Modular approach
import Sortable from "devextreme/ui/sortable";
...
let element = document.getElementById("mySortable");
let instance = Sortable.getInstance(element) as Sortable;
// Non-modular approach
let element = document.getElementById("mySortable");
let instance = DevExpress.ui.dxSortable.getInstance(element);See Also
update()
Updates Sortable's dimensions. Call this method after items are added or their dimensions are changed during dragging.