SlicePlane | References | ArcGIS Maps SDK for JavaScript

import SlicePlane from "@arcgis/core/analysis/SlicePlane.js";

Inheritance:: SlicePlane→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.23

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

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

const sliceAnalysis = new SliceAnalysis({
  shape: new SlicePlane({
    position: new Point({ x: -0.1, y: 51.5 }),
    width: 50,
    height: 50,
    tilt: 45
  }),
  tiltEnabled: true
});

view.analyses.add(sliceAnalysis);

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SlicePlaneProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`heading`	`number`
`height`	`number`
`position`	`Point \| null \| undefined`
`tilt`	`number`
`type` readonly	`"plane"`
`width`	`number`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

heading

Property

Type: number

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

Default value: 0

height

Property

Type: number

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

Default value: 10

position

autocast Property

Type: Point | null | undefined

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

tilt

Property

Type: number

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

Default value: 0

type

readonly Property

Type: "plane"

The string value representing the type of the slice shape.

width

Property

Type: number

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

Default value: 10

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.