import TotalDurationOptions from "@arcgis/core/analysis/ShadowCast/TotalDurationOptions.js";
Inheritance
TotalDurationOptionsAccessor
Since
ArcGIS Maps SDK for JavaScript 5.0

Configuration for the "total-duration" mode of the ShadowCastAnalysis.

See also

Constructors

Constructor

Constructor

Parameters

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

color

autocast Property
Type
Color

Defines the color used by the default color ramp for the visualization. The opacity is mapped to the time spent in shadow. When ShadowCastAnalysis.visualizeSunlight is true, the opacity is mapped to the time spent in sunlight instead. Areas that don't receive any shadow or sunlight are displayed with zero opacity and areas that receive shadow or sunlight for the entire time range are displayed with the opacity specified in this color.

When colorStops is not specified, the visualization uses a default ramp between transparent and this color. When specified, those stops are used instead.

Default value
[0, 0, 255, 0.7]

colorStops

autocast Property
Type
ColorStop[] | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.1

The color stops for the visualization.

  • Each stop defines a color and a duration value in milliseconds. The value represents shadow duration by default and sunlight duration when ShadowCastAnalysis.visualizeSunlight is true.
  • In continuous mode, colors are interpolated between adjacent stops.
  • In hourly mode, the displayed shadow or sunlight duration is snapped to the end of its hourly bucket before the color ramp is evaluated. For example, durations up to 1 hour use the 1-hour ramp position, and in a 6-hour analysis window, durations greater than 5 hours and up to 6 hours use the 6-hour ramp position.
  • If omitted, the visualization uses a default ramp between transparent and color. If specified, these stops are used.

Known Limitations

In a 3D SceneView, a maximum of 8 color stops is supported.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

mode

Property
Type
ShadowCastTotalDurationMode

Determines how cumulative shadow or sunlight duration is visualized. Use continuous to display an interpolated duration surface across the selected time range. Use hourly to snap values to hourly boundaries before applying the color ramp at the end of each represented hour.

Default value
"continuous"

Methods

MethodSignatureClass
inherited
clone(): this

clone

inherited Method
Signature
clone (): this
Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns
this

A deep clone of the class instance that invoked this method.