Shadow Cast

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-shadow-cast";

ShadowCast component displays the cumulative shadows of 3D features in a SceneView.

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`discreteOptions`		`ShadowCastViewModelDiscreteOptions`
`durationOptions`		`ShadowCastViewModelDurationOptions`
`endTimeOfDay`	`end-time-of-day`	`number`
`headingLevel`	`heading-level`	`number`
`hideColorPicker`	`hide-color-picker`	`boolean`
`hideDatePicker`	`hide-date-picker`	`boolean`
`hideTimeRangeSlider`	`hide-time-range-slider`	`boolean`
`hideTimezone`	`hide-timezone`	`boolean`
`hideTooltip`	`hide-tooltip`	`boolean`
`hideVisualizationOptions`	`hide-visualization-options`	`boolean`
`icon`	`icon`	`string`
`label`	`label`	`string`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`startTimeOfDay`	`start-time-of-day`	`number`
`state` readonly	`state`	`"disabled" \| "ready"`
`thresholdOptions`		`ShadowCastViewModelThresholdOptions`
`utcOffset`	`utc-offset`	`number`
`visualizationType`	`visualization-type`	`"discrete" \| "duration" \| "threshold"`

autoDestroyDisabled

Property

autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute: auto-destroy-disabled
Default value: false

discreteOptions

Property

discreteOptions: ShadowCastViewModelDiscreteOptions

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

durationOptions

Property

durationOptions: ShadowCastViewModelDurationOptions

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

endTimeOfDay

Property

endTimeOfDay: number

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

Attribute: end-time-of-day
Default value: 16 * 3600 * 1000

headingLevel

Property

headingLevel: number

Indicates the heading level to use for the titles "Time range" and "Visualization".

Attribute: heading-level
Default value: 4

hideColorPicker

Property

hideColorPicker: boolean

Attribute: hide-color-picker
Default value: false

hideDatePicker

Property

hideDatePicker: boolean

Attribute: hide-date-picker
Default value: false

hideTimeRangeSlider

Property

hideTimeRangeSlider: boolean

Attribute: hide-time-range-slider
Default value: false

hideTimezone

Property

hideTimezone: boolean

Attribute: hide-timezone
Default value: false

hideTooltip

Property

hideTooltip: boolean

Attribute: hide-tooltip
Default value: false

hideVisualizationOptions

Property

hideVisualizationOptions: boolean

Attribute: hide-visualization-options
Default value: false

icon

Property

icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute: icon
Default value: "measure-building-height-shadow"

label

Property

label: string

The component's default label.

Attribute: label

position

Property

position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"

Attribute: position
Default value: "bottom-left"

referenceElement

Property

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

startTimeOfDay

Property

startTimeOfDay: number

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

Attribute: start-time-of-day
Default value: 10 * 3600 * 1000

state

readonly

Property

state: "disabled" | "ready"

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

Attribute: state
Default value: "disabled"

thresholdOptions

Property

thresholdOptions: ShadowCastViewModelThresholdOptions

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

utcOffset

Property

utcOffset: number

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

Attribute: utc-offset

visualizationType

Property

visualizationType: "discrete" | "duration" | "threshold"

Type of visualization to use when showing the shadows.

Attribute: visualization-type
Default value: "threshold"

Methods

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`getDuration`	`getDuration(point: __esri.Point): Promise<number>`
`start`	`start(): Promise<void>`
`stop`	`stop(): Promise<void>`

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

getDuration

Method

getDuration(point: __esri.Point): Promise<number>

Parameters

Parameter	Type	Optional?
point	`Point`

Returns: Promise<number>

start

Method

start(): Promise<void>

Returns: Promise<void>

stop

Method

stop(): Promise<void>

Stops the component.

Returns: Promise<void>

Events

Event	Type
`arcgisPropertyChange`	`{ name: "state"; }`
`arcgisReady`	`undefined`

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "state"; }

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: undefined

Emitted when the component associated with a map view is is ready to be interacted with.