DaylightViewModel

AMD: require(["esri/widgets/Daylight/DaylightViewModel"], (DaylightViewModel) => { /* code goes here */ });
ESM: import DaylightViewModel from "@arcgis/core/widgets/Daylight/DaylightViewModel.js";
Class: esri/widgets/Daylight/DaylightViewModel
Inheritance: DaylightViewModel Accessor
Since: ArcGIS Maps SDK for JavaScript 4.14

Provides the logic for the Daylight widget.

See also

Constructors

DaylightViewModel

Constructor
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.
Show inherited properties Hide inherited properties
Name Type Summary Class

A season can be set instead of a date.

DaylightViewModel

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

DaylightViewModel

The name of the class.

Accessor

Indicates whether to show shadows cast by the sun.

DaylightViewModel

The calendar date in the timezone given by utcOffset.

DaylightViewModel

Controls the daytime and date animation speed.

DaylightViewModel

Indicates whether date and time are used to determine position of the light source.

DaylightViewModel

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

DaylightViewModel

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

DaylightViewModel

The view from which the widget will operate.

DaylightViewModel

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

DaylightViewModel

Property Details

currentSeason

Property
currentSeason String

A season can be set instead of a date. Each season uses a fixed date corresponding to the seasonal equinoxes and solstices.

Possible Values:"spring" |"summer" |"fall" |"winter"

dayPlaying

Property
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

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

directShadowsEnabled

Property
directShadowsEnabled Boolean

Indicates whether to show shadows cast by the sun. For more details on this property see SceneView.environment.lighting.directShadowsEnabled.

localDate

Property
localDate Date

The calendar date in the timezone given by utcOffset.

This property should only be set once the widget and the view are initialized, for example, from within an event handler. To initialize the view with a specific date and time, set a SunLighting on the SceneView.environment.

Example
view.environment.lighting = new SunLighting({
  date: new Date("2022-06-21T12:00:00")
});

playSpeedMultiplier

Property
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

Property
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

Property
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.

This property should only be set once the widget and the view are initialized, for example, from within an event handler. To initialize the view with a specific date and time, set a SunLighting on the SceneView.environment.

Example
view.environment.lighting = new SunLighting({
  date: new Date("2022-06-21T12:00:00")
});

utcOffset

Property
utcOffset Number

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

view

Property
view SceneView

The view from which the widget will operate.

yearPlaying

Property
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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.