Slice

The SliceAnalysis created or modified by the component.

When connecting the Slice component to the Scene component, it automatically creates an empty analysis and adds it to the Scene's analyses collection. Whenever the component is destroyed, the analysis is automatically removed from the collection.

Alternatively, a programmatically created analysis can be provided to the component. Then, the application itself needs to add it to and later remove it from the Scene's analyses collection.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Create the analysis.
const sliceAnalysis = new SliceAnalysis({
   shape: new SlicePlane({
     position: new Point({
       spatialReference: { latestWkid: 3857, wkid: 102100 },
       x: -13624925.727820931,
       y: 4550341.695170021,
       z: 56
     }),
     tilt: 270,
     width: 310,
     height: 190,
     heading: 45
   })
});
// Get the Scene and Slice component and wait until they are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const slice = document.querySelector("arcgis-slice");
await slice.componentOnReady();
// Add the analysis to the Scene component.
viewElement.analyses.add(sliceAnalysis);
// Connect the analysis to the slice component:
slice.analysis = sliceAnalysis;

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

Add layers to this collection to exclude them from the slice. Layers that are draped on the ground surface are not affected by this property

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

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

Attribute

heading-level

Default value

3

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"slice"

The component's default label.

Attribute

label

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

Attribute

position

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

Attribute

reference-element

The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.

Examples

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Create a slice plane programmatically.
const shape = new SlicePlane({
  position: new Point({
     spatialReference: { latestWkid: 3857, wkid: 102100 },
     x: -13624925.727820931,
     y: 4550341.695170021,
     z: 56
  }),
  tilt: 270,
  width: 310,
  height: 190,
  heading: 45
});
// Apply the new shape to the slice component's shape.
slice.shape = shape;

1
2
3
4
5
6
7
// Clone the shape to modify its properties.
const shape = slice.shape.clone();
// Set new values for heading and tilt.
shape.heading = 180;
shape.tilt = 45;
// Apply the new shape to the slice component's shape.
slice.shape = shape;

The component's state. The values mean the following:

• disabled - not ready yet
• excludingLayer - currently excluding a layer from the slice
• ready - ready for slicing
• slicing - currently slicing
• sliced - finished slicing and a valid shape is available

Attribute

state

Enable tilting the slice shape. If set to true, the slice shape will orient itself as best as possible to the surface under the cursor when first placing the shape. If set to false, the slice shape is restricted to be either horizontal or vertical.

Attribute

tilt-enabled

Default value

false

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Slice component will be associated with a map or scene component rather than using the view property.

Clear the shape of the slice, effectively removing it from the view. Other properties like excludedLayers and excludeGroundSurface are not modified. Calling this method changes the state to ready.

Returns

Promise<void>

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
const arcgisSlice = document.querySelector("arcgis-slice");
document.body.append(arcgisSlice);
await arcgisSlice.componentOnReady();
console.log("arcgis-slice is ready to go!");

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

Start the interactive placement of a new slice, clearing the previous shape. Calling this method changes the state to slicing.

Returns

Promise<void>

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

Emitted when the component associated with a map or scene view is ready to be interacted with.