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: VisibleScaleRangeSlider
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/VisibleScaleRangeSlider"], function(VisibleScaleRangeSlider) { /* code goes here */ });
Description
(Added at v3.13)
A widget that sets the displayed visible scale values.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new VisibleScaleRangeSlider(params, srcNodeRef) | Creates a new VisibleScaleRangeSlider widget. |
CSS
esri/dijit/VisibleScaleRangeSlider | Download source
Properties
| Name | Type | Summary |
|---|---|---|
| layer | Layer | Setting the layer will update the suggested scale range, minScale and maxScale. |
| map | Map | Setting this property will update the slider's minimum/maximum values and current scale indicator. |
| maxScale | Number | The current maxScale value. |
| maximum | Number | Read-only: The maxScale bound in the slider range. |
| minScale | Number | The current minScale value. |
| minimum | Number | Read-only: The minScale bound in the slider range. |
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 |
|---|---|---|
| scale-range-change | {
maxScale: < | Dispatched whenever minScale or maxScale changes. |
Constructor Details
Creates a new
VisibleScaleRangeSlider widget.Parameters:
< |
Required | Set of parameters used to specify the VisibleScaleRangeSlider widget options. |
< |
Required | Reference or ID of the HTMLElement where the widget should be rendered. |
params properties: < |
Optional | Layer used to determine the suggested scale range and set the minScale, maxScale values. The layer is used to set the min/max scale values. |
< |
Required | Reference to the map. Needed to show the current scale and to set the slider's minimum/maximum. |
< |
Optional | Region of preview scale thumbnails. Default is 'en-US'. |
Sample:
require(["esri/dijit/VisibleScaleRangeSlider", ...
], function(VisibleScaleRangeSlider, ... ) {
var visibleScaleRangeSlider = new VisibleScaleRangeSlider({
map: map, //required reference to the map
layer: newLayer //optional, this sets min/max scale. If no layer, scale may be specifically set
}, srcNodeRef);
visibleScaleRangeSlider.startup();
});
Property Details
<Layer
LayerSetting the layer will update the suggested
scale range, minScale and maxScale.Default value:
<Map
MapSetting this property will update the slider's minimum/maximum values and current scale indicator.
Default value:
<Number
NumberThe current
maxScale value. Default is 0.Default value:
0Sample:
visibleScaleRangeSlider.set("maxScale",5000);
visibleScaleRangeSlider.set("minScale", 600000);
<Number
NumberThe current
minScale value. Default is 0.Default value:
0Sample:
visibleScaleRangeSlider.set("maxScale",5000);
visibleScaleRangeSlider.set("minScale", 600000);
Method Details
Event Details
[ On Style Events | Connect Style Event ]