arcgis-scale-bar | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/map-components/components/arcgis-scale-bar";

Inheritance:: ArcgisScaleBar→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 4.28

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
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`barStyle`	`bar-style`	`ScaleBarStyle`
`icon`	`icon`	`string \| undefined`
`label`	`label`	`string \| undefined`
`messageOverrides`		`Record<string, unknown> \| undefined`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`unit`	`unit`	`ScaleBarUnit \| undefined`
`view`		`MapView \| null \| undefined`

autoDestroyDisabled

Property

Type: 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

barStyle

Property

Type: ScaleBarStyle

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

Property

Type: string | undefined

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

Calcite Icons

Attribute: icon
Default value: "actual-size"

label

Property

Type: string | undefined

The component's default label.

Attribute: label

messageOverrides

Property

Type: Record<string, unknown> | undefined

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

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

See also

Associate components with a Map or Scene component

Attribute: reference-element

unit

Property

Type: ScaleBarUnit | undefined

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

view

Property

Type: MapView | null | undefined

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-scale-bar component will be associated with a map or scene component rather than using the view property.

Methods

Method	Signature
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`destroy`	`destroy(): Promise<void>`

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisScaleBar = document.querySelector("arcgis-scale-bar");
document.body.append(arcgisScaleBar);
await arcgisScaleBar.componentOnReady();
console.log("arcgis-scale-bar is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
`arcgisReady`	CustomEvent<void>

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is ready to be interacted with.