Shadow Cast

1
import "@arcgis/map-components/components/arcgis-shadow-cast";

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

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
ShadowCastViewModelDiscreteOptions
ShadowCastViewModelDurationOptions
end-time-of-day
number
heading-level
number
hide-color-picker
boolean
hide-date-picker
boolean
hide-time-range-slider
boolean
hide-timezone
boolean
hide-tooltip
boolean
hide-visualization-options
boolean
icon
string
label
string
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
start-time-of-day
number
state
readonly
state
"disabled" | "ready"
ShadowCastViewModelThresholdOptions
utc-offset
number
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".

Read more...

durationOptions

Property
durationOptions: ShadowCastViewModelDurationOptions

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

Read more...

endTimeOfDay

Property
endTimeOfDay: number

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

Read more...

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

Read more...

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.

Read more...

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.

Read more...

Attribute
state
Default value
"disabled"

thresholdOptions

Property
thresholdOptions: ShadowCastViewModelThresholdOptions

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

Read more...

utcOffset

Property
utcOffset: number

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

Read more...

Attribute
utc-offset

visualizationType

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

Type of visualization to use when showing the shadows.

Read more...

Attribute
visualization-type
Default value
"threshold"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>
getDuration(point: __esri.Point): Promise<number>
start(): Promise<void>
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
ParameterTypeOptional?
point
Returns
Promise<number>

start

Method
start(): Promise<void>
Returns
Promise<void>

stop

Method
stop(): Promise<void>
Returns
Promise<void>

Events

EventType
{ name: "state"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "state"; }

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

arcgisReady

Event
arcgisReady: undefined

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close