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: OpacitySlider
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/OpacitySlider"], function(OpacitySlider) { /* code goes here */ });
Description
(Added at v3.13)
A widget to assist with managing opacity with a renderer.Samples
Search for samples that use this class.Class hierarchy
esri/dijit/RendererSlider |_esri/dijit/OpacitySlider
Constructors
| Name | Summary |
|---|---|
| new OpacitySlider(params, srcNodeRef) | Creates a new OpacitySlider widget within the provided DOM node srcNodeRef. |
CSS
esri/dijit/OpacitySlider | 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 |
|---|---|---|
| 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. |
| opacityInfo | Object | Required: The data map containing renderer information. |
| primaryHandle | Number | Optional: The handle identified by its index value within the stops array. |
| rampWidth | Number | Optional: Represents the width of the SVG ramp in pixels. |
| showHandles | Boolean | Optional: Indicates whether to display slider handles. |
| showHistogram | Boolean | Optional: Indicates whether to display the histogram. |
| showLabels | Boolean | Optional: Indicates whether to display slider labels. |
| showTicks | Boolean | Optional: Indicates whether to display slider tick marks. |
| showTransparentBackground | Boolean | Optional: Indicates whether to display the 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-value-change | {
maxValue: < | Fires when minValue or maxValue of the OpacitySlider changes. |
| handle-value-change | {
opacityInfo: < | 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
OpacitySlider widget within the provided DOM node srcNodeRef.Parameters:
< |
Required | Set of parameters used to specify the OpacitySlider widget options. |
< |
Required | Reference or ID of the HTMLElement where the widget should be rendered. |
params properties: < |
Required | Handles identified by their index values within the stops array. |
< |
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. Default value is 100. |
< |
Optional | The absolute minimum value of the slider. NOTE: This value overrides the statistics min property. Default value is 0. |
< |
Required | The data map containing renderer information. See Renderer.opacityInfo for additional information. |
< |
Optional | The handle identified by its index value within the stops array. This value must also be in handles array. |
< |
Optional | Represents the width of the SVG ramp in pixels. Default is 26. |
< |
Optional | Displays slider handles when true. Default value is true. |
< |
Optional | Displays the histogram when true. Default value is true. |
< |
Optional | Displays slider labels when true. Default value is true. |
< |
Optional | Displays slider ticks when true. Default is true. |
< |
Optional | Displays the transparent background when true. Default is true. |
< |
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. Default is null.
See the zoomOptions table below for additional information. |
Sample:
require(["esri/dijit/OpacitySlider"], function (OpacitySlider) {
var oInfo = {
"field": "C_Seq",
"stops": [
{"value": 10, "opacity": .2},
{"value": 164,"opacity": .9}
]
};
var opacitySlider = new OpacitySlider({
opacityInfo: oInfo,
statistics:{min: 0, max: 200},
showLabels : true,
showTicks: true,
}, "opacitySliderDiv");
opacitySlider.startup();
}
Property Details
<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<Object
ObjectRequired: The data map containing renderer information. See
Renderer.opacityInfo for additional information.Default value:
null<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 slider 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 slider labels.
Known values:
true | falseDefault value:
true<Boolean
BooleanOptional: Indicates whether to display slider tick marks.
Known values:
true | falseDefault value:
true<Boolean
BooleanOptional: Indicates whether to display the 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 ]
Event Object Properties:
< |
Maximum value of the slider. |
< |
Minimum value of the slider. |
< |
The opacityInfo of the OpacitySlider object. |
Fires on slide stop and when a handle is updated via textbox.
Event Object Properties:
< |
The opacityInfo of the OpacitySlider object. |
Fires when the zoom state changes. (Added at v3.15)
Event Object Properties:
< |
Indicates whether the slider is currently in a zoomed state. |