JavaScript/jQuery Draggable Methods

Methods of the DomComponent object.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:

rule:

Object

The component's default device options.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Object

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Draggable widget in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxDraggable.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Draggable options
    }
});

Angular

TypeScript

import Draggable from "devextreme/ui/draggable";
// ...
export class AppComponent {
    constructor () {
        Draggable.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Draggable options
            }
        });
    }
}

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 options
    }
});

export default {
    components: {
        DxDraggable
    }
}
</script>

React

import React from "react";
import dxDraggable from "devextreme/ui/draggable";
import Draggable from "devextreme-react/draggable";

class App extends React.Component {
    render () {
        dxDraggable.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Draggable options
            }
        })
        return (
            <div>
                <Draggable id="draggable1" />
                <Draggable id="draggable2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the Draggable instance.

After calling this method, remove the DOM element associated with the widget:

JavaScript

$("#myDraggable").dxDraggable("dispose");
$("#myDraggable").remove();

Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular

app.component.html

<dx-draggable ...
    *ngIf="condition">
</dx-draggable>

Vue

App.vue

<template>
    <DxDraggable ...
        v-if="condition">
    </DxDraggable>
</template>

<script>
import DxDraggable from 'devextreme-vue/draggable';

export default {
    components: {
        DxDraggable
    }
}
</script>

React

App.js

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;

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

Element

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget 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);

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value: Draggable

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

String

The event's name.

Return Value: Draggable

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value: Draggable

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value: Draggable

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value: Draggable

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

option()

Gets all widget options.

Return Value:

Object

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

String

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Object

Options with their new values.

resetOption(optionName)

Resets an option to its default value.

Parameters:

optionName:

String

An option's name.

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

JavaScript/jQuery Draggable Methods

beginUpdate()

See Also

defaultOptions(rule)

jQuery

Angular

Vue

React

dispose()

Angular

Vue

React

See Also

element()

See Also

endUpdate()

See Also

getInstance(element)

See Also

instance()

See Also

off(eventName)

See Also

off(eventName, eventHandler)

See Also

on(eventName, eventHandler)

See Also

on(events)

See Also

option()

See Also

option(optionName)

See Also

option(optionName, optionValue)

See Also

option(options)

See Also

resetOption(optionName)

See Also