The daylight widget can be used to manipulate the time and date and
to toggle shadows in a SceneView. When changing the time and date,
the position of the sun and the stars gets updated accordingly, changing the lighting and the
shadows in the scene. This widget modifies the date
and directShadowsEnabled
properties of
SceneView.environment.lighting.
The daytime slider has an option to select the timezone. When the user changes the timezone, a new time
in that timezone is calculated and displayed in the slider. The timezone selector can be disabled
by setting timezone
to false
in the visibleElements property.
By default a calendar is displayed where the user can select the day, month and year. With the dateOrSeason property, the calendar can be replaced with a dropdown menu where a season can be selected:
const daylight = new Daylight({
view: view,
dateOrSeason: "season"
});
There are two play buttons, one corresponds to the daytime slider and it animates the time as it cycles through the minutes of the day. The second button corresponds to the date picker and it animates the time as it cycles through the months of the year. The speed of the animation can be set using the playSpeedMultiplier property.
const daylight = new Daylight({
view: view,
playSpeedMultiplier: 2
});
Except for the daytime slider, all the elements in the daylight widget can be hidden by using the visibleElements property:
const daylight = new Daylight({
view: view,
visibleElements: {
timezone: false,
datePicker: false,
playButtons: false,
shadowsToggle: false
}
});
With these settings, the widget looks like this:
Known limitations:
When the SceneView.environment.lighting is of the type virtual
, setting the time and date does not have an influence on the lighting conditions of the scene.
// basic usage of the daylight widget using the default settings
const daylight = new Daylight({
view: view
});
view.ui.add(daylight, "top-right");
Constructors
-
new Daylight(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example:// Typical usage const daylightWidget = new Daylight({ view: view }); view.ui.add(daylightWidget, "top-right");
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String|HTMLElement | more details The ID or node representing the DOM element containing the widget. | more details | Widget | |
String | more details Controls whether the widget displays a date or a season picker. | more details | Daylight | |
String | more details The name of the class. | more details | Accessor | |
Number | more details Indicates the heading level to use for the widget title. | more details | Daylight | |
String | more details The widget's default CSS icon class. | more details | Daylight | |
String | more details The unique ID assigned to the widget when the widget is created. | more details | Widget | |
String | more details The widget's default label. | more details | Daylight | |
Number | more details Controls the speed of the daytime and date animation. | more details | Daylight | |
Number|Number[] | more details Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. | more details | Daylight | |
SceneView | more details A reference to the SceneView. | more details | Daylight | |
DaylightViewModel | more details The view model for the Daylight widget. | more details | Daylight | |
Boolean | more details Indicates whether the widget is visible. | more details | Widget | |
VisibleElements | more details This property provides the ability to display or hide the individual elements of the widget. | more details | Daylight |
Property Details
-
-
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 cases 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" });
-
dateOrSeason String
-
Controls whether the widget displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed date corresponding to the equinoxes and solstices of 2014.
Possible Values:"season"|"date"
- Default Value:"date"
Example:// set the season picker daylightWidget.dateOrSeason = "season";
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
headingLevel NumberSince: ArcGIS API for JavaScript 4.20
-
Indicates the heading level to use for the widget title. By default, the title is rendered as a level 3 heading (e.g.
<h3>Daylight</h3>
). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.- Default Value:3
- See also:
Example:daylight.headingLevel = 2;
-
iconClass String
-
The widget's default CSS icon class.
-
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
-
label String
-
The widget's default label. This label displays when it is used within another widget, such as the Expand or LayerList widgets.
-
playSpeedMultiplier Number
-
Controls the speed of the daytime and date animation.
- Default Value:1.0
Example:// Plays the daylight animation at half of the default speed daylightWidget.playSpeedMultiplier = 0.5;
-
Since: ArcGIS API for JavaScript 4.16
-
Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb. All values are in minutes, where
0
is midnight and23 * 60 + 59
is just before midnight the following day.If an array of numbers is passed to this property, the slider thumbs may only be moved to the times specified in the array.
If a single number is set, then steps are set for the entire day at an interval of
timeSliderSteps
minutes. For example, if a value of60
is set here, dragging the slider will allow selecting each of 24 hours of the day.- Default Value:5
Examples:// set steps at an interval of 60. So the // slider thumb snaps at each hour of the day. daylightWidget.timeSliderSteps = 60;
// Set steps at specific times. daylightWidget.timeSliderSteps = [60, 100, 120, 160];
-
viewModel DaylightViewModelautocast
-
The view model for the Daylight widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the DaylightViewModel class.
-
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;
-
visibleElements VisibleElementsautocast
-
This property provides the ability to display or hide the individual elements of the widget. Play buttons, shadow toggle button, date picker and timezone selector can be displayed or hidden by setting their corresponding properties to
true
orfalse
. By default, all the elements are displayed.Example:// display all elements, except the shadow toggle button daylightWidget.visibleElements.shadowsToggle = false; // disable all elements daylightWidget.visibleElements = { playButtons: false, shadowsToggle: false, datePicker: false, timezone: false };
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
String | more details A utility method used for building the value for a widget's | more details | Widget | |
more details Destroys the widget instance. | more details | Widget | ||
Boolean | more details Emits an event on the instance. | more details | Widget | |
Boolean | more details Indicates whether there is an event listener on the instance that matches the provided event name. | more details | Widget | |
Boolean | more details
| more details | Widget | |
Boolean | more details
| more details | Widget | |
Boolean | more details
| more details | Widget | |
Object | more details Registers an event handler on the instance. | more details | Widget | |
more details Widget teardown helper. | more details | Widget | ||
more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | ||
Object | more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | |
more details Renders widget to the DOM immediately. | more details | Widget | ||
more details This method is primarily used by developers when implementing custom widgets. | more details | Widget | ||
Promise | more details
| more details | Widget |
Method Details
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying CSS class setup.Parameter:repeatable The class names.
Returns:Type Description String The computed class name. - See also:
Example:// .tsx syntax showing how to set CSS classes while rendering the widget render() { const dynamicIconClasses = { [CSS.myIcon]: this.showIcon, [CSS.greyIcon]: !this.showIcon }; return ( <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} /> ); }
-
destroy()inherited
-
Destroys the widget instance.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters:type StringThe name of the event.
event ObjectoptionalThe event payload.
Returns:Type Description Boolean true
if a listener was notified
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameter:type StringThe name of the event.
Returns:Type Description Boolean Returns true if the class supports the input event.
-
Since: ArcGIS API for JavaScript 4.19
-
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:Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
Since: ArcGIS API for JavaScript 4.19
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been rejected.
-
Since: ArcGIS API for JavaScript 4.19
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.Returns:Type Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters:An event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
Returns:Type 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. Example:view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
own(handles)inherited
-
Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.
Parameter:handles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
postInitialize()inherited
-
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
-
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
Returns:Type Description Object The rendered virtual node.
-
renderNow()inherited
-
Renders widget to the DOM immediately.
-
scheduleRender()inherited
-
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.
-
Since: ArcGIS API for JavaScript 4.19
-
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.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
Returns:Type Description Promise Returns a new promise for the result of callback
that may be used to chain additional functions.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 });
Type Definitions
-
VisibleElements
-
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
- Properties:
-
playButtons BooleanDefault Value:true
When set to
false
, neither of the play buttons are displayed.shadowsToggle BooleanDefault Value:trueWhen set to
false
, the shadow toggle button is not displayed.datePicker BooleanDefault Value:trueWhen set to
false
, neither the date nor the season picker are displayed.timezone BooleanDefault Value:trueWhen set to
false
, the timezone selector is not displayed.