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 |
|---|---|---|---|
The unique identifier for the volume. | VoxelVolume | ||
A 3-component array containing the volume size in voxels. | VoxelVolume | ||
Returns the type of the current variable's volume. | VoxelVolume |
Property Details
-
id
Propertyid 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
PropertyvolumeType String -
Returns the type of the current variable's volume.
Possible Values:"xyz" |"xyzt" |"xyt"
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Convert a position in voxel space to the spatialReference of the layer. | VoxelVolume | ||
Convert a position from the layer's spatialReference to voxel space for XYZ or XYZT volumes. | VoxelVolume |
Method Details
-
computeLayerSpaceLocation
MethodcomputeLayerSpaceLocation(posInVoxelSpace){Point} -
Convert a position in voxel space to the spatialReference of the layer.
ParameterReturnsType 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.
Returns