Methods
This section describes the members used to manipulate the widget.
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.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the RangeSlider widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxRangeSlider.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the RangeSlider options } });
Angular
import RangeSlider from "devextreme/ui/range_slider"; // ... export class AppComponent { constructor () { RangeSlider.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the RangeSlider options } }); } }
Vue
<template> <div> <dx-range-slider id="rangeSlider1" /> <dx-range-slider id="rangeSlider2" /> </div> </template> <script> import DxRangeSlider from "devextreme-vue/range-slider"; import RangeSlider from "devextreme/ui/range_slider"; RangeSlider.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the RangeSlider options } }); export default { components: { DxRangeSlider } } </script>
React
import React from "react"; import dxRangeSlider from "devextreme/ui/range_slider"; import RangeSlider from "devextreme-react/range-slider"; class App extends React.Component { render () { dxRangeSlider.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the RangeSlider options } }) return ( <div> <RangeSlider id="rangeSlider1" /> <RangeSlider id="rangeSlider2" /> </div> ) } } export default App;
dispose()
Disposes of all the resources allocated to the RangeSlider instance.
After calling this method, remove the DOM element associated with the widget:
jQuery
$("#myRangeSlider").dxRangeSlider("dispose"); $("#myRangeSlider").remove();
Angular
<dx-range-slider #rangeSliderVar id="myRangeSlider"></dx-range-slider>
import { ..., ViewChild } from "@angular/core"; import { DxRangeSliderComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("rangeSliderVar", { static: false }) rangeSlider: DxRangeSliderComponent; // Prior to Angular 8 // @ViewChild("rangeSliderVar") rangeSlider: DxRangeSliderComponent; removeRangeSlider (e) { this.rangeSlider.instance.dispose(); document.getElementById("myRangeSlider").remove(); } }
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
Sets focus on the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
Gets the instance of a widget found using its DOM node.
The widget's instance.
getInstance is a static method that the widget class supports. The following code demonstrates how to get the RangeSlider instance found in an element with the myRangeSlider
ID:
// Modular approach import RangeSlider from "devextreme/ui/range_slider"; ... let element = document.getElementById("myRangeSlider"); let instance = RangeSlider.getInstance(element) as RangeSlider; // Non-modular approach let element = document.getElementById("myRangeSlider"); let instance = DevExpress.ui.dxRangeSlider.getInstance(element);
See Also
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
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.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
Repaints the widget without reloading data. Call it to update the widget's markup.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
reset()
Resets the value option to the default value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
Resets an option to its default value.
An option's name.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.