Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: RendererSlider
[ AMD Module Require | Legacy Module Require ]
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
ClassedColorSlider, ClassedSizeSlider, ColorInfoSlider, HeatmapSlider, OpacitySlider, SizeInfoSlider
Constructors
| Name | Summary |
|---|---|
| new RendererSlider(params, srcNodeRef) | Creates a new RendererSlider widget. |
CSS
esri/dijit/RendererSlider | Download source
| Name | Description |
|---|---|
| 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
| Name | Type | Summary |
|---|---|---|
| maxLabel | String | Top label for the slider. |
| maximum | Number | Absolute maximum value allowed by the slider. |
| minLabel | String | Bottom label for the slider. |
| minimum | Number | Absolute minimum value allowed by the slider. |
| precision | Number | Accuracy of the data (related to rounding). |
| showHandles | Boolean | Toggle for showing the black handle bars. |
| showLabels | Boolean | String[] | Flexible toggle for showing labels, for example ["data","handle"]. |
| showTicks | Boolean | Toggle for showing the horizontal line indicators from the center of the handle. |
| values | Number[] | Required: Handle positions represented as numbers that fall between minimum and maximum. |
Methods
| Name | Return type | Summary |
|---|---|---|
| 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
| Name | Event Object | Summary |
|---|---|---|
| slide | {
values: < | Fires when the user actively slides the handle. |
| stop | {
values: < | Fires when the user lets go of the handle. |
Constructor Details
Creates a new
RendererSlider widget. See params properties below.Parameters:
< |
Required | Set of parameters used to specify the RendererSlider widget options. |
< |
Required | Reference or ID of the HTMLElement where the widget should be rendered. |
params properties: < |
Optional | Collection of indexes that indicates which children from the infos array to use as handles. |
< |
Optional | Top label for the slider. |
< |
Required | Absolute maximum value allowed by the slider. |
< |
Optional | Bottom label for the slider. |
< |
Required | Absolute minimum value allowed by the slider. |
< |
Optional | Accuracy of the data (related to rounding). |
< |
Optional | Primary handle identified by its index value within the related infos array (color, size, break). |
< |
Optional | Toggle for showing the black handle bars. Default is true. |
< |
Optional | Flexible toggle for showing labels (for example ["data", "handle"]). Default value is true. |
< |
Optional | Toggle for showing the horizontal line indicators from the center of the handle. |
< |
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
<Boolean
BooleanToggle for showing the black handle bars.
Known values:
true | falseDefault value:
trueFlexible toggle for showing labels, for example
["data","handle"].Known values:
true | falseDefault value:
true<Boolean
BooleanToggle for showing the horizontal line indicators from the center of the handle.
Known values:
true | falseDefault value:
true<Number[]
Number[]Required: Handle positions represented as numbers that fall between
minimum and maximum.Default value:
[50]Method Details
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:
< |
An array of handle positions represented as numbers that fall between minimum and maximum. |