Provides the logic for the Daylight widget.
Constructors
-
new DaylightViewModel(properties)
-
Parameter:properties 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 | more details A season can be set instead of a date. | more details | DaylightViewModel | |
| Boolean | more details Starts or pauses the daytime animation cycling through the minutes of the day. | more details | DaylightViewModel | |
| String | more details The name of the class. | more details | Accessor | |
| Date | more details The calendar date in the timezone given by utcOffset. | more details | DaylightViewModel | |
| Number | more details Controls the daytime and date animation speed. | more details | DaylightViewModel | |
| Number | more details Slider position for the time of day in the timezone given by utcOffset. | more details | DaylightViewModel | |
| Number | more details The difference in hours between UTC time and the time displayed in the widget. | more details | DaylightViewModel | |
| SceneView | more details The view from which the widget will operate. | more details | DaylightViewModel | |
| Boolean | more details 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
trueto start the animation and tofalseto pause it.- Default Value:false
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
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;
-
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
trueto start the animation and tofalseto pause it.- Default Value:false