import TotalDurationOptions from "@arcgis/core/analysis/ShadowCast/TotalDurationOptions.js";const TotalDurationOptions = await $arcgis.import("@arcgis/core/analysis/ShadowCast/TotalDurationOptions.js");- Inheritance
- TotalDurationOptions→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Configuration for the "total-duration" mode of the ShadowCastAnalysis.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
| readonly inherited | ||
| |
color
- 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
- 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
continuousmode, colors are interpolated between adjacent stops. - In
hourlymode, 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 to1hour use the1-hour ramp position, and in a6-hour analysis window, durations greater than5hours and up to6hours use the6-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.
mode
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
| Method | Signature | Class |
|---|---|---|
| inherited | clone(): this |
clone
- Signature
-
clone (): this
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.