// Typical usage
var slider = new ColorSlider({
  statistics: stats,  // object generated from summaryStatistics()
  visualVariable: colorVV,  // color visual variable generated from a colorRendererCreator method
}, "sliderDiv");

Property Overview

Property Details

containerString|HTMLElement

The ID or node representing the DOM element containing the widget.

Note that once set, this property cannot be modified afterwards.

declaredClassStringreadonly

The name of the class. The declared class name is formatted as esri.folder.className.

handlesVisibleBoolean

Indicates whether to show the handles of the slider that may be dragged by the user. See the image in the class description to see where handles are typically placed.

Default Value: true

histogramHistogramResult

The histogram associated with the data represented on the slider. This may be generated using the histogram statistics function.

See also:

• histogramVisible

• histogram

Example:

histogram({
  layer: featureLayer,
  field: "fieldName"
}).then(function(histogram){
  // set the histogram to the slider
  slider.histogram = histogram;
});

histogramVisibleBoolean

Indicates whether to show the histogram in the slider UI. See the image in the class description to see where the histogram is typically placed.

Default Value: true

histogramWidthNumber

The width of the histogram in pixels.

Default Value: 100

labelsVisibleBoolean

Indicates whether to show labels in the slider UI. See the image in the class description to see where labels are typically placed.

Default Value: true

maxValueNumber

The maximum value or upper bound of the slider. This value overrides the max property of the statistics, but may not be less than the value of the maximum stop of the color visual variable.

This property may be set programmatically or by the user in the widget's UI.

Example:

slider.maxValue = 150;

minValueNumber

The minimum value or lower bound of the slider. This value overrides the min property of the statistics, but may not be greater than the value of the minimum stop of the color visual variable.

This property may be set programmatically or by the user in the widget's UI.

Example:

slider.minValue = 0.15;

numHandlesNumber

Indicates the number of handles to show on the slider. Acceptable values are 2 or 3. If 3 handles are specified, then the syncedHandles property may be enabled to sync the movement of the outside handles with the middle, or primary, handle.

Default Value: {"value":2,"set":""}

statisticsSummaryStatisticsResult

The summary statistics of the data represented in the slider. This is an object that may be generated from the summaryStatistics statistics function. The min and max values in this object determine the minValue and maxValue of the slider if values for those properties are not already provided.

Example:

colorRendererCreator.createVisualVariable({
  layer: featureLayer,
  field: "fieldName",
  basemap: map.basemap
}).then(function(response){
  // set the histogram to the slider
  slider.statistics = statistics;
});

statisticsVisibleBoolean

Indicates whether to show the average in the slider UI. See the image in the class description to see where this symbol is typically placed. Hover over this symbol to view the average in the tooltip.

Default Value: true

syncedHandlesBoolean

Only applicable when numHandles is set to 3. This property indicates whether the outside handles are synced with the middle, or primary, handle. If the primary handle is dragged then the outside handles are dragged while maintaining the same distance from the primary handle.

Default Value: false

ticksVisibleBoolean

Indicates whether to show tick marks next to the slider handles. See the image in the class description to see where ticks are typically placed.

Default Value: true

valuesObject[]readonly

Each object in this array represents a stop in the color visual variable associated with the slider. The properties of each object describe whether the stop has a slider handle, the value of the handle and its associated color.

Properties:

color Color The color used to represent features with values at the associated stop.

value Number The value of the stop for the associated handle.

label String The label used to display the value to the user.

visibleBoolean

Indicates whether the widget is visible.

Default Value: true

Example:

// Hides the widget in the view
widget.visible = false;

visualVariableColorVisualVariable

The color visual variable represented by the slider. This must be set initially on the slider for it to render in the view. This may be created manually (see snippet below) or generated from the colorRendererCreator helper methods. A new color visual variable is created each time the user slides handles or changes the minValue or the maxValue.

Example:

slider.visualVariable = {
  type: "color",
  field: "count",
  stops: [
    { value: 0, color: "#eee8d6" },
    { value: 20, color: "#bcadda" },
    { value: 40, color: "#9a85dd" },
    { value: 60, color: "#7062b9" },
    { value: 80, color: "#453e94" }
  ]
};

Method Overview

Method Details

destroy()

Destroys the widget instance. Call this method when the widget is no longer needed by the application.

Example:

widget.destroy();

Event Overview

Event Details

data-change

Fires on each handle value change (on slide) and change to the minValue or maxValue of the slider.

Example:

slider.on("data-change", function(){
  var renderer = layer.renderer.clone();
  renderer.visualVariables = [ slider.visualVariable ];
  layer.renderer = renderer;
});

data-value-change

Fires on each change to the minValue or maxValue of the slider. This event is useful for updating the Legend when the upper and lower bounds of the stops are altered.

Example:

slider.on("data-value-change", function(){
  // execute your code here
});

handle-value-change

Fires when a handle value changes either by typing a new value or on slide end.

See also:

• Sample: Generate a continuous color visualization

Example:

slider.on("handle-value-change", function(){
  // set the new visual variable on the renderer for immediate feedback
  var renderer = layer.renderer.clone();
  renderer.visualVariables = [ slider.visualVariable ];
  layer.renderer = renderer;
});