require(["esri/layers/voxel/VoxelDynamicSection"], (VoxelDynamicSection) => { /* code goes here */ });
import VoxelDynamicSection from "@arcgis/core/layers/voxel/VoxelDynamicSection.js";
esri/layers/voxel/VoxelDynamicSection
The VoxelDynamicSection allows you to define the properties of an individual dynamic section. Dynamic sections define an opaque plane inside of the volume which draws when the renderMode is set to surfaces. They are not tied to a particular VoxelVariable, and their position and orientation can be modified with real-time rendering updates.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// Typical usage let dynSec = new VoxelDynamicSection({ orientation: 270, tilt: 90, point: [128, 64, 89] });
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Boolean | Whether or not the dynamic section is enabled. | VoxelDynamicSection | |
| String | The label for the dynamic section. | VoxelDynamicSection | |
| Number | The orientation angle (in the degrees) of the dynamic section plane. | VoxelDynamicSection | |
| Number[] | A point on the dynamic section plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes. | VoxelDynamicSection | |
| Number | The tilt angle (in degrees) of the dynamic section plane. | VoxelDynamicSection |
Property Details
-
enabled
Propertyenabled Boolean -
Whether or not the dynamic section is enabled.
-
label
Propertylabel String -
The label for the dynamic section.
-
orientation
Propertyorientation Number -
The orientation angle (in the degrees) of the dynamic section plane.
-
A point on the dynamic section plane specified as [x ,y, z] in voxel space for XYZ and XYZT volumes and as [x, y, t] for XYT volumes.
-
tilt
Propertytilt Number -
The tilt angle (in degrees) of the dynamic section plane.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
| this | Creates a deep clone of this object. | VoxelDynamicSection | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | VoxelDynamicSection | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | VoxelDynamicSection |
Method Details
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.