import "@arcgis/map-components/components/arcgis-scale-range-slider";The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
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 | ||
| ||
statereadonly | state | "disabled" | "ready" |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
disabled: booleanWhen true, sets the widget to a disabled state so the user cannot interact with it.
- Attribute
- disabled
- Default value
- false
hideScaleMenusMaxScaleMenu
hideScaleMenusMaxScaleMenu: boolean- Attribute
- hide-scale-menus-max-scale-menu
- Default value
- false
hideScaleMenusMinScaleMenu
hideScaleMenusMinScaleMenu: boolean- Attribute
- hide-scale-menus-min-scale-menu
- Default value
- false
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "actual-size"
maxScaleLimit
maxScaleLimit: numberThe lowest possible maximum scale value on the slider.
- Attribute
- max-scale-limit
minScaleLimit
minScaleLimit: numberThe highest possible minimum scale value on the slider.
- Attribute
- min-scale-limit
mode
mode: "max-scale-only" | "min-scale-only" | "range"The mode of the widget, indicating which slider thumbs can be adjusted.
- Attribute
- mode
- Default value
- "range"
position
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
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
- Attribute
- reference-element
region
region: SupportedRegionThe region that the scale thumbnails will focus on.
- Default value
- "US"
state
state: "disabled" | "ready"The current state of the component.
- Attribute
- state
- Default value
- "disabled"
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state" | "maxScale" | "minScale"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state" | "maxScale" | "minScale"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisScaleRangeSlider = document.querySelector("arcgis-scale-range-slider");
document.body.append(arcgisScaleRangeSlider);
await arcgisScaleRangeSlider.componentOnReady();
console.log("arcgis-scale-range-slider is ready to go!");- Returns
- Promise<void>