Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: RendererSlider

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

NameSummary
new RendererSlider(params, srcNodeRef)Creates a new RendererSlider widget.

CSS

esri/dijit/RendererSlider | Download source

NameDescription
NumberTextBoxContainerNone
bottomLabelNodeNone
esriRendererSliderNone
handlerNone
handlerLabelNone
handlerTickNone
handlerTickBottomNone
handlerTickTopNone
moveableNone
sliderAreaNone
sliderAreaRightNone
sliderNodeNone
topLabelNodeNone

Properties

NameTypeSummary
maxLabelStringTop label for the slider.
maximumNumberAbsolute maximum value allowed by the slider.
minLabelStringBottom label for the slider.
minimumNumberAbsolute minimum value allowed by the slider.
precisionNumberAccuracy of the data (related to rounding).
showHandlesBooleanToggle for showing the black handle bars.
showLabelsBoolean | String[]Flexible toggle for showing labels e.g.
showTicksBooleanToggle for showing the horizontal line indicators from the center of the handle.
valuesNumber[]Required: Handle positions represented as numbers that fall between minimum and maximum.

Methods

NameReturn typeSummary
startup()NoneFinalizes 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

NameEvent ObjectSummary
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

new RendererSlider(params, srcNodeRef)

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 (e.g. ["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

<String> maxLabel

Top label for the slider.
Default value: null

<Number> maximum

Absolute maximum value allowed by the slider.
Default value: 100

<String> minLabel

Bottom label for the slider.
Default value: null

<Number> minimum

Absolute minimum value allowed by the slider.
Default value: 0

<Number> precision

Accuracy of the data (related to rounding).
Default value: 2

<Boolean> showHandles

Toggle for showing the black handle bars.
Known values: true | false
Default value: true

<Boolean | String[]> showLabels

Flexible toggle for showing labels e.g. ["data","handle"].
Known values: true | false
Default value: true

<Boolean> showTicks

Toggle for showing the horizontal line indicators from the center of the handle.
Known values: true | false
Default value: true

<Number[]> values

Required: Handle positions represented as numbers that fall between minimum and maximum.
Default value: [50]
Method Details

startup()

Finalizes the creation of the widget.
Event Details
[ On Style Events | Connect Style Event ]

slide

Fires when the user actively slides the handle.
Event Object Properties:
<Number[]> values A temporary representation of the values property.

stop

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.