Methods

This section describes the methods that can be used in code to manipulate objects related to the RangeSelector.

beginUpdate()

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.

element()

Returns the root HTML element of the widget.

Return Value: jQuery
The root element of the widget.

endUpdate()

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.

exportTo(fileName, format)

Exports the widget into a document with a specified name and format.

Parameters:
fileName: String
The name of a destination file.
format: String
A required format.
Accepted Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
NOTE
IE9 and Safari on Mac OS do not implement an API for saving files. Therefore, exporting in these browsers requires setting up a server-side proxy. For details, refer to the export | proxyUrl option description.
See Also

getDataSource()

Returns the DataSource instance.

Return Value: DataSource
The DataSource instance.
NOTE
This method returns the DataSource instance even if the dataSource option of the widget was given a simple array.
See Also

getSelectedRange()

Deprecated

Use the getValue() method instead.

Returns the currently selected range.

Return Value: Object
An object representing the start and end values of the currently selected range.

getValue()

Gets the currently selected range.

Return Value: Array
Two values that represent the start and end values of the currently selected range.
Show Example:
jQuery

In this example, a click on the 'Get selected range' button displays the currently selected range. Here, the getValue() method is used to obtain this range.


                                    

                                    

hideLoadingIndicator()

Conceals the loading indicator.

Although the loading indicator hides automatically when the widget is ready, you can hide it from code at the required time using the hideLoadingIndicator() method.

If you need to show the loading indicator, invoke the showLoadingIndicator() method.

Show Example:
jQuery

In this example, data is loaded with five seconds delay. You can show/hide the loading indicator using the buttons under the widget. Note that the loading indicator can be displayed or concealed manually at any time no matter whether the data is loaded or not.


                                    

                                    

instance()

Returns an instance of this component class.

Return Value: Object
An instance of this component class

Use this method to access other methods of the component.

Show Example:
jQuery

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.

<!--JavaScript -->$("#rangeSelectorContainer").dxRangeSelector("instance")

Click the button below to display the currently selected range.


                                    

                                    

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
Return Value: Object
The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
eventHandler: function
The handler to be detached from the specified event.
Return Value: Object
The object for which this method is called.

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String
The name of the event to be subscribed.
eventHandler: function
An event handler for the specified event.
Return Value: Object
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

on(events)

Subscribes to the specified events.

Parameters:
events: Object
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
Return Value: Object
The object for which this method is called.

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

See Also

option()

Returns the configuration options of this component.

Return Value: Object
An object representing the configuration options of this component.

Show Example:
jQuery

In this example, the option() method is used to obtain the value of the behavior | allowSlidersSwap option and display it under the range selector. To change this value, use the check box below.


                                    

                                    

option(optionName)

Gets the value of the specified configuration option of the widget.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.

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 RangeSelector widget.

Show Example:
jQuery

In this example, the option(optionName) method is used to obtain the value of the behavior | allowSlidersSwap option and display it under the range selector. To change this value, use the check box below.


                                    

                                    

option(optionName, optionValue)

Sets a value to the specified configuration option of the widget.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value to be assigned to the required option.

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 RangeSelector widget to true, pass the "behavior.allowSlidersSwap" value as the optionName parameter and the "true" value as the optionValue parameter.

Show Example:
jQuery

In this example, the option(optionName, optionValue) method is used to set the value of the behavior | allowSlidersSwap option at runtime. To change this value, use the check box below.


                                    

                                    

option(options)

Sets one or more options of this component.

Parameters:
options: Object
An object containing the required configuration options.

Show Example:
jQuery

In this example, the option(options) method is used to alter a set of options at once. To change the values of the behavior | allowSlidersSwap and scale | showMinorTicks options, use the check box below.


                                    

                                    

print()

Opens the browser's print window.

See Also

render()

Redraws the widget.

Normally, the widget will redraw itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, e.g., after the widget container is resized. For this purpose, call the render() method.

render(skipChartAnimation)

Redraws a widget.

Parameters:
skipChartAnimation: Boolean
Specifies whether or not to animate the chart within a range selector on render.

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 animate the chart on redraw. Otherwise, pass true or call the render method without parameters.

Show Example:
jQuery

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.


                                    

                                    

setSelectedRange(selectedRange)

Deprecated

Use the setValue(value) method instead.

Sets a specified range.

Parameters:
selectedRange: Object
An object representing the start and end values of the selected range to be set.
Object structure:
startValue: Date|Number|String
An end value of the selected range.
endValue: Date|Number|String
An end value of the selected range.

setValue(value)

Selects a specific range.

Parameters:
value: Array
Two values that represent the start and end values of the range to be selected.
Show Example:
jQuery

In this example, the [5, 8] range is selected after the RangeSelector widget is displayed. Change the selected range and click the 'Set default selected range' button. The [5, 8] range will be selected using the setValue method.


                                    

                                    

showLoadingIndicator()

Displays the loading indicator.

This method shows the loading indicator. To hide it, call the hideLoadingIndicator() method.

Show Example:
jQuery

In this example, the loading indicator is displayed until data is ready (5 seconds in this example). You can show and hide the loading indicator using the corresponding buttons below.


                                    

                                    

svg()

Returns the widget's SVG markup.

Return Value: String
The widget's SVG markup.

Show Example:
jQuery

Click the Get SVG below the range selector, and the SVG copy of this range selector will appear.