import TimeZoneLabel from "@arcgis/core/widgets/TimeZoneLabel.js";const TimeZoneLabel = await $arcgis.import("@arcgis/core/widgets/TimeZoneLabel.js");- Inheritance:
- TimeZoneLabel→
Widget<TimeZoneLabelProperties>→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.28
TimeZoneLabel is widget for displaying the current time zone of the MapView. The widget has two states, collapsed as a small button and expanded displaying the internationalized name of the MapView's time zone. The user can toggle between these states by clicking the widget's expand/collapse button. By default the widget is collapsed.
The widget will expand to the right when the document's direction is set to ltr (left-to-right) unless the widget
is added to the top-right to bottom-right View UI corners where it will expand towards the left. Similarly the
opposite occurs when the document's direction is set to rtl.
To add the TimeZoneLabel to the upper right hand corner in the default collapsed state.
view.ui.add(new TimeZoneLabel({ view: view }), "top-right");To add the TimeZoneLabel widget to the lower right hand corner of the View expanded.
view.ui.add(new TimeZoneLabel({ expanded: true, view: view }), "bottom-right");Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
container inherited | HTMLElement | null | undefined | |
declaredClass readonly inherited | ||
destroyed readonly inherited | ||
| | ||
| | ||
| | ||
Icon["icon"] | | |
id inherited | ||
label inherited | ||
| | ||
visible inherited |
container
- Type
- HTMLElement | null | undefined
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples
// Create the HTML div element programmatically at runtime and set to the widget's containerconst basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div")});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"});// Specify an already-defined HTML div element in the widget's container
const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"});
// HTML markup<body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div></body>// Specify the widget while adding to the view's UIconst basemapGallery = new BasemapGallery({ view: view});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"}); disabled
- Type
- boolean
When true, sets the widget to a disabled state so the user cannot interact with it.
- Default value
- false
Example
// Create the TimeZoneLabel widget.const timeZoneLabel = new TimeZoneLabel({ view: view });
// Add the widget to the upper right hand corner of the view.view.ui.add(timeZoneLabel, "top-right");
// Disable the widget when a user clicks a button.document.getElementById("myButton").addEventListener("click", () => { timeZoneLabel.disable = true;}); expandDirection
The direction the widget will expand.
By default, the widget will expand inward if assigned to a View UI corner. If the widget is positioned manually, the widget will expand towards the "end" which is equivalent to right in a LTR application.
Example
// Create a TimeZoneLabel widget that expands to towards the right (on a LTR application).const timeZoneLabel = new TimeZoneLabel({ expandDirection: "end", view: view });
// Manually assign the widget to the View's UI.view.ui.add(timeZoneLabel, "manual"); expanded
- Type
- boolean
The expanded state of the widget.
- Default value
- false
Example
// Create an expanded TimeZoneLabel widget.const timeZoneLabel = new TimeZoneLabel({ expanded: true, view: view });
// Add the widget to the upper right hand corner of the view.view.ui.add(timeZoneLabel, "top-right"); icon
- Type
- Icon["icon"]
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
- Default value
- "time-zone"
view
A reference to a MapView.
While this widget can be created without a reference to a MapView it is not very practical without one. A reference to a MapView is need for the widget to obtain the current time zone.
Example
// Create an expanded TimeZoneLabel widget.const timeZoneLabel = new TimeZoneLabel({ expanded: true, view: view });
// Add the widget to the upper right hand corner of the view.view.ui.add(timeZoneLabel, "top-right"); visible
- Type
- boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is
the first of three widgets associated to the upper right hand corner of the DefaultUI, then the other widgets will reposition when this widget is made invisible.
For more information, refer to the css display value of "none".
- Default value
- true
Example
// Hides the widget in the viewwidget.visible = false;Methods
| Method | Signature | Class |
|---|---|---|
classes inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
destroy inherited | destroy(): void | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
postInitialize inherited | postInitialize(): void | |
render inherited | render(): any | null | |
renderNow inherited | renderNow(): void | |
scheduleRender inherited | scheduleRender(): void | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- string
The computed class name.
Example
// .tsx syntax showing how to set css classes while rendering the widget
render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary };
return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> );} emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});