A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/ below:

Scale Bar | ArcGIS Maps SDK for JavaScript 4.33

Use dark colors for code blocks Copy

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

No specific import is needed for this component.

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

Demo Properties 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
barStyle

Property

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

Property

icon: string

Icon 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"
label

Property

label: string

The component's default label.

Attribute
label
messageOverrides

Property

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

Property

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
Attribute
reference-element
unit

Property

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

No slots to display.

Events arcgisReady

Event

arcgisReady: CustomEvent<void>

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

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

Methods componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example

Use dark colors for code blocks Copy

1
2
3
4
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>
destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns
Promise<void>

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4