VoxelVolumeStyle | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

Constructors

VoxelVolumeStyle Constructor 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

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 Property dynamicSections Collection<VoxelDynamicSection> Since: ArcGIS Maps SDK for JavaScript 4.25 VoxelVolumeStyle since 4.24, dynamicSections added at 4.25.

The collection of VoxelDynamicSection.

slices Property slices Collection<VoxelSlice> Since: ArcGIS Maps SDK for JavaScript 4.25 VoxelVolumeStyle since 4.24, slices added at 4.25.

The collection of VoxelSlice.

verticalExaggeration Property verticalExaggeration Number

The vertical exaggeration factor.

Default Value:1

verticalOffset Property verticalOffset Number

The vertical offset amount.

Default Value:0

volumeId Property volumeId Numberreadonly

Id of the volume. Should always be 0, as only 1 volume is currently supported.

Method Overview

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

clone Method 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 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 Method 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.