ShadowCastViewModel

AMD: require(["esri/widgets/ShadowCast/ShadowCastViewModel"], (ShadowCastViewModel) => { /* code goes here */ });
ESM: import ShadowCastViewModel from "@arcgis/core/widgets/ShadowCast/ShadowCastViewModel";
Class: esri/widgets/ShadowCast/ShadowCastViewModel
Inheritance: ShadowCastViewModel Accessor
Since: ArcGIS API for JavaScript 4.21

Provides the logic for the ShadowCast widget.

See also

Constructors

new ShadowCastViewModel(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
Date

The calendar date used to calculate the shadow cast.

more details
ShadowCastViewModel
String

The name of the class.

more details
Accessor
Accessor

The configuration used when the widget's visualizationType is set to "discrete".

more details
ShadowCastViewModel
Accessor

The configuration used when the widget's visualizationType is set to "duration".

more details
ShadowCastViewModel
Number

Time (in milliseconds from midnight of the date) when the shadow cast computation should stop.

more details
ShadowCastViewModel
Number

Time (in milliseconds from midnight of the date) when the shadow cast computation should start.

more details
ShadowCastViewModel
String

The current state of the view model that can be used for rendering the UI of the widget.

more details
ShadowCastViewModel
Accessor

The configuration used when the widget's visualizationType is set to "threshold".

more details
ShadowCastViewModel
Number

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

more details
ShadowCastViewModel
SceneView

A reference to the View.

more details
ShadowCastViewModel
String

Type of visualization to use when showing the shadows.

more details
ShadowCastViewModel

Property Details

date Date

The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (00:00:00) of that date in local system time. If no date is set, then it defaults to the current date in local system time.

Example
widget.viewModel.date = new Date('June 1, 2021');
declaredClass Stringreadonly inherited

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

discreteOptions Accessor

The configuration used when the widget's visualizationType is set to "discrete".

Properties
color Color
optional
Default Value:[50, 50, 50, 0.7]

Color of the shadow visualization. The opacity of the visualization is mapped to the number of overlapping shadows. No shadow corresponds to opacity 0 and maximum number of shadows corresponds to the opacity set in this color value.

interval Number
optional
Default Value:15 * 60 * 1000

Individual shadows are displayed at this time interval, starting with the startTimeOfDay. The interval is expressed in milliseconds. By default it is set to 15 minutes (15 * 60 * 1000). If set to 0, we'll use the smallest possible interval, up to a maxinum of 256 samples.

intervalOptions Collection<number>
optional

Values (in milliseconds) selectable in the UI for the interval used to display shadows.

durationOptions Accessor

The configuration used when the widget's visualizationType is set to "duration".

Properties
color Color
optional
Default Value:[50, 50, 50, 0.7]

Color of the shadow cast. The opacity is mapped to the time spent in shadow. Areas that don't receive any shadow are displayed with zero opacity and areas that receive shadows for the entire time range are displayed with the opacity specified in this property.

mode String
optional
Default Value:"continuous"

Mode in which the cumulative shadow duration should be displayed: as a continuous surface or as an hourly aggregation of values.

Possible Values:"continuous"|"hourly"

endTimeOfDay Number

Time (in milliseconds from midnight of the date) when the shadow cast computation should stop. By default the shadow cast end time is set to 4PM (16 * 3600 * 1000ms).

Default Value:16 * 3600 * 1000
startTimeOfDay Number

Time (in milliseconds from midnight of the date) when the shadow cast computation should start. By default the shadow cast start time is set to 10AM (10 * 3600 * 1000ms).

Default Value:10 * 3600 * 1000
state Stringreadonly

The current state of the view model that can be used for rendering the UI of the widget.

Value Description
disabled widget is being created
ready widget is ready

Possible Values:"disabled"|"ready"

Default Value:disabled
thresholdOptions Accessor

The configuration used when the widget's visualizationType is set to "threshold".

Properties
color Color
optional
Default Value:[255, 0 , 0, 0.7]

Color of the shadow visualization. The areas with cumulative shadow time longer than the threshold value are displayed with this color.

value Number
optional
Default Value:4 * 3600 * 1000

Time period in milliseconds. Only shadows cast for more time than this value are displayed.

minValue Number
optional
Default Value:0

The minimum time period (in milliseconds) selectable in the UI for the threshold value. The values in the widget slider are displayed in hours.

maxValue Number
optional
Default Value:8 * 3600 * 1000

The maximum time period (in milliseconds) selectable in the UI for the threshold value. The values in the widget slider are displayed in hours.

utcOffset Number

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

view SceneView

A reference to the View. This widget is only supported in a SceneView.

visualizationType String

Type of visualization to use when showing the shadows. There are 3 types of visualization:

  • "threshold" only displays areas that receive shadows for a period longer than a given threshold value
  • "duration" displays all areas that receive shadows either in a continous mode or in 1 hour time intervals
  • "discrete" mode displays individual shadows cast at a given time interval

Possible Values:"threshold"|"duration"|"discrete"

Default Value:"threshold"

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.

more details
Accessor
Number

Returns the time (in milliseconds) spent in shadow for a certain point on the screen.

more details
ShadowCastViewModel
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

Starts the widget.

more details
ShadowCastViewModel

Stops the widget.

more details
ShadowCastViewModel

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

getDuration(point){Number}

Returns the time (in milliseconds) spent in shadow for a certain point on the screen.

Parameter
point ScreenPoint

The point on the screen for which shadow cast is calculated.

Returns
Type Description
Number The time in milliseconds spent in shadow for the given screenpoint.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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");
start()

Starts the widget. While running it will automatically configure shadow accumulation.

stop()

Stops the widget.

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