import "@arcgis/map-components/components/arcgis-slice";
Slice component is a 3D analysis tool that can be used to reveal occluded content in a SceneView.
Demo
Properties
Property | Attribute | Type |
---|---|---|
analysis readonly |
| |
auto-destroy-disabled | boolean | |
| ||
exclude-ground-surface | boolean | |
heading-level | number | |
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 | |
| ||
state readonly | state | "disabled" | "ready" | "sliced" | "slicing" |
tilt-enabled | boolean |
analysis
analysis: SliceAnalysis
The slice analysis object being created or modified by the widget.
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
excludedLayers
excludedLayers: Collection<Layer | BuildingComponentSublayer>
Add layers to this collection to exclude them from the slice.
excludeGroundSurface
excludeGroundSurface: boolean
Indicates whether the Ground and layers that are draped on the ground surface are excluded from the slice.
- Attribute
- exclude-ground-surface
- Default value
- false
headingLevel
headingLevel: number
Indicates the heading level to use for the "Excluded layers" heading.
- Attribute
- heading-level
- Default value
- 3
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
- "slice"
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
state
state: "disabled" | "ready" | "sliced" | "slicing"
The view model's state.
- Attribute
- state
- Default value
- "disabled"
tiltEnabled
tiltEnabled: boolean
Enable tilting the slice shape.
- Attribute
- tilt-enabled
- Default value
- false
Methods
Method | Signature |
---|---|
clear(): Promise<void> | |
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
start(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "state" | "analysis"; } | |
undefined |