Scale Range Slider

1
import "@arcgis/map-components/components/arcgis-scale-range-slider";

The ScaleRangeSlider component allows the user to set a minimum and maximum scale based on named scale ranges.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
disabled
boolean
hide-preview
boolean
hide-scale-menus-max-scale-menu
boolean
hide-scale-menus-min-scale-menu
boolean
icon
string
label
string
max-scale
number
max-scale-limit
number
min-scale
number
min-scale-limit
number
mode
"max-scale-only" | "min-scale-only" | "range"
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
state
readonly
state
"disabled" | "ready"

autoDestroyDisabled

Property
autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute
auto-destroy-disabled
Default value
false

disabled

Property
disabled: boolean

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

Read more...

Attribute
disabled
Default value
false

hidePreview

Property
hidePreview: boolean
Attribute
hide-preview
Default value
false

hideScaleMenusMaxScaleMenu

Property
hideScaleMenusMaxScaleMenu: boolean
Attribute
hide-scale-menus-max-scale-menu
Default value
false

hideScaleMenusMinScaleMenu

Property
hideScaleMenusMinScaleMenu: boolean
Attribute
hide-scale-menus-min-scale-menu
Default value
false

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute
icon
Default value
"actual-size"

label

Property
label: string

The component's default label.

Attribute
label

layer

Property
layer: Layer | Sublayer

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

Read more...

maxScale

Property
maxScale: number

The maximum scale of the active scale range.

Read more...

Attribute
max-scale

maxScaleLimit

Property
maxScaleLimit: number

The lowest possible maximum scale value on the slider.

Read more...

Attribute
max-scale-limit

minScale

Property
minScale: number

The minimum scale of the active scale range.

Read more...

Attribute
min-scale

minScaleLimit

Property
minScaleLimit: number

The highest possible minimum scale value on the slider.

Read more...

Attribute
min-scale-limit

mode

Property
mode: "max-scale-only" | "min-scale-only" | "range"

The mode of the widget, indicating which slider thumbs can be adjusted.

Read more...

Attribute
mode
Default value
"range"

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

region

Property

The region that the scale thumbnails will focus on.

Read more...

Default value
"US"

state

readonly
Property
state: "disabled" | "ready"

The current state of the widget.

Read more...

Attribute
state
Default value
"disabled"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component

Returns
Promise<void>

Events

EventType
{ name: "state" | "maxScale" | "minScale"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "state" | "maxScale" | "minScale"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event
arcgisReady: undefined

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close