SlicePlane

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

Provides the shape definition of a slice plane for a Slice widget or SliceAnalysis. The slice plane is defined by a position, heading and tilt. Its size is defined by width and height.

slice-plane

When working with the Slice widget, the plane can be set or retrieved from the shape property of the SliceViewModel:

let sliceWidget = new Slice({
  view: view
});
sliceWidget.viewModel.shape = new SlicePlane({
  position: new Point({
    latitude: 34.06007911204149,
    longitude: -117.1867758409791,
    z: 416.852
  }),
  // a 30 degree angle between the slice plane and the ground plane
  tilt: 30,
  width: 32,
  height: 32,
  // the height axis of the plane is oriented north
  heading: 0
});
sliceWidget.viewModel.start();
view.ui.add(sliceWidget, "top-right");

When working with a SliceAnalysis, the plane can be set or retrieved from the shape property of the analysis.

See also:

Constructors

new SlicePlane(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
Numbermore details

The heading angle (in degrees) of the slice plane.

more detailsSlicePlane
Numbermore details

The height of the slice plane.

more detailsSlicePlane
Pointmore details

A point specifying the position of the center of the plane.

more detailsSlicePlane
Numbermore details

The tilt angle (in degrees) of the slice plane.

more detailsSlicePlane
Stringmore details

The string value representing the type of the slice shape.

more detailsSlicePlane
Numbermore details

The width of the slice plane.

more detailsSlicePlane

Property Details

declaredClass Stringreadonly inherited

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

heading Number

The heading angle (in degrees) of the slice plane.

Default Value:0
height Number

The height of the slice plane. The unit is derived from the SpatialReference of the position.

Default Value:10
position Pointautocast

A point specifying the position of the center of the plane.

tilt Number

The tilt angle (in degrees) of the slice plane.

Default Value:0
type Stringreadonly

The string value representing the type of the slice shape.

For SlicePlane the type is always "plane".

width Number

The width of the slice plane. The unit is derived from the SpatialReference of the position.

Default Value:10

Method Overview

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

Creates a deep clone of this object.

more detailsSlicePlane
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsSlicePlane
more details

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

more detailsAccessor
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsSlicePlane

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.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
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.

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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