require(["esri/layers/voxel/VoxelVolume"], (VoxelVolume) => { /* code goes here */ });
import VoxelVolume from "@arcgis/core/layers/voxel/VoxelVolume.js";
esri/layers/voxel/VoxelVolume
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.
-
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.
ParameterThe voxel space position to convert to layer space as as [x, y, z].
ReturnsType 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.
-
Convert a position from the layer's spatialReference to voxel space for XYZ or XYZT volumes.
Parameterpos PointThe XYZ position in the voxel layer spatial reference to convert to voxel space.
ReturnsType Description Number[] Returns a 3-component array containing the position in voxel space as [x, y, z].