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

Configuration for the "discrete" 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 number of overlapping shadows. When ShadowCastAnalysis.visualizeSunlight is true, the opacity is mapped to the number of overlapping sunlight samples instead. Areas with no shadow or sunlight are displayed with zero opacity and areas with the maximum overlap 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
[50, 50, 50, 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 the corresponding number of overlapping shadows. When ShadowCastAnalysis.visualizeSunlight is true, each stop defines the corresponding number of overlapping sunlight samples instead. These are sample-count values, not duration values.
  • Colors are interpolated between adjacent stops.
  • 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.

interval

Property
Type
number

Individual shadows are displayed at this time interval, starting with the start time of day. The interval is expressed in milliseconds. If set to 0, we'll use the smallest possible interval, up to a maximum of 255 samples.

Default value
1 * 3600 * 1000

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.