DaylightViewModel

require(["esri/widgets/Daylight/DaylightViewModel"], function(DaylightViewModel) { /* code goes here */ });
Class: esri/widgets/Daylight/DaylightViewModel
Inheritance: DaylightViewModel Accessor
Since: ArcGIS API for JavaScript 4.14

Provides the logic for the Daylight widget.

See also:

Constructors

new DaylightViewModel(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

A season can be set instead of a date.

more details
more detailsDaylightViewModel
Boolean

Starts or pauses the daytime animation cycling through the minutes of the day.

more details
more detailsDaylightViewModel
String

The name of the class.

more details
more detailsAccessor
Date

The calendar date in the timezone given by utcOffset.

more details
more detailsDaylightViewModel
Number

Controls the daytime and date animation speed.

more details
more detailsDaylightViewModel
Number

Slider position for the time of day in the timezone given by utcOffset.

more details
more detailsDaylightViewModel
Number

The difference in hours between UTC time and the time displayed in the widget.

more details
more detailsDaylightViewModel
SceneView

The view from which the widget will operate.

more details
more detailsDaylightViewModel
Boolean

Starts or pauses the date animation cycling through the months of the year.

more details
more detailsDaylightViewModel

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"

Default Value:"spring"
dayPlaying Boolean

Starts or pauses the daytime animation cycling through the minutes of the day. Set to true to start the animation and to false to pause it.

Default Value:false
declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

localDate Date

The calendar date in the timezone given by utcOffset.

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.

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 to false to pause it.

Default Value:false

API Reference search results

NameTypeModule
Loading...