VoxelSlice

AMD: require(["esri/layers/voxel/VoxelSlice"], (VoxelSlice) => { /* code goes here */ });
ESM: import VoxelSlice from "@arcgis/core/layers/voxel/VoxelSlice";
Class: esri/layers/voxel/VoxelSlice
Since: ArcGIS API 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.

Constructors

new VoxelSlice(properties)
Parameter
properties Object
optional

See the properties 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]
});

Property Overview

Name Type Summary Class
Boolean

Whether or not the slice is enabled.

more details
VoxelSlice
String

The label for the slice.

more details
VoxelSlice
Number

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

more details
VoxelSlice
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.

more details
VoxelSlice
Number

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

more details
VoxelSlice

Property Details

enabled Boolean

Whether or not the slice is enabled.

label String

The label for the slice.

orientation Number

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

point 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 Number

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

Method Overview

Name Return Type Summary Class
this

Creates a deep clone of this object.

more details
VoxelSlice
*

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

more details
VoxelSlice
Object

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

more details
VoxelSlice

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