arcgis-slice

The SliceAnalysis created or modified by the component.

When connecting the Slice component to the arcgis-scene component, it automatically creates an empty analysis and adds it to the Scene's arcgis-scene.analyses collection. You can then wait for the SliceAnalysisView3D to be created before interacting with the slice or reading the current slice parameters.

// Get the Scene component and the Slice component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const sliceElement = document.querySelector("arcgis-slice");
await sliceElement.componentOnReady();

// Get the SliceAnalysis created by the Slice component.
const analysis = sliceElement.analysis;

// Get the SliceAnalysisView3D and watch for changes.
const analysisView = await viewElement.whenAnalysisView(analysis);
const handle = reactiveUtils.watch(
  () => analysis.shape,
  () => {
    console.log("Slice active:", analysisView.active);
    console.log("Slice interactive:", analysisView.interactive);
    console.log("Slice shape:", analysis.shape);
  },
);

Whenever the component is destroyed, the analysis is automatically removed from the collection.

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

// Create the SliceAnalysis.
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 component and the Slice component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const sliceElement = document.querySelector("arcgis-slice");
await sliceElement.componentOnReady();

// Add the analysis to the analyses collection of the Scene component.
viewElement.analyses.add(sliceAnalysis);

// Connect the analysis to the slice component:
sliceElement.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.

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.

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

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the button that starts a new slice will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the component's visualization is hidden in the view.

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

The component's default label.

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

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

Since

ArcGIS Maps SDK for JavaScript 4.28

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

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

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.

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 arcgis-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.

Creates a promise that resolves once the component is fully loaded.

Permanently destroy the component.

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