JavaScript/jQuery RangeSelector API

The RangeSelector is a widget that allows a user to select a range of values on a scale.

import RangeSelector from "devextreme/viz/range_selector"

This widget represents a scale (numeric or date-time) and two sliders. A user selects the required range by moving the sliders.

RangeSelector

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the RangeSelector widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function() {
    $("#rangeSelector").dxRangeSelector({
        scale: {
            startValue: new Date(2011, 0, 1),
            endValue: new Date(2011, 5, 1),
            tickInterval: { days: 7 }
        }
    });
});

<div id="rangeSelector"></div>

Angular

HTML

TypeScript

<dx-range-selector>
    <dxo-scale
        [startValue]="startDate"
        [endValue]="endDate">
        <dxo-tick-interval [days]="7"></dxo-tick-interval>
    </dxo-scale>
</dx-range-selector>

import { DxRangeSelectorModule } from 'devextreme-angular';
// ...
export class AppComponent {
    startDate = new Date(2011, 0, 1);
    endDate = new Date(2011, 5, 1);
}
@NgModule({
    imports: [
        // ...
        DxRangeSelectorModule
    ],
    // ...
})

AngularJS

HTML

JavaScript

<div ng-controller="DemoController">
    <div dx-range-selector="{
        scale: {
            startValue: startDate,
            endValue: endDate,
            tickInterval: { days: 7 }
        }
    }"></div>
</div>

angular.module('DemoApp', ['dx'])
    .controller("DemoController", function ($scope) {
        $scope.startDate = new Date(2011, 0, 1);
        $scope.endDate = new Date(2011, 5, 1);
    });

Knockout

HTML

<div data-bind="dxRangeSelector: {
    scale: {
        startValue: new Date(2011, 0, 1),
        endValue: new Date(2011, 5, 1),
        tickInterval: { days: 7 }
    }
}"></div>

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().RangeSelector()
    .ID("rangeSelector")
    .Scale(scale => scale
        .StartValue(new DateTime(2011, 1, 1))
        .EndValue(new DateTime(2011, 6, 1))
        .TickInterval(ti => ti.Days(7))
    )
)

@(Html.DevExtreme().RangeSelector() _
    .ID("rangeSelector") _
    .Scale(Sub(scale)
        scale.StartValue(New DateTime(2011, 1, 1)) _
                .EndValue(New DateTime(2011, 6, 1)) _
                .TickInterval(Sub(ti) ti.Days(7))
    End Sub)
)

A chart can be displayed in the background of the RangeSelector widget. This allows end users to select the required range in a chart series. You can also integrate the RangeSelector widget with a stand-alone Chart widget to emulate chart zooming and scrolling.

View Demo Watch Video

Configuration

An object that defines configuration options for the RangeSelector widget.

Name	Description
background	Specifies the options for the range selector's background.
behavior	Specifies the RangeSelector's behavior options.
chart	Specifies the options required to display a chart as the range selector's background.
containerBackgroundColor	Specifies the color of the parent page element.
dataSource	Specifies a data source for the scale values and for the chart at the background.
dataSourceField	Specifies the data source field that provides data for the scale.
elementAttr	Specifies the attributes to be attached to the widget's root element.
export	Configures the exporting and printing features.
indent	Range selector's indent options.
loadingIndicator	Configures the loading indicator.
margin	Generates space around the widget.
onDisposing	A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
onDrawn	A function that is executed when the widget's rendering has finished.
onExported	A handler for the exported event. Executed after data from the widget is exported.
onExporting	A handler for the exporting event. Executed before data from the widget is exported.
onFileSaving	A handler for the fileSaving event. Executed before a file with exported data is saved on the user's local storage.
onIncidentOccurred	A handler for the incidentOccurred event. Executed when an error or warning appears in the widget.
onInitialized	A handler for the initialized event. Executed only once, after the widget is initialized.
onOptionChanged	A handler for the optionChanged event. Executed after an option of the widget is changed.
onValueChanged	A handler for the valueChanged event.
pathModified	Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.
redrawOnResize	Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
rtlEnabled	Switches the widget to a right-to-left representation.
scale	Specifies options of the range selector's scale.
selectedRangeColor	Specifies the color of the selected range.
shutter	Specifies range selector shutter options.
size	Specifies the widget's size in pixels.
sliderHandle	Specifies the appearance of the range selector's slider handles.
sliderMarker	Defines the options of the range selector slider markers.
theme	Sets the name of the theme the widget uses.
title	Configures the widget's title.
value	The selected range, initial or current.

Methods

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

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
dispose()	Disposes of all the resources allocated to the RangeSelector instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
exportTo(fileName, format)	Exports the widget.
getDataSource()	Gets the DataSource instance.
getInstance(element)	Gets the instance of a widget found using its DOM node.
getSize()	Gets the current widget size.
getValue()	Gets the currently selected range.
hideLoadingIndicator()	Hides the loading indicator.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
print()	Opens the browser's print window.
render()	Redraws the widget.
render(skipChartAnimation)	Redraws the widget.
setValue(value)	Sets the selected range.
showLoadingIndicator()	Shows the loading indicator.
svg()	Gets the widget's SVG markup.

Events

This section describes events fired by this widget.

Name	Description
disposing	Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
drawn	Raised when the widget's rendering has finished.
exported	Raised after data from the widget is exported.
exporting	Raised before data from the widget is exported.
fileSaving	Raised before a file with exported data is saved on the user's local storage.
incidentOccurred	Raised when an error or warning appears in the widget.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.
valueChanged	Fires when the selected range is changed.

JavaScript/jQuery RangeSelector API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Configuration

Methods

Events

See Also