Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/widgets/ScaleRangeSlider"], function(ScaleRangeSlider) { /* code goes here */ });
Class: esri/widgets/ScaleRangeSlider
Inheritance: ScaleRangeSlider Widget Accessor
Since: ArcGIS API for JavaScript 4.13

The ScaleRangeSlider widget allows the user to set a minimum and maximum scale based on named scale ranges. When a layer is provided to the widget, the minScale and maxScale are set to the scale range of the layer.

The user can update the scale range by dragging thumbs across the slider to update the minScale and maxScale. The user can also change the minScale and maxScale by using the dropdowns underneath the minScaleLimit and maxScaleLimit. The thumbnail shows a preview of the scale based on the region specified.

widgets-scaleRangeSlider

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
const scaleRangeSlider = new ScaleRangeSlider({
  view: view,
  layer: featureLayer,  // scale range of this layer sets initial minScale and maxScale
  region: "mx",  // preview thumbnail will be of Mexico
});
view.ui.add(scaleRangeSlider, "bottom-left");

// to update the layer min/max scale based on the slider
scaleRangeSlider.watch(["minScale", "maxScale"], function(value, oldValue, name) {
  featureLayer[name] = value;
});

Constructors

new ScaleRangeSlider(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|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
Boolean

When true, sets the widget to a disabled state so the user cannot interact with it.

more details
more detailsScaleRangeSlider
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's default label.

more details
more detailsScaleRangeSlider
Layer

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

more details
more detailsScaleRangeSlider
Number

The maximum scale of the active scale range.

more details
more detailsScaleRangeSlider
Number

The lowest possible maximum scale value on the slider.

more details
more detailsScaleRangeSlider
Number

The minimum scale of the active scale range.

more details
more detailsScaleRangeSlider
Number

The highest possible minimum scale value on the slider.

more details
more detailsScaleRangeSlider
SupportedRegion

The region that the scale thumbnails will focus on.

more details
more detailsScaleRangeSlider
MapView|SceneView

A reference to the MapView or SceneView.

more details
more detailsScaleRangeSlider
ScaleRangeSliderViewModel

The view model for this widget.

more details
more detailsScaleRangeSlider
VisibleElements

The visible elements that are displayed within the widget.

more details
more detailsScaleRangeSlider

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
declaredClass Stringreadonly inherited

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

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

disabled Boolean

When true, sets the widget to a disabled state so the user cannot interact with it.

Default Value:false

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

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 on 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.

minScaleLimit Number

The highest possible minimum scale value on the slider.

The region that the scale thumbnails will focus on. Each region comes from the ISO 3166-1 alpha-2 code. See SupportedRegion for the list of regions that are currently supported.

Default Value:"US"

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

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the ScaleRangeSliderViewModel class to access all properties and methods on the widget.

visibleElements VisibleElementsautocast
Autocasts from Object[]

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Example:
scaleRangeSlider.visibleElements = {
   preview: false  // thumbnail preview of map will not be displayed
}

Method Overview

NameReturn TypeSummaryClass
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:
classNames Array<(string|Array<string>|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
TypeDescription
Booleantrue if a listener was notified
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

Type Definitions

SupportedRegion "AE"|"AR"|"AT"|"AU"|"BE"|"BG"|"BO"|"BR"|"CA"|"CH"|"CI"|"CL"|"CN"|"CO"|"CR"|"CZ"|"DE"|"DK"|"EE"|"EG"|"ES"|"FI"|"FR"|"GB"|"GL"|"GR"|"GT"|"HK"|"ID"|"IE"|"IL"|"IN"|"IQ"|"IS"|"IT"||"KE"|"KR"|"KW"|"LI"|"LT"|"LU"|"LV"|"MA"|"MG"|"ML"|"MO"|"MX"|"MY"|"NI"|"NL"|"NO"|"NZ"|"PE"|"PL"|"PR"|"PT"|"RO"|"RU"|"RW"|"SE"|"SG"|"SK"|"SR"|"SV"|"TH"|"TN"|"TW"|"US"|"VE"|"VI"|"ZA"

The region that the scale thumbnails will focus on. Each region comes from the ISO 3166-1 alpha-2 code.

CodeRegion
AEUnited Arab Emirates
ARArgentina
ATAustria
AUAustralia
BEBelgium
BGBulgaria
BOBolivia
BRBrazil
CACanada
CHSwitzerland
CICote D'Ivoire
CLChile
CNChina
COColombia
CRCosta Rica
CZCzech Republic
DEGermany
DKDenmark
EEEstonia
EGEgypt
ESSpain
FIFinland
FRFrance
GBGreat Britain
GLGreenland
GRGreece
GTGuatemala
HKHong Kong
IDIndonesia
IEIreland
ILIsrael
INIndia
IQIraq
ISIceland
ITItaly
JPJapan
KEKenya
KRSouth Korea
KWKuwait
LILiechtenstein
LTLithuania
LULuxembourg
LVLatvia
MAMorocco
MGMadagascar
MLMali
MOMacao
MXMexico
MYMalaysia
NINicaragua
NLNetherlands
NONorway
NZNew Zealand
PEPeru
PLPoland
PRPuerto Rico
PTPortugal
RORomania
RURussia
RWRwanda
SESweden
SGSingapore
SKSlovakia
SRSuriname
SVEl Salvador
THThailand
TNTunisia
TWTaiwan
USUnited States
VEVenezuela
VIU.S. Virgin Islands
ZASouth Africa
VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Property:
preview Boolean

Indicates whether the preview thumbnail of the region is visible. Default value is true.

API Reference search results

NameTypeModule
Loading...