VoxelSlice | References | ArcGIS Maps SDK for JavaScript

import VoxelSlice from "@arcgis/core/layers/voxel/VoxelSlice.js";

Inheritance:: VoxelSlice→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.25

The VoxelSlice allows you to define the properties of an individual slice. Slices clip the volume along an infinite plane to yield a convex shell that is rendered. Updates to the position, orientation and tilt of a slice are rendered in real-time.

See also

Sample - Create area of interest for VoxelLayer

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`VoxelSliceProperties`

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

Example

// Typical usage
let slice = new VoxelSlice({
  orientation: 270,
  tilt: 90,
  point: [128, 64, 89]
});

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`enabled`	`boolean`
`label`	`string`
`orientation`	`number`
`point`	`[ number, number, number ]`
`tilt`	`number`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

enabled

Property

Type: boolean

Whether or not the slice is enabled.

Default value: true

label

Property

Type: string

The label for the slice.

Default value: ""

orientation

Property

Type: number

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

point

Property

Type: [ number, number, number ]

A point on the slice plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes.

tilt

Property

Type: number

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

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.