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
Datemore details

The calendar date used to calculate the shadow cast.

more detailsShadowCastViewModel
Stringmore details

The name of the class.

more detailsAccessor
Accessormore details

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

more detailsShadowCastViewModel
Accessormore details

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

more detailsShadowCastViewModel
Numbermore details

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

more detailsShadowCastViewModel
Numbermore details

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

more detailsShadowCastViewModel
Stringmore details

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

more detailsShadowCastViewModel
Accessormore details

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

more detailsShadowCastViewModel
Numbermore details

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

more detailsShadowCastViewModel
SceneViewmore details

A reference to the View.

more detailsShadowCastViewModel
Stringmore details

Type of visualization to use when showing the shadows.

more detailsShadowCastViewModel

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

Name Return Type Summary Class
Numbermore details

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

more detailsShadowCastViewModel
more details

Starts the widget.

more detailsShadowCastViewModel
more details

Stops the widget.

more detailsShadowCastViewModel

Method Details

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