Slice

Use dark colors for code blocksCopy
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		`SliceAnalysis`
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`excludedLayers`		`Collection<Layer \| BuildingComponentSublayer>`
`excludeGroundSurface`	`exclude-ground-surface`	`boolean`
`headingLevel`	`heading-level`	`number`
`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`
`shape`		`SlicePlane`
`state` readonly	`state`	`"disabled" \| "ready" \| "sliced" \| "slicing"`
`tiltEnabled`	`tilt-enabled`	`boolean`

analysis

readonlyProperty

analysis: SliceAnalysis

The slice analysis object being created or modified by the widget.

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

excludedLayers

Property

excludedLayers: Collection<Layer | BuildingComponentSublayer>

Add layers to this collection to exclude them from the slice.

excludeGroundSurface

Property

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

Property

headingLevel: number

Indicates the heading level to use for the "Excluded layers" heading.

Attribute: heading-level
Default value: 3

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: "slice"

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

shape

Property

shape: SlicePlane

The shape used to slice elements in a 3D scene.

state

readonly

Property

state: "disabled" | "ready" | "sliced" | "slicing"

The view model's state.

Attribute: state
Default value: "disabled"

tiltEnabled

Property

tiltEnabled: boolean

Enable tilting the slice shape.

Attribute: tilt-enabled
Default value: false

Methods

Method	Signature
`clear`	`clear(): Promise<void>`
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`start`	`start(): Promise<void>`

clear

Method

clear(): Promise<void>

Clears the component.

Returns: 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>

start

Method

start(): Promise<void>

Returns: Promise<void>

Events

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

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "state" | "analysis"; }

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.