JavaScript/jQuery RangeSelector Methods
This section describes the methods that can be used in code to manipulate objects related to the RangeSelector.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
dispose()
Disposes of all the resources allocated to the RangeSelector instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myRangeSelector").dxRangeSelector("dispose");
$("#myRangeSelector").remove();Angular
Use conditional rendering instead of this method:
<dx-range-selector ...
*ngIf="condition">
</dx-range-selector>Vue
Use conditional rendering instead of this method:
<template>
<DxRangeSelector ...
v-if="condition">
</DxRangeSelector>
</template>
<script>
import DxRangeSelector from 'devextreme-vue/range-selector';
export default {
components: {
DxRangeSelector
}
}
</script>React
Use conditional rendering instead of this method:
import React from 'react';
import RangeSelector from 'devextreme-react/range-selector';
function DxRangeSelector(props) {
if (!props.shouldRender) {
return null;
}
return (
<RangeSelector ... >
</RangeSelector>
);
}
class App extends React.Component {
render() {
return (
<DxRangeSelector shouldRender="condition" />
);
}
}
export default App;element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the RangeSelector instance found in an element with the myRangeSelector ID:
// Modular approach
import RangeSelector from "devextreme/viz/range_selector";
...
let element = document.getElementById("myRangeSelector");
let instance = RangeSelector.getInstance(element) as RangeSelector;
// Non-modular approach
let element = document.getElementById("myRangeSelector");
let instance = DevExpress.viz.dxRangeSelector.getInstance(element);See Also
getSize()
Gets the current UI component size.
Size
The current UI component size.
Returns an object with the following fields.
- width
The width of the UI component in pixels. - height
The height of the UI component in pixels.
See Also
hideLoadingIndicator()
Hides the loading indicator.
Although the loading indicator hides automatically once the UI component is ready, you can hide it from code at the required moment using this method.
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
render()
Redraws the UI component.
Normally, the UI component redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the UI component's container is resized. For this purpose, call the render() method.
See Also
render(skipChartAnimation)
Redraws the UI component.
Specifies whether to animate the background chart 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 animate the chart on redraw. Otherwise, pass true or call the render method without parameters.
See Also
resetOption(optionName)
Resets a property to its default value.
A property's name.