Methods

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

beginUpdate()

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

The beginUpdate and endUpdate methods allow you to apply several modifications to the widget at once. After the beginUpdate method is called, the widget does not rerender itself until the endUpdate method is called. The usage of these methods prevents excessive widget updating when changing multiple widget settings at once.

NOTE: It is recommended that you do not perform any actions on a widget within the updating transaction other than changing widget options.

endUpdate()

Enables the widget to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the widget at once. After the beginUpdate method is called, the widget does not rerender itself until the endUpdate method is called. The usage of these methods prevents excessive widget updating when changing multiple widget settings at once.

NOTE: It is recommended that you do not perform any actions on a widget within the updating transaction other than changing widget options.

getSelectedRange()

Returns the currently selected range.

Return Value: Object

An object representing the start and end values of 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 selectedRangeChanged callback function.

To get the start and end values, use the startValue and endValue fields of the returned object, respectively.

Show Example:
jQuery

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


                                    

                                    

hideLoadingIndicator()

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.

Show Example:
jQuery

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.


                                    

                                    

instance()

Returns an instance of the widget.

Return Value: Object

An instance of the widget.

Use this method to access the widget.

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.


                                    

                                    

option()

Returns the object representing the configuration options of the widget.

Return Value: Object

The object representing the configuration options of the widget.

Use the fields of the returned object to configure the widget.

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 dxRangeSelector 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 dxRangeSelector 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 widget options.

Parameters:
options: Object

An object containing required configuration options.

To set one or more widget options, pass the object that contains fields representing these options as the options parameter.

This method is useful if you need to configure several widget options at once.

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.


                                    

                                    

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 perform the chart animation on redraw. Otherwise, pass true or call the render method without a parameter.

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)

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

An end value of the selected range.

endValue: Date|Number

An end value of the selected range.

To set start and end values, use the startValue and endValue fields of the object passed as the selectedRange parameter.

Show Example:
jQuery

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


                                    

                                    

showLoadingIndicator()

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.

Show Example:
jQuery

In this example, the showLoadingIndicator() method invokes when the example loads. Note that it is not necessary to conceal the loading indicator using the hideLoadingIndicator() method, since it executes automatically.


                                    

                                    

svg()

Returns the widget's SVG markup.

Return Value: String

The widget's SVG markup.

NOTE: This method does not support Internet Explorer 8.

Show Example:
jQuery

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