arcgis-time-zone-label | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/map-components/components/arcgis-time-zone-label";

Inheritance:: ArcgisTimeZoneLabel→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 4.33

Time Zone Label is a component for displaying the current arcgis-map.timeZone of an arcgis-map.

Demos

Properties

Property	Attribute	Type
`actionIcon` reflected	`action-icon`	`Icon["icon"] \| undefined`
`disabled` reflected	`disabled`	`boolean`
`icon` reflected	`icon`	`Icon["icon"] \| undefined`
`label`	`label`	`string \| undefined`
`messageOverrides`		`Record<string, unknown> \| undefined`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`state` readonly		`State`
`view`		`MapView \| undefined`

actionIcon

reflected Property

Type: Icon["icon"] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An optional leading icon that is displayed within the component.

Attribute: action-icon

disabled

reflected Property

Type: boolean

When true, the component is visually withdrawn and cannot receive user interaction.

Attribute: disabled
Default value: false

icon

reflected Property

Type: Icon["icon"] | undefined

Since: ArcGIS Maps SDK for JavaScript 4.34

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: "time-zone"

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

state

readonly Property

Type: State

The state of the component.

view

Property

Type: MapView | 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-time-zone-label component will be associated with a map or scene component rather than using the view property.

Methods

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

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 arcgisTimeZoneLabel = document.querySelector("arcgis-time-zone-label");
document.body.append(arcgisTimeZoneLabel);
await arcgisTimeZoneLabel.componentOnReady();
console.log("arcgis-time-zone-label is ready to go!");

Events

Name	Type
`arcgisPropertyChange`	CustomEvent<{ name: "state"; }>
`arcgisReady`	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state"; }>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: CustomEvent<void>

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