VoxelVolumeStyle

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

The VolumeStyle allows you to define rendering properties that apply to the volume itself, such as vertical exaggeration and offset.

Constructors

new VoxelVolumeStyle(properties)
Parameter
properties Object
optional

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.

more details
VoxelVolumeStyle
Collection<VoxelSlice>

The collection of VoxelSlice.

more details
VoxelVolumeStyle
Number

The vertical exaggeration factor.

more details
VoxelVolumeStyle
Number

The vertical offset amount.

more details
VoxelVolumeStyle
Number

Id of the volume.

more details
VoxelVolumeStyle

Property Details

dynamicSections Collection<VoxelDynamicSection>
Since: ArcGIS API for JavaScript 4.25

The collection of VoxelDynamicSection.

Since: ArcGIS API for JavaScript 4.25

The collection of VoxelSlice.

verticalExaggeration Number

The vertical exaggeration factor.

Default Value:1
verticalOffset Number

The vertical offset amount.

Default Value:0
volumeId 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.

more details
VoxelVolumeStyle
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
VoxelVolumeStyle
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
VoxelVolumeStyle

Method Details

clone(){this}

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.

Returns
Type Description
this A deep clone of the class instance that invoked this method.
fromJSON(json){*}static

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 json parameter 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.

Parameter
json Object

A 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.

Returns
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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