VoxelVolume

AMD: require(["esri/layers/voxel/VoxelVolume"], (VoxelVolume) => { /* code goes here */ });
ESM: import VoxelVolume from "@arcgis/core/layers/voxel/VoxelVolume";
Object: esri/layers/voxel/VoxelVolume
Since: ArcGIS API for JavaScript 4.25

The VoxelVolume exposes properties that describe the volume and methods to convert to and from voxel space.

Property Overview

Name Type Summary Object
Number

The unique identifier for the volume.

more details
VoxelVolume
Number[]

A 3-component array containing the volume size in voxels.

more details
VoxelVolume
String

Returns the type of the current variable's volume.

more details
VoxelVolume

Property Details

id Numberreadonly

The unique identifier for the volume.

sizeInVoxels Number[]

A 3-component array containing the volume size in voxels. For XYZ and XYZT volumes the returned values are [x, y, z]. For XYT volumes the returned values are [x, y, t] where t represents the number of times in the volume which are represented along the z dimension.

volumeType String

Returns the type of the current variable's volume.

Possible Values:"xyz"|"xyzt"|"xyt"

Method Overview

Name Return Type Summary Object
Point

Convert a position in voxel space to the spatialReference of the layer.

more details
VoxelVolume
Number[]

Convert a position from the layer's spatialReference to voxel space for XYZ or XYZT volumes.

more details
VoxelVolume

Method Details

computeLayerSpaceLocation(posInVoxelSpace){Point}

Convert a position in voxel space to the spatialReference of the layer.

Parameter
posInVoxelSpace Number[]

The voxel space position to convert to layer space as as [x, y, z].

Returns
Type Description
Point Returns a point in the layer's spatial reference. For XYT volumes returns an XY point and for XYZ and XYZT volumes returns an XYZ point.
computeVoxelSpaceLocation(pos){Number[]}

Convert a position from the layer's spatialReference to voxel space for XYZ or XYZT volumes.

Parameter
pos Point

The XYZ position in the voxel layer spatial reference to convert to voxel space.

Returns
Type Description
Number[] Returns a 3-component array containing the position in voxel space as [x, y, z].

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