require(["esri/widgets/TimeZoneLabel"], (TimeZoneLabel) => { /* code goes here */ });
import TimeZoneLabel from "@arcgis/core/widgets/TimeZoneLabel.js";
esri/widgets/TimeZoneLabel
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");
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The ID or node representing the DOM element containing the widget. | Widget | ||
The name of the class. | Accessor | ||
When | TimeZoneLabel | ||
The direction the widget will expand. | TimeZoneLabel | ||
The expanded state of the widget. | TimeZoneLabel | ||
Icon which represents the widget. | TimeZoneLabel | ||
The unique ID assigned to the widget when the widget is created. | Widget | ||
The widget's label. | Widget | ||
A reference to a MapView. | TimeZoneLabel | ||
Indicates whether the widget is visible. | Widget |
Property Details
-
container
InheritedPropertycontainer String |HTMLElement
Inherited from Widget -
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 container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.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 view view.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 UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
disabled
disabled 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
expandDirection String
-
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.
Possible Values:"start" |"end"
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
expanded Boolean
-
The expanded state of the widget. This property can be set to update expanded state or alternatively the expand() and collapse() methods can be used.
- 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
icon String
-
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"
- See also
-
view
view MapView
-
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
InheritedPropertyvisible Boolean
Inherited from Widget -
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 view UI, 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 view widget.visible = false;
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A utility method used for building the value for a widget's | Widget | ||
Destroys the widget instance. | Widget | ||
Emits an event on the instance. | Widget | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Widget | ||
Returns true if a named group of handles exist. | Accessor | ||
| Widget | ||
| Widget | ||
| Widget | ||
Registers an event handler on the instance. | Widget | ||
Adds one or more handles which are to be tied to the lifecycle of the widget. | Widget | ||
Executes after widget is ready for rendering. | Widget | ||
Removes a group of handles owned by the object. | Accessor | ||
This method is implemented by subclasses for rendering. | Widget | ||
Renders widget to the DOM immediately. | Widget | ||
Schedules widget rendering. | Widget | ||
| Widget |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
classes
InheritedMethodclasses(classNames){String}
Inherited from Widget -
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.ReturnsType Description 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)} /> ); }
-
Inherited from Widget
-
Destroys the widget instance.
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Widget -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from Widget -
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from Widget -
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from Widget -
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
on
InheritedMethodon(type, listener){Object}
Inherited from Widget -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from WidgetDeprecated since 4.28 Use addHandles() instead.
-
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
Inherited from Widget
-
Executes after widget is ready for rendering.
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Widget
-
Renders widget to the DOM immediately.
-
Inherited from Widget
-
Schedules widget rendering. This method is useful for changes affecting the UI.
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from Widget -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new Promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.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 });