Slice

1
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

PropertyAttributeType
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

readonlyProperty
analysis: SliceAnalysis

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

Read more...

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

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

Read more...

excludeGroundSurface

Property
excludeGroundSurface: boolean

Indicates whether the Ground and layers that are draped on the ground surface are excluded from the slice.

Read more...

Attribute
exclude-ground-surface
Default value
false

headingLevel

Property
headingLevel: number

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

Read more...

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.

Read more...

state

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

The view model's state.

Read more...

Attribute
state
Default value
"disabled"

tiltEnabled

Property
tiltEnabled: boolean

Enable tilting the slice shape.

Read more...

Attribute
tilt-enabled
Default value
false

Methods

MethodSignature
clear(): Promise<void>
componentOnReady(): Promise<void>
destroy(): Promise<void>
start(): Promise<void>

clear

Method
clear(): Promise<void>
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

EventType
{ name: "state" | "analysis"; }
undefined

arcgisPropertyChange

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

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