ScaleRangeSliderViewModel

AMD: require(["esri/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel"], (ScaleRangeSliderVM) => { /* code goes here */ });
ESM: import ScaleRangeSliderVM from "@arcgis/core/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel";
Class: esri/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel
Inheritance: ScaleRangeSliderViewModel Accessor
Since: ArcGIS API for JavaScript 4.13

Provides the logic for the ScaleRangeSlider widget.

See also:
Example:
const view = new MapView({
  container: "viewDiv",
  map: map
});

const scaleRangeSlider = new ScaleRangeSlider({
  viewModel: {  // autocasts as new ScaleRangeSliderViewModel()
    view: view
  }
}, "scaleRangeSliderDiv");

Constructors

new ScaleRangeSliderViewModel(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Layermore details

When provided, the initial minScale and maxScale values will match the layer's.

more detailsScaleRangeSliderViewModel
Numbermore details

The maximum scale of the active scale range.

more detailsScaleRangeSliderViewModel
Numbermore details

The lowest possible maximum scale value from the slider.

more detailsScaleRangeSliderViewModel
Numbermore details

The minimum scale of the active scale range.

more detailsScaleRangeSliderViewModel
Numbermore details

The highest possible minimum scale value from the slider.

more detailsScaleRangeSliderViewModel
ScaleRangesmore details

The valid scale ranges available based on the slider position.

more detailsScaleRangeSliderViewModel
SliderViewModelmore details

The SliderViewModel for supporting the scale range slider widget.

more detailsScaleRangeSliderViewModel
Stringmore details

The current state of the widget.

more detailsScaleRangeSliderViewModel
MapView|SceneViewmore details

A reference to the MapView or SceneView.

more detailsScaleRangeSliderViewModel

Property Details

declaredClass Stringreadonly inherited

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

layer Layer

When provided, the initial minScale and maxScale values will match the layer's.

maxScale 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 Number

The lowest possible maximum scale value from the slider.

minScale 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 Number

The highest possible minimum scale value from the slider.

scaleRanges ScaleRangesreadonly

The valid scale ranges available based on the slider position.

sliderViewModel SliderViewModel

The SliderViewModel for supporting the scale range slider widget.

state Stringreadonly

The current state of the widget.

Possible Values:"disabled"|"ready"

Default Value:disabled

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

Method Overview

Name Return Type Summary Class
Numbermore details

Utility method for converting scale-to-slider values.

more detailsScaleRangeSliderViewModel
Numbermore details

Utility method for converting slider-to-scale values.

more detailsScaleRangeSliderViewModel

Method Details

mapScaleToSlider(scale){Number}

Utility method for converting scale-to-slider values.

Parameter:
scale Number

The map scale to be converted.

Returns:
Type Description
Number The value of the slider.
mapSliderToScale(value){Number}

Utility method for converting slider-to-scale values.

Parameter:
value Number

The value of the slider.

Returns:
Type Description
Number The map scale that corresponds to the value of the slider.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.