require(["esri/widgets/Daylight/DaylightViewModel"], (DaylightViewModel) => { /* code goes here */ });
import DaylightViewModel from "@arcgis/core/widgets/Daylight/DaylightViewModel.js";
esri/widgets/Daylight/DaylightViewModel
Provides the logic for the Daylight widget.
Constructors
-
new DaylightViewModel(properties)
-
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 |
---|---|---|---|
String | A season can be set instead of a date. more details | DaylightViewModel | |
Boolean | Starts or pauses the daytime animation cycling through the minutes of the day. more details | DaylightViewModel | |
String | The name of the class. more details | Accessor | |
Boolean | Indicates whether to show shadows cast by the sun. more details | DaylightViewModel | |
Date | The calendar date in the timezone given by utcOffset. more details | DaylightViewModel | |
Number | Controls the daytime and date animation speed. more details | DaylightViewModel | |
Boolean | Indicates whether date and time are used to determine position of the light source. more details | DaylightViewModel | |
Number | Slider position for the time of day in the timezone given by utcOffset. more details | DaylightViewModel | |
Number | The difference in hours between UTC time and the time displayed in the widget. more details | DaylightViewModel | |
SceneView | The view from which the widget will operate. more details | DaylightViewModel | |
Boolean | Starts or pauses the date animation cycling through the months of the year. more details | DaylightViewModel |
Property Details
-
currentSeason String
-
A season can be set instead of a date. Each season uses a fixed date corresponding to the seasonsal equinoxes and solstices.
Possible Values:"spring"|"summer"|"fall"|"winter"
-
dayPlaying Boolean
-
Starts or pauses the daytime animation cycling through the minutes of the day. Set to
true
to start the animation and tofalse
to pause it.- Default Value:false
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
directShadowsEnabled Boolean
-
Indicates whether to show shadows cast by the sun. For more details on this property see SceneView.environment.lighting.directShadowsEnabled.
-
playSpeedMultiplier Number
-
Controls the daytime and date animation speed.
- Default Value:1.0
Example// Plays the daylight animation at half of the default speed daylightWidget.playSpeedMultiplier = 0.5;
-
sunLightingEnabled Boolean
-
Indicates whether date and time are used to determine position of the light source. When
false
, the light source is positioned relative to the camera, using VirtualLighting.
-
timeSliderPosition Number
-
Slider position for the time of day in the timezone given by utcOffset. The position represents the time of the day in minutes. Possible values range between 0 and 1440.
-
utcOffset Number
-
The difference in hours between UTC time and the time displayed in the widget.
-
view SceneView
-
The view from which the widget will operate.
-
yearPlaying Boolean
-
Starts or pauses the date animation cycling through the months of the year. Set to
true
to start the animation and tofalse
to pause it.- Default Value:false
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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");