JavaScript/jQuery RangeSlider Options
An object defining configuration options for the RangeSlider widget.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
Specifies the shortcut key that sets focus on the widget.
The value of this option will be passed to the accesskey
attribute of the HTML element that underlies the widget.
activeStateEnabled
Specifies whether or not the widget changes its state when interacting with a user.
This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#rangeSliderContainer").dxRangeSlider({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-range-slider ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-range-slider>
import { DxRangeSliderModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxRangeSliderModule ], // ... })
Vue
<template> <DxRangeSlider ... :element-attr="rangeSliderAttributes"> </DxRangeSlider> </template> <script> import DxRangeSlider from 'devextreme-vue/range-slider'; export default { components: { DxRangeSlider }, data() { return { rangeSliderAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import RangeSlider from 'devextreme-react/range-slider'; class App extends React.Component { rangeSliderAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <RangeSlider ... elementAttr={this.rangeSliderAttributes}> </RangeSlider> ); } } export default App;
end
The right edge of the interval currently selected using the range slider.
endName
The value to be assigned to the name attribute of the underlying <input>
element.
Specify this and startName options if the widget lies within an HTML form that will be submitted.
If you configure the widget as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.
@(Html.DevExtreme().RangeSlider() .StartName("StartModelProperty") .EndName("EndModelProperty") )
@(Html.DevExtreme().RangeSlider() _ .StartName("StartModelProperty") _ .EndName("EndModelProperty") )
focusStateEnabled
Specifies whether the widget can be focused using keyboard navigation.
height
Specifies the widget's height.
This option accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hint
Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled
Specifies whether the widget changes its state when a user pauses on it.
isValid
Specifies or indicates whether the editor's value is valid.
See Also
keyStep
Specifies the step by which a handle moves when a user presses Page Up or Page Down.
onContentReady
A function that is executed when the widget's content is ready and each time the content is changed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the widget is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onInitialized
A function used in JavaScript frameworks to save the widget instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
A function that is executed after a widget option is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified option that includes all parent options. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
value | any |
The modified option's new value. |
onValueChanged
A function that is executed after the widget's value is changed.
Information about the event.
Name | Type | Description |
---|---|---|
value |
The start and end values. |
|
start |
The left edge of the currently selected range. |
|
model |
Model data. Available only if you use Knockout. |
|
end |
The right edge of the currently selected range. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
rtlEnabled
Switches the widget to a right-to-left representation.
When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
start
The left edge of the interval currently selected using the range slider.
startName
The value to be assigned to the name attribute of the underlying <input>
element.
Specify this and endName options if the widget lies within an HTML form that will be submitted.
If you configure the widget as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.
@(Html.DevExtreme().RangeSlider() .StartName("StartModelProperty") .EndName("EndModelProperty") )
@(Html.DevExtreme().RangeSlider() _ .StartName("StartModelProperty") _ .EndName("EndModelProperty") )
step
Specifies the step by which the widget's value changes when a user drags a handler.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this option will be passed to the tabindex
attribute of the HTML element that underlies the widget.
validationError
Information on the broken validation rule. Contains the first item from the validationErrors array.
See Also
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
The following option values are possible:
- auto
The tooltip with the message is displayed when the editor is in focus. - always
The tooltip with the message is not hidden when the editor loses focus.
Use the ValidationMessageMode
enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto
and Always
.
validationStatus
Indicates or specifies the current validation status.
The following table illustrates the validation status indicators:
validationStatus | Indicator |
---|---|
"pending" |
![]() |
"valid" |
![]() |
"invalid" |
![]() |
width
Specifies the widget's width.
This option accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }