Skip To ContentArcGIS for DevelopersSign In Dashboard

ScaleRangeSliderViewModel

require(["esri/widgets/ScaleRangeSlider/ScaleRangeSliderViewModel"], function(ScaleRangeSliderVM) { /* code goes here */ });
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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Layer

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

more details
more detailsScaleRangeSliderViewModel
Number

The maximum scale of the active scale range.

more details
more detailsScaleRangeSliderViewModel
Number

The lowest possible maximum scale value from the slider.

more details
more detailsScaleRangeSliderViewModel
Number

The minimum scale of the active scale range.

more details
more detailsScaleRangeSliderViewModel
Number

The highest possible minimum scale value from the slider.

more details
more detailsScaleRangeSliderViewModel
ScaleRanges

The valid scale ranges available based on the slider position.

more details
more detailsScaleRangeSliderViewModel
SliderViewModel

The SliderViewModel for supporting the scale range slider widget.

more details
more detailsScaleRangeSliderViewModel
String

The current state of the widget.

more details
more detailsScaleRangeSliderViewModel
MapView|SceneView

A reference to the MapView or SceneView.

more details
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

NameReturn TypeSummaryClass
Number

Utility method for converting scale-to-slider values.

more details
more detailsScaleRangeSliderViewModel
Number

Utility method for converting slider-to-scale values.

more details
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:
TypeDescription
NumberThe value of the slider.
mapSliderToScale(value){Number}

Utility method for converting slider-to-scale values.

Parameter:
value Number

The value of the slider.

Returns:
TypeDescription
NumberThe map scale that corresponds to the value of the slider.

API Reference search results

NameTypeModule
Loading...