DaylightViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.33

Provides the logic for the Daylight widget and component.

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	A season can be set instead of a date.	DaylightViewModel
Boolean	Starts or pauses the daytime animation cycling through the minutes of the day.	DaylightViewModel
String	The name of the class.	Accessor
Boolean	Indicates whether to show shadows cast by the sun.	DaylightViewModel
Date	The calendar date in the timezone given by utcOffset.	DaylightViewModel
Number	Controls the daytime and date animation speed.	DaylightViewModel
Boolean	Indicates whether date and time are used to determine position of the light source.	DaylightViewModel
Number	Slider position for the time of day in the timezone given by utcOffset.	DaylightViewModel
Number	The difference in hours between UTC time and the time displayed in the widget.	DaylightViewModel
SceneView\|null\|undefined	The view from which the widget will operate.	DaylightViewModel
Boolean	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 Dateautocast

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.

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 |null |undefined

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

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Emits an event on the instance.	DaylightViewModel
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	DaylightViewModel
Boolean	Returns true if a named group of handles exist.	Accessor
Object	Registers an event handler on the instance.	DaylightViewModel
	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.

emit Method emit(type, event){Boolean}

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

hasEventListener Method hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

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");
}

on Method on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The 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);
});

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");

Event Overview

Name	Type	Summary	Class
		Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the season selector or the play buttons.	DaylightViewModel

Event Details

user-date-time-change Event user-date-time-change Since: ArcGIS Maps SDK for JavaScript 4.33 DaylightViewModel since 4.14, user-date-time-change added at 4.33.

Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the season selector or the play buttons.