require(["esri/layers/support/VoxelVolumeStyle"], (VoxelVolumeStyle) => { /* code goes here */ });
import VoxelVolumeStyle from "@arcgis/core/layers/support/VoxelVolumeStyle.js";
esri/layers/support/VoxelVolumeStyle
The VolumeStyle allows you to define rendering properties that apply to the volume itself, such as vertical exaggeration and offset.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// Typical usage let volumeStyle = new VoxelVolumeStyle({ verticalExaggeration: 183677 });
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Collection<VoxelDynamicSection> | The collection of VoxelDynamicSection. | VoxelVolumeStyle | |
| Collection<VoxelSlice> | The collection of VoxelSlice. | VoxelVolumeStyle | |
| Number | The vertical exaggeration factor. | VoxelVolumeStyle | |
| Number | The vertical offset amount. | VoxelVolumeStyle | |
| Number | Id of the volume. | VoxelVolumeStyle |
Property Details
-
dynamicSections
PropertydynamicSections Collection<VoxelDynamicSection>Since: ArcGIS Maps SDK for JavaScript 4.25VoxelVolumeStyle since 4.24, dynamicSections added at 4.25. -
The collection of VoxelDynamicSection.
-
slices
Propertyslices Collection<VoxelSlice>Since: ArcGIS Maps SDK for JavaScript 4.25VoxelVolumeStyle since 4.24, slices added at 4.25. -
The collection of VoxelSlice.
-
verticalExaggeration
PropertyverticalExaggeration Number -
The vertical exaggeration factor.
- Default Value:1
-
verticalOffset
PropertyverticalOffset Number -
The vertical offset amount.
- Default Value:0
-
volumeId
PropertyvolumeId Numberreadonly -
Id of the volume. Should always be 0, as only 1 volume is currently supported.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
| this | Creates a deep clone of this object. | VoxelVolumeStyle | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | VoxelVolumeStyle | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | VoxelVolumeStyle |
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.