Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/opsdashboard
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ColorInfoSlider
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/ColorInfoSlider"], function(ColorInfoSlider) { /* code goes here */ });
Description
(Added at v3.13)
A widget to assist with managing a renderer for visualizing features based upon colors.Samples
Search for samples that use this class.Class hierarchy
esri/dijit/RendererSlider |_esri/dijit/ColorInfoSlider
Constructors
| Name | Summary |
|---|---|
| new ColorInfoSlider(params, srcNodeRef) | Creates a new ColorInfoSlider widget within the provided DOM node srcNodeRef. |
CSS
esri/dijit/ColorInfoSlider | 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 |
|---|---|---|
| colorInfo | Object | Required: The data map containing renderer information. |
| handles | Number[] | Required: Handles identified by their index values within the stops array. |
| histogram | Object | Optional: Represents the histogram data object. |
| histogramWidth | Number | Optional: Width of histogram in pixels. |
| maxValue | Number | Optional: The absolute maximum value of the slider. |
| minValue | Number | Optional: The absolute minimum value of the slider. |
| primaryHandle | Number | Optional: The handle identified by its index value within the stops array. |
| rampWidth | Number | Optional: Width of the widget ramp in pixels. |
| showHandles | Boolean | Optional: Indicates whether to display handles. |
| showHistogram | Boolean | Optional: Indicates whether to display the histogram. |
| showLabels | Boolean | Optional: Indicates whether to display handles. |
| showRatioLabels | Boolean | String | Indicates whether to display percentage labels. |
| showTicks | Boolean | Optional: Indicates whether to display ticks marks. |
| showTransparentBackground | Boolean | Optional: Indicates whether to display a transparent background. |
| statistics | Object | Optional: Represents a statistics data object. |
| values | Number[] | Required: Handle positions represented as numbers that fall between minimum and maximum. |
| zoomOptions | Object | Optional: Additional options to customize slider. |
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 |
|---|---|---|
| data-change | {
colorInfo: < | Fires during slide and slide stop, and when a handle or the minValue or maxValue of the ColorInfoSlider are updated via text box. |
| data-value-change | {
colorInfo: < | Fires when minValue or maxValue of the ColorInfoSlider are updated via text box. |
| handle-value-change | {
colorInfo: < | Fires on slide stop and when a handle is updated via textbox. |
| zoomed | {
zoomed: < | Fires when the zoom state changes. |
Constructor Details
Creates a new
ColorInfoSlider widget within the provided DOM node srcNodeRef.Parameters:
< |
Required | Set of parameters used to specify the ColorInfoSlider widget options. |
< |
Required | Reference or ID of the HTMLElement where the widget should be rendered. |
params properties: < |
Required | The data map containing renderer information. See Renderer.colorInfo for additional information. |
< |
Required | Handles identified by their index values within the stops array. |
< |
Optional | Optional: Represents the histogram data object. Access this from the FeatureLayerStatistics.getHistogram response. See the object specifications table below for the structure of the returned histogram object. |
< |
Optional | Width of histogram in pixels. Default value is 100. |
< |
Optional | The absolute maximum value of the slider. NOTE: This value overrides the statistics max property. |
< |
Optional | The absolute minimum value of the slider. NOTE: This value overrides the statistics min property. |
< |
Optional | The handle identified by its index value within the stops array. This value must also be in handles array. |
< |
Optional | Width of widget ramp in pixels. Default value is 26. |
< |
Optional | Displays handles when set to true. Default is true. |
< |
Optional | Displays the histogram when true. |
< |
Optional | Displays labels when set to true. Default is true. |
< |
Optional | Indicates whether to display percentage labels. This can be either null|false, "percent", or "percentTotal". |
< |
Optional | Displays tick marks when set to true. Default is true. |
< |
Optional | Displays transparent background when set to true. Default is false. |
< |
Optional | Represents a statistics data object. Access this from the FeatureLayerStatistics.getFieldStatistics response. |
< |
Optional | Additional options to customize slider. For example, if the slider has a range between 0 and 100 with two handles at 10 and 20, it is possible to pass in zoomOptions with 0 and 30 for the minSliderValue and maxSliderValue. The slider would be cut off at the top and zoomed to a ramp that can move from 0 through 30.
See the zoomOptions table below for additional information. |
Sample:
require("esri/dijit/ColorInfoSlider", function (ColorInfoSlider) {
// --------------------------------------------------------------------
// Create the ColorInfoSlider widget and initialize. Pass in an initial stops parameter.
// --------------------------------------------------------------------
var colorInfoSlider = new ColorInfoSlider({
colorInfo: {
stops:[
{color: new Color([92,92,92]), label: "50", value: 50},
{color: new Color([92,92,92]), label: "51", value: 51}
]
}
}, "esri-colorinfoslider");
colorInfoSlider.startup();
}
Property Details
<Object
ObjectRequired: The data map containing renderer information. See
Renderer.colorInfo for additional information.Default value:
null<Number[]
Number[]Required: Handles identified by their index values within the
stops array.Default value:
[]<Object
ObjectOptional: Represents the
histogram data object. Access this from the FeatureLayerStatistics.getHistogram response. See the object specifications table below for the structure of the returned histogram object.Default value:
nullObject Specifications:
<
histogram>< |
Required | An array of objects indicating bins in the histogram. It contains the number of features that fall into each of the disjoint categories in the histogram.
The object includes the following properties:
|
< |
Required | Maximum value captured by the histogram. This is optional if statistics are passed in. |
< |
Required | Minimum value captured by the histogram. This is optional if statistics are passed in. |
< |
Optional | Sum of all data values used to normalize data. Available only when normalizationType is percent-of-total. |
<Number
NumberOptional: The absolute maximum value of the slider. NOTE: This value overrides the statistics
max property.Default value:
100<Number
NumberOptional: The absolute minimum value of the slider. NOTE: This value overrides the statistics
min property.Default value:
0<Number
NumberOptional: The handle identified by its index value within the
stops array. This value must also be in handles array.Default value:
null<Boolean
BooleanOptional: Indicates whether to display handles.
Known values:
true | falseDefault value:
true<Boolean
BooleanOptional: Indicates whether to display the
histogram.Known values:
true | falseDefault value:
true<Boolean
BooleanOptional: Indicates whether to display handles.
Known values:
true | falseDefault value:
trueIndicates whether to display percentage labels. This can be either
null|false, "percent", or "percentTotal".
-
Percentuses a formula to calculate the percentage values from the data values. This results in 50%, 100%, 200%.val * 100 = percentVal
PercentTotaluses a formula to calculate the percentage values from the data values. This results in 33%, 50%, 66%. Because the value are always between 0 and 100%, this should indicate the extreme min/max values on the slider.(val / (1 + val) ) * 100 = percentVal
Default value:
falseSample:
slider = new ColorInfoSlider({
"showRatioLabels": "percent",
"colorInfo": {
"stops": [
{value: 0.5, color: "#FFEE99", label: "< .5"},
{value: 1, color: "#999166", label: "1"},
{value: 2, color: "#333333", label: "> 2"}]},
handles:[0,1,2],
statistics:{
avg: 1.16667,
count: 3,
max: 2,
min: 0.5
}
}, "sliderDiv");
slider.startup();
<Boolean
BooleanOptional: Indicates whether to display ticks marks.
Known values:
true | falseDefault value:
true<Boolean
BooleanOptional: Indicates whether to display a transparent background.
Known values:
true | falseDefault value:
false<Object
ObjectOptional: Represents a
statistics data object. Access this from the FeatureLayerStatistics.getFieldStatistics response. Default value:
null<Number[]
Number[]Required: Handle positions represented as numbers that fall between
minimum and maximum.Default value:
[50]<Object
ObjectOptional: Additional options to customize slider. For example, if the slider has a range between 0 and 100 with two handles at 10 and 20, it is possible to pass in
zoomOptions with 0 and 30 for the minSliderValue and maxSliderValue. The slider would be cut off at the top and zoomed to a ramp that can move from 0 through 30.
See the zoomOptions table below for additional information.Default value:
nullMethod Details
Event Details
[ On Style Events | Connect Style Event ]
Fires on slide stop and when a handle is updated via textbox.
Fires when the zoom state changes. (Added at v3.15)
Event Object Properties:
< |
Indicates whether the slider is currently in a zoomed state. |