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
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 | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
| ||
state readonly | state | "disabled" | "ready" |
autoDestroyDisabled
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
disabled: boolean
When 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: 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"
maxScaleLimit
maxScaleLimit: number
The lowest possible maximum scale value on the slider.
- Attribute
- max-scale-limit
minScaleLimit
minScaleLimit: number
The 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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
region
region: SupportedRegion
The region that the scale thumbnails will focus on.
- Default value
- "US"
state
state: "disabled" | "ready"
The current state of the widget.
- Attribute
- state
- Default value
- "disabled"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state" | "maxScale" | "minScale"; } | |
undefined |