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 |
---|---|---|
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
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
discreteOptions: ShadowCastViewModelDiscreteOptions
The configuration used when the widget's visualizationType is set to "discrete".
durationOptions
durationOptions: ShadowCastViewModelDurationOptions
The configuration used when the widget's visualizationType is set to "duration".
endTimeOfDay
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
headingLevel: number
Indicates the heading level to use for the titles "Time range" and "Visualization".
- Attribute
- heading-level
- Default value
- 4
hideTimeRangeSlider
hideTimeRangeSlider: boolean
- Attribute
- hide-time-range-slider
- Default value
- false
hideVisualizationOptions
hideVisualizationOptions: boolean
- Attribute
- hide-visualization-options
- Default value
- false
icon
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"
position
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
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
startTimeOfDay
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
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
thresholdOptions: ShadowCastViewModelThresholdOptions
The configuration used when the widget's visualizationType is set to "threshold".
utcOffset
utcOffset: number
The difference in hours between UTC time and the times displayed in the widget.
- Attribute
- utc-offset
visualizationType
visualizationType: "discrete" | "duration" | "threshold"
Type of visualization to use when showing the shadows.
- Attribute
- visualization-type
- Default value
- "threshold"
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
getDuration(point: __esri.Point): Promise<number> | |
start(): Promise<void> | |
stop(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
getDuration
getDuration(point: __esri.Point): Promise<number>
Parameters
Parameter | Type | Optional? |
---|---|---|
point |
- Returns
- Promise<number>
Events
Event | Type |
---|---|
{ name: "state"; } | |
undefined |