An object that defines configuration options for the dxRangeSelector widget.
This example shows how to display the dxRangeSelector widget. The only option which is specifically set is the dataSource. The other option - the dataSourceField - thought required, does not have to be specified because it is set to 'arg' (a required data source field) by default.
Specifies the options for the range selector's background.
A background is an area that is painted in a specified color. You can change this color by setting the background's color property and/or by displaying an image specified by the image configuration object. In addition, you can superimpose a chart on a background by specifying the chart configuration object. The chart will be shown with the specified background color. To show the chart without a background, set the background's visible property to false.
Specifies the dxRangeSelector's behavior options.
In this example, a number of options belonging to the behavior configuration object are changed. Particularly, the snapToTicks option is set to 'false', so the dxRangeSelector's sliders do not dock to the scale ticks. These sliders cannot swap their places as the allowSlidersSwap option is also set to 'false'. In addition, widget animation is disabled by setting the animationEnabled option to 'false'.
Specifies the options required to display a chart as the range selector's background.
The dxRangeSelector widget can be created with a chart as the background. In this instance, the range selector can be used for selecting the required range on the chart. At the same time, the dxChart widget can be displayed near the range selector and zoomed or scrolled according to the range selected in the range selector. For details on how to synchronize these two widgets, refer to the Scrolling and Zooming topics.
To provide a data source for the chart located in the background, set the dataSource property of the rangeSelectorOptions root configuration object and define the series within the chart configuration object. Set the chart series' argumentField and valueField properties to the corresponding data source fields. The argument field will also be used to create the range selector's scale.
NOTE: You may need to use the rangeValue1Field and rangeValue2Field properties instead of the valueField property if you define range-like series. For the candleStick and stock series types, specific properties should also be specified instead of the valueField property.
The color specified for the range selector's background will also be visible in the chart's background by default. You can change it using the color property of the background configuration object. To prohibit the display of the background color, set the background's visible property to false.
Specifies the color of the parent page element.
Set this property to the color of the parent page element. Certain dxRangeSelector elements will use this color so that they coordinate with the page. For instance, the dxRangeSelector's shutters use this color, but you can change this color to a custom color.
Specifies a data source for the scale values and for the chart at the background.
Use this property in the following cases:
- to initialize a scale with data from one of the data source fields. Set the dataSourceField property to specify which field to use as the source for scale values.
- to plot a chart using data from the data source fields. In this case, define the chart series by setting their argumentField and valueField properties. The range selector's scale will represent the chart's argument axis. It is created using data from the field specified by the chart's argumentField property.
The maximum and minimum values of the field specified by the argumentField/dataSourceField property are used as the scale's start and end values. The major tick interval is determined automatically. You can also set the interval using the scale's majorTickInterval and minorTickInterval properties.
Specifies the data source field that provides start and end values for the scale.
Use this property to initialize a scale with data from one of the data source's fields. Set the name of the required data source field to this property.
Specifies a callback function that is called when the widget has finished drawing itself.
The instance of the drawn widget.
If you need to perform specific actions when the widget has finished drawing itself, assign a callback function to the drawn option. When implementing this function, you can access the instance of the currently drawn widget using the function's parameter or the this object.
Specifies a callback function that is called when an error or warning appears.
Contains information about the occurred incident.
When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the incidentOccured option. Within this function, you can use various information about the incident that occurred. This information can be accessed from the fields of the object passed to the callback function as a parameter. These fields are as follows.
Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
Contains the name of the widget that produced the error or warning.
Contains the currently used version of the ChartJS library.
Specifies the appearance of the loading indicator.
Usually, the widget is quick enough to draw itself instantly for a viewer. There are, however, cases, when the widget takes longer to be drawn. In such cases, displaying the loading indicator is recommended. Use the widget's showLoadingIndicator() and hideLoadingIndicator() methods to manage the loading indicator. To specify its appearance, use the loadingIndicator configuration object.
In this example, the chart options are assigned 3000 ms after the example is loaded. Until such a time, the loading indicator is displayed. Its background and font are changed using the backgroundColor and font options respectively. Make a note that these options should be specified at design-time so that the changes are applied at the right time.
Specifies the blank space in pixels between the dxRangeSelector widget's extreme elements and the boundaries of the area provided for the widget (see size).
Set the required values for the left, right, top and bottom margins using the margin object's corresponding properties.
Notifies a widget that it is embedded into an HTML page that uses a path modifier.
Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
When this option is set to true, the widget will be redrawn automatically in case the size of its parent window changes.
NOTE: To redraw the widget after the size of its container has changed, call the render() method of the widget instance.
Specifies whether or not the widget supports right-to-left representation.
The most common scenario is switching all the widgets to a right-to-left reading order. In this instance, set the DevExpress.rtlEnabled field to true. If you need to switch the reading order in a particular widget, use the rtlEnabled configuration option of this widget.
Specifies options of the range selector's scale.
To divide a scale, either set the dataSource property or the startValue and endValue properties. In the former case, the start and end values will be calculated based on the values provided by the data source field that is set by the dataSourceField property.
The scale's ticks are arranged automatically, based on the start and end values, so that the tick labels do not overlap each other. You can set a custom tick interval, add minor ticks and format tick labels. These and other scale options are available in the scale configuration object.
Specifies the range to be selected when displaying the dxRangeSelector.
The selected range is the entire scale by default. To set the required range to be selected after the dxRangeSelector widget is displayed on a page, set the startValue and endValue properties for the selectedRange configuration object.
You can write a callback function to react to a change in the selected range. Assign this function to the selectedRangeChanged option.
A callback function that is called when the selected range is changed.
The dxRangeSelector widget allows you to specify a callback function that will be called when the selected range is changed. When implementing this function, use the following properties of its parameter.
This function can be called when moving a slider or after the movement of the slider has stopped. To specify the required mode, use the callSelectedRangeChanged property of the behavior configuration object.
To see an example of an implementation of this function, refer to the Zooming topic.
Specifies the options of the range selector's shutters.
Shutters are used in the dxRangeSelector widget to highlight the selected range. When using shutters, the background area for a selected range is clearly visible, and the remaining area is hidden by the shutters.
Specifies in pixels the size of the dxRangeSelector widget.
The dxRangeSelector widget occupies all the area of the parent container (division). If the container size (width or height) is set to zero, the range selector is not displayed.
If you need to set a particular size (different from the container's size) for the dxRangeSelector widget, use the size configuration object. Assign the height and width in pixels to the height and width properties.
Specifies the appearance of the range selector's slider handles.
The range selector's sliders consist of a slider marker and a slider handle. You can drag a marker or a handle to change the selected range. To set the appearance options of the slider handles, use the sliderHandle configuration object. To customize the slider markers, use the sliderMarker configuration object.
Defines the options of the range selector slider markers.
When moving a slider, its marker displays the currently selected scale value. Use the sliderMarker object to set the required options for the range selector slider markers. For instance, you can format the markers' text, change the text font, or make the markers invisible.
Sets the name of the theme to be used by the range selector.
Use this property to set a predefined or custom theme. The options defining the range selector appearance will be set to the values of the specified theme. You can override some of these values within the rangeSelectorOptions configuration object. To learn more about themes and theme implementation and customization, refer to the Themes topic.