import "@arcgis/map-components/components/arcgis-scale-bar";The Scale Bar component displays a scale bar representing the scale of the map. It respects various coordinate systems and displays units in metric or imperial values. Metric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale. When working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.
When the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale. Otherwise, the center of the map is used to calculate the scale.
Known limitations
- This component is not currently supported within a Scene component.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
bar-style | "line" | "ruler" | |
icon | string | |
label | string | |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
unit | "dual" | "imperial" | "metric" |
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
barStyle
barStyle: "line" | "ruler"The style for the scale bar.
When unit is set to dual, the style will always be line.
- Attribute
- bar-style
- Default value
- "line"
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"
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "top-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
unit
unit: "dual" | "imperial" | "metric"Units to use for the scale bar.
When using dual, the scale bar displays both metric and imperial units.
When metric, distances will be shown in either kilometers, meters, centimeters, or millimeters depending on the scale. Similarly, imperial
units will be shown in either miles, feet, or inches.
- Attribute
- unit
Slots
Events
| Event | Type |
|---|---|
CustomEvent<void> |
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 arcgisScaleBar = document.querySelector("arcgis-scale-bar");
document.body.append(arcgisScaleBar);
await arcgisScaleBar.componentOnReady();
console.log("arcgis-scale-bar is ready to go!");- Returns
- Promise<void>