ScaleRangeSlider

AMD: require(["esri/widgets/ScaleRangeSlider"], (ScaleRangeSlider) => { /* code goes here */ });
ESM: import ScaleRangeSlider from "@arcgis/core/widgets/ScaleRangeSlider";
Class: esri/widgets/ScaleRangeSlider
Inheritance: ScaleRangeSlider Widget Accessor
Since: ArcGIS Maps SDK 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String|HTMLElement

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

more details
Widget
String

The name of the class.

more details
Accessor
Boolean

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

more details
ScaleRangeSlider
String

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

more details
Widget
String

The widget's default label.

more details
ScaleRangeSlider
Layer

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

more details
ScaleRangeSlider
Number

The maximum scale of the active scale range.

more details
ScaleRangeSlider
Number

The lowest possible maximum scale value on the slider.

more details
ScaleRangeSlider
Number

The minimum scale of the active scale range.

more details
ScaleRangeSlider
Number

The highest possible minimum scale value on the slider.

more details
ScaleRangeSlider
SupportedRegion

The region that the scale thumbnails will focus on.

more details
ScaleRangeSlider
MapView|SceneView

A reference to the MapView or SceneView.

more details
ScaleRangeSlider
ScaleRangeSliderViewModel

The view model for this widget.

more details
ScaleRangeSlider
Boolean

Indicates whether the widget is visible.

more details
Widget
VisibleElements

The visible elements that are displayed within the widget.

more details
ScaleRangeSlider

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.

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.

When set, the user will be restricted from moving the slider thumbs past this value, and the range beyond the maxScaleLimit will be unavailable. This value is defined by the maximum scale from the lods from a layer's tiling scheme.

When maxScaleLimit or minScaleLimit is set, the unavailable range will be designated with a dashed line. widgets-scaleRangeSlider-scaleLimit

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.

When set, the user will be restricted from moving the slider thumbs past this value, and the range beyond the minScaleLimit will be unavailable. This value is defined by the minimum scale from the lods from a layer's tiling scheme.

When minScaleLimit or maxScaleLimit is set, the unavailable range will be designated with a dashed line. widgets-scaleRangeSlider-scaleLimit

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.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true
Example
// Hides the widget in the view
widget.visible = false;
visibleElements VisibleElements

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
String

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

more details
Widget

Destroys the widget instance.

more details
Widget
Boolean

Emits an event on the instance.

more details
Widget
Boolean

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

more details
Widget
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
Widget
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
Widget
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
Widget
Object

Registers an event handler on the instance.

more details
Widget

Adds one or more handles which are to be tied to the lifecycle of the widget.

more details
Widget

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

more details
Widget

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
Widget

Renders widget to the DOM immediately.

more details
Widget

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

more details
Widget
Promise

when() may be leveraged once an instance of the class is created.

more details
Widget

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

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

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 String|String[]|Object
repeatable

The class names.

Returns
Type Description
String The 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
Type Description
Boolean true 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
Type Description
Boolean Returns true if the class supports the input event.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if 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");
}
isFulfilled(){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
on(type, listener){Object}inherited

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

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When 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(handleOrHandles)inherited
Since: ArcGIS Maps SDK for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.
Parameter
handleOrHandles WatchHandle|WatchHandle[]

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.

removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
render(){Object}inherited

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

Returns
Type Description
Object The 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.

when(callback, errback){Promise}inherited
Since: ArcGIS Maps SDK for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns
Type Description
Promise Returns a new promise for the result of callback.
Example
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

SupportedRegion String

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

Code Region
AE United Arab Emirates
AR Argentina
AT Austria
AU Australia
BE Belgium
BG Bulgaria
BO Bolivia
BR Brazil
CA Canada
CH Switzerland
CI Cote D'Ivoire
CL Chile
CN China
CO Colombia
CR Costa Rica
CZ Czech Republic
DE Germany
DK Denmark
EE Estonia
EG Egypt
ES Spain
FI Finland
FR France
GB Great Britain
GL Greenland
GR Greece
GT Guatemala
HK Hong Kong
ID Indonesia
IE Ireland
IL Israel
IN India
IQ Iraq
IS Iceland
IT Italy
JP Japan
KE Kenya
KR South Korea
KW Kuwait
LI Liechtenstein
LT Lithuania
LU Luxembourg
LV Latvia
MA Morocco
MG Madagascar
ML Mali
MO Macao
MX Mexico
MY Malaysia
NI Nicaragua
NL Netherlands
NO Norway
NZ New Zealand
PE Peru
PL Poland
PR Puerto Rico
PT Portugal
RO Romania
RU Russia
RW Rwanda
SE Sweden
SG Singapore
SK Slovakia
SR Suriname
SV El Salvador
TH Thailand
TN Tunisia
TW Taiwan
US United States
VE Venezuela
VI U.S. Virgin Islands
ZA South Africa

Possible Values:"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"|"JP"|"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"

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.

Properties
preview Boolean
optional

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

scaleMenus Boolean|Object
optional

Since 4.24 Indicates whether the scale dropdown menus are visible.

Specification
minScaleMenu Boolean
optional

Indicates whether the minimum scale dropdown menu is visible. Default value is true.

maxScaleMenu Boolean
optional

Indicates whether the maximum scale dropdown menu is visible. Default value is true.

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