This section describes the methods that can be used in code to manipulate objects related to the dxRangeSelector.
Prevents the component from refreshing until the endUpdate method is called.
The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.
Returns the root HTML element of the widget.
Enables the component to refresh after the beginUpdate method call.
The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.
Returns the currently selected range.
To obtain the currently selected range once, use the getSelectedRange() method. If you need to obtain the selected range each time it is modified, use the onSelectedRangeChanged callback function.
To get the start and end values, use the startValue and endValue fields of the returned object, respectively.
Conceals the loading indicator.
Although the loading indicator hides automatically when a range selector is ready, you can hide it from code at the required time using the hideLoadingIndicator() method.
To show the loading indicator, invoke the showLoadingIndicator() method.
In this example, the range selector options are assigned five seconds after the example is loaded. You can show/hide the loading indicator using the buttons under the range selector. Note that the loading indicator can be displayed or concealed manually at any time regardless of whether the range selector is ready or not.
Returns an instance of this component class.
Use this method to access other methods of the component.
In the following example, the instance() method is used to get access to the range selector options. This method is not called like the other methods. To call the instance() method, the following construction is used.
Click the button below to display the currently selected range.
Detaches all event handlers from the specified event.
Detaches a particular event handler from the specified event.
Subscribes to a specified event.
Subscribes to the specified events.
Returns the configuration options of this component.
Gets the value of the specified configuration option of the widget.
To get the value of a configuration option, specify the path to the field representing this option in the configuration object. For example, pass the "behavior.allowSlidersSwap" value as the optionName parameter to get the value of the behavior | allowSlidersSwap option of the dxRangeSelector widget.
Sets a value to the specified configuration option of the widget.
To set the value to the configuration option, specify the path to the field representing this option in the configuration object. For example, to set the behavior | allowSlidersSwap option of the dxRangeSelector widget to true, pass the "behavior.allowSlidersSwap" value as the optionName parameter and the "true" value as the optionValue parameter.
Sets one or more options of this component.
Redraws a widget.
When the size of a range selector container changes at runtime, the range selector should be redrawn explicitly. To do this, call its render(skipChartAnimation) method.
If your range selector contains a chart in the background, you can specify whether or not to animate it on render. Pass false as the parameter to perform the chart animation on redraw. Otherwise, pass true or call the render method without a parameter.
In this example, you can change the container size using the button below. In order to redraw the range selector after the container size is changed, its render method is called. The chart within the range selector is animated on redraw because false is passed as the parameter to the render method.
Sets a specified range.
To set start and end values, use the startValue and endValue fields of the object passed as the selectedRange parameter.
Displays the loading indicator.
The loading indicator does not appear automatically. In order to display it, the showLoadingIndicator() method should be invoked.
To hide the loading indicator from code, use the hideLoadingIndicator() method.
Returns the widget's SVG markup.