Methods

The component's default device options.

Object structure:

device:

Device

|

Array<Device>

|

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:

Options to be applied.

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

jQuery

JavaScript

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

Angular

TypeScript

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

dispose()

Removes the widget from the DOM.

element()

Gets the root widget element.

Return Value:

Element (jQuery or HTML)

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()

focus()

Sets focus on the widget.

getInstance(element)

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

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

The widget's instance.

The following code gets the RangeSlider instance found in an element with ID myRangeSlider:

// Modular approach
import RangeSlider from 'devextreme/ui/range_slider';
...
let element = document.getElementById("myRangeSlider");
let instance = RangeSlider.getInstance(element);

// Non-modular approach
let element = document.getElementById("myRangeSlider");
let instance = DevExpress.ui.dxRangeSlider.getInstance(element);

instance()

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

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

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:

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

Return Value:

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:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

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:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

The key.

handler: