SliceAnalysis

AMD: require(["esri/analysis/SliceAnalysis"], (SliceAnalysis) => { /* code goes here */ });
ESM: import SliceAnalysis from "@arcgis/core/analysis/SliceAnalysis";
Class: esri/analysis/SliceAnalysis
Inheritance: SliceAnalysis Accessor
Since: ArcGIS API for JavaScript 4.23

SliceAnalysis can be used to programmatically create a plane that slices through 3D features in a 3D SceneView. A slice takes a SlicePlane as an input, which can be set through the shape property. If the shape has a tilt angle other than 0, the angle is only considered if the tiltEnabled property is set to true.

const analysis = new SliceAnalysis({
  shape: {
    type: "plane", // autocasts as new SlicePlane()
    position: {
      type: "point",
      x: -0.1,
      y: 51.5
    },
    width: 50,
    height: 50,
    tilt: 45
  },
  tiltEnabled: true
});

view.analyses.add(slice);

SceneView.analyses can contain multiple slice analyses, but only one of these analyses can be active at a time. When working with multiple slices, set the active property of a slice view to true to occlude the parts of the 3D features that are in front of the slice plane. When a slice view is activated, all other slice views are automatically deactivated.

view.whenAnalysisView(slice).then((sliceView) => {
  sliceView.active = true;
});

To place the slice interactively in the view using positioning, scaling and rotation handles, it is recommended to use the Slice widget.

See also:

Constructors

new SliceAnalysis(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
SlicePlanemore details

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

more detailsSliceAnalysis
Stringmore details For SliceAnalysis the type is always "slice". more detailsSliceAnalysis

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

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

type Stringreadonly

For SliceAnalysis the type is always "slice".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsSliceAnalysis
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor

Method Details

clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns:
Type Description
this A deep clone of the class instance that invoked this method.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.