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. After the beginUpdate method is called, the widget does not raise events, and does not rerender itself until the endUpdate method is called. Using these methods prevents excessive widget updates when changing multiple widget settings at once.

Show Example:
jQuery

In this example, the scale | showMinorTicks and sliderMarker | visible options can be changed using the buttons below the range selector. To alter the values of these options, click the beginUpdate() button. The options will be changed but the range selector will not be refreshed until you click the endUpdate() button.


                                    

                                    

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. After the beginUpdate method is called, the widget does not raise events, and does not rerender itself until the endUpdate method is called. Using these methods prevents excessive widget updates when changing multiple widget settings at once.

Show Example:
jQuery

In this example, the scale | showMinorTicks and sliderMarker | visible options can be changed using the buttons below the range selector. To alter the values of these options, click the beginUpdate() button. The options will be changed but the range selector will not be refreshed until you click the endUpdate() button.


                                    

                                    

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.


                                    

                                    

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 options of the widget.

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

To set one or more widget options, pass the object containing these options as the options parameter.

The following code sample illustrates the example of the object to be passed as this parameter.

JavaScript
var newOptionsObject = {
    behavior: {
        allowSlidersSwap: this.checked
    },
    scale: {
        showMinorTicks: this.checked
    }
}

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.


                                    

                                    

setSelectedRange(selectedRange)

Sets a specified range.

Parameters:
selectedRange: Object
An object representing the start and end values of the selected range to be set.

To set the 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.