JavaScript/jQuery Sortable Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
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, { Properties } from "devextreme/ui/sortable"; // ... export class AppComponent { constructor () { Sortable.defaultOptions<Properties>({ 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 dxSortable from "devextreme/ui/sortable"; import Sortable from "devextreme-react/sortable"; dxSortable.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Sortable properties } }); export default function App() { return ( <div> <Sortable id="sortable1" /> <Sortable id="sortable2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxSortable.defaultOptions({ device: deviceConfig, options: { // Here go the Sortable properties } }); });
Angular
import Sortable, { Properties } from "devextreme/ui/sortable"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Sortable.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the Sortable properties } }); }); } }
Vue
<template> <div> <DxSortable /> </div> </template> <script> import DxSortable from "devextreme-vue/sortable"; import Sortable from "devextreme/ui/sortable"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Sortable.defaultOptions({ device: deviceConfig, options: { // Here go the Sortable properties } }); }); export default { components: { DxSortable } } </script>
React
import dxSortable from "devextreme/ui/sortable"; import Sortable from "devextreme-react/sortable"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxSortable.defaultOptions({ device: deviceConfig, options: { // Here go the Sortable properties } }); }); export default function App() { return ( <div> <Sortable /> </div> ) }
dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#mySortable").dxSortable("dispose"); $("#mySortable").remove();
Angular
Use conditional rendering instead of this method:
<dx-sortable ... *ngIf="condition"> </dx-sortable>
Vue
Use conditional rendering instead of this method:
<template> <DxSortable ... v-if="condition"> </DxSortable> </template> <script> import DxSortable from 'devextreme-vue/sortable'; export default { components: { DxSortable } } </script>
React
Use conditional rendering instead of this method:
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;
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
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
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
update()
Updates Sortable's dimensions. Call this method after items are added or their dimensions are changed during dragging.
If you have technical questions, please create a support ticket in the DevExpress Support Center.