require(["esri/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel"], (ScaleRangeSliderVM) => { /* code goes here */ });
import ScaleRangeSliderVM from "@arcgis/core/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel.js";
esri/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel
Provides the logic for the ScaleRangeSlider widget.
const view = new MapView({
container: "viewDiv",
map: map
});
const scaleRangeSlider = new ScaleRangeSlider({
viewModel: { // autocasts as new ScaleRangeSliderViewModel()
view: view
}
}, "scaleRangeSliderDiv");Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| Layer | When provided, the initial minScale and maxScale values will match the layer's. | ScaleRangeSliderViewModel | |
| Number | The maximum scale of the active scale range. | ScaleRangeSliderViewModel | |
| Number | The lowest possible maximum scale value from the slider. | ScaleRangeSliderViewModel | |
| Number | The minimum scale of the active scale range. | ScaleRangeSliderViewModel | |
| Number | The highest possible minimum scale value from the slider. | ScaleRangeSliderViewModel | |
| ScaleRanges | The valid scale ranges available based on the slider position. | ScaleRangeSliderViewModel | |
| SliderViewModel | The SliderViewModel for supporting the scale range slider widget. | ScaleRangeSliderViewModel | |
| String | The current state of the widget. | ScaleRangeSliderViewModel | |
| MapView|SceneView | ScaleRangeSliderViewModel |
Property Details
-
layer
Propertylayer Layer -
When provided, the initial minScale and maxScale values will match the layer's.
When a tiled layer is used, the slider will be restricted from moving the slider thumbs past the
lodsof the layer's tiling scheme. Since version 4.28, when a MapImageLayer is used, the slider will be restricted from moving past the min/max scale defined on the map service. The unavailable scale range will be designated with a dashed line.
-
maxScale
PropertymaxScale Number -
The maximum scale of the active scale range. When the maxScale reaches the maxScaleLimit, the maxScale value becomes 0 and there is no maximum scale set.
-
maxScaleLimit
PropertymaxScaleLimit Number -
The lowest possible maximum scale value from the slider.
-
minScale
PropertyminScale Number -
The minimum scale of the active scale range. When the minScale reaches the minScaleLimit, the minScale value becomes 0 and there is no minimum scale set.
-
minScaleLimit
PropertyminScaleLimit Number -
The highest possible minimum scale value from the slider.
-
scaleRanges
PropertyscaleRanges ScaleRangesreadonly -
The valid scale ranges available based on the slider position.
-
sliderViewModel
PropertysliderViewModel SliderViewModel -
The SliderViewModel for supporting the scale range slider widget.
-
state
Propertystate Stringreadonly -
The current state of the widget.
Possible Values:"disabled"|"ready"
- Default Value:disabled
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
| Number | Utility method for converting scale-to-slider values. | ScaleRangeSliderViewModel | |
| Number | Utility method for converting slider-to-scale values. | ScaleRangeSliderViewModel | |
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");