Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-time-zone-label";
No specific import is needed for this component.
Time Zone Label is a component for displaying the current time zone of a Map. The component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone. Users can toggle between these states by clicking the component's expand/collapse button. By default the component is collapsed.
When expanding, the component will lengthen inwards when positioned within a Map. This behavior can be overridden by setting the expandDirection property to either "start"
or "end"
.
disabled: boolean
When true
, sets the component to a disabled state so the user cannot interact with it.
expandDirection: "end" | "start"
The direction the component will expand.
By default, the component will expand inward if assigned to a View UI corner. If the component is positioned manually, the component will expand towards the "end" which is equivalent to right in a LTR application.
expanded: boolean
The expanded state of the component.
Property
label: string
The component's default label.
Property
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
state: "disabled" | "ready"
The state of the component.
No slots to display.
Events arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods componentOnReadyMethod
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
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!");
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