require(["esri/dijit/RendererSlider"], function(RendererSlider) { /* code goes here */ });
Description
(Added at v3.13)
The base slider class for all Subclass
Slider
widgets listed below.
Samples
Search for
samples that use this class.
Subclasses
Constructors
CSS
esri/dijit/RendererSlider | Download source
NumberTextBoxContainer | None |
bottomLabelNode | None |
esriRendererSlider | None |
handler | None |
handlerLabel | None |
handlerTick | None |
handlerTickBottom | None |
handlerTickTop | None |
moveable | None |
sliderArea | None |
sliderAreaRight | None |
sliderNode | None |
topLabelNode | None |
Properties
Methods
startup() | None | Finalizes the creation of the widget. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
slide | {
values: <Number[] >
} | Fires when the user actively slides the handle. |
stop | {
values: <Number[] >
} | Fires when the user lets go of the handle. |
Constructor Details
Creates a new RendererSlider
widget. See params
properties below.
Parameters:
<Object > params |
Required |
Set of parameters used to specify the RendererSlider widget options. |
<Node | String > srcNodeRef |
Required |
Reference or ID of the HTMLElement where the widget should be rendered. |
params
properties:
<Number[] > handles |
Optional |
Collection of indexes that indicates which children from the infos array to use as handles. |
<String > maxLabel |
Optional |
Top label for the slider. |
<Number > maximum |
Required |
Absolute maximum value allowed by the slider. |
<String > minLabel |
Optional |
Bottom label for the slider. |
<Number > minimum |
Required |
Absolute minimum value allowed by the slider. |
<Number > precision |
Optional |
Accuracy of the data (related to rounding). |
<Number > primaryHandle |
Optional |
Primary handle identified by its index value within the related infos array (color, size, break). |
<Boolean > showHandles |
Optional |
Toggle for showing the black handle bars. Default is true . |
<Boolean | String[] > showLabels |
Optional |
Flexible toggle for showing labels (for example ["data", "handle"]). Default value is true . |
<Boolean > showTicks |
Optional |
Toggle for showing the horizontal line indicators from the center of the handle. |
<Number[] > values |
Required |
Stores positions represented as numbers that fall between minimum and maximum. |
Sample:
require(["esri/dijit/RendererSlider", ...
], function(RendererSlider, ... ) {
var rendererSlider = new RendererSlider(params, srcNodeRef);
...
});
Property Details
Top label for the slider.
Default value: null
Absolute maximum
value allowed by the slider.
Default value: 100
Bottom label for the slider.
Default value: null
Absolute minimum
value allowed by the slider.
Default value: 0
Accuracy of the data (related to rounding).
Default value: 2
Toggle for showing the black handle bars.
Known values: true | false
Default value: true
Flexible toggle for showing labels, for example ["data","handle"]
.
Known values: true | false
Default value: true
Toggle for showing the horizontal line indicators from the center of the handle.
Known values: true | false
Default value: true
Required: Handle positions represented as numbers that fall between minimum
and maximum
.
Default value: [50]
Method Details
Finalizes the creation of the widget.
Event Details
[ On Style Events | Connect Style Event ]
Fires when the user actively slides the handle.
Fires when the user lets go of the handle. Returns an array of handle positions.
Event Object Properties:
<Number[] > values |
An array of handle positions represented as numbers that fall between minimum and maximum. |