VoxelVolumeStyle | References | ArcGIS Maps SDK for JavaScript

import VoxelVolumeStyle from "@arcgis/core/layers/voxel/VoxelVolumeStyle.js";

const VoxelVolumeStyle = await $arcgis.import("@arcgis/core/layers/voxel/VoxelVolumeStyle.js");

Inheritance: VoxelVolumeStyle→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.24

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

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	VoxelVolumeStyleProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Example

// Typical usage
let volumeStyle = new VoxelVolumeStyle({
  verticalExaggeration: 183677
});

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
dynamicSections	Collection<VoxelDynamicSection>
slices	Collection<VoxelSlice>
verticalExaggeration	number
verticalOffset	number
volumeId readonly	number

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

dynamicSections

autocast Property

Type: Collection<VoxelDynamicSection>

Since: ArcGIS Maps SDK for JavaScript 4.25

The collection of VoxelDynamicSection.

slices

autocast Property

Type: Collection<VoxelSlice>

Since: ArcGIS Maps SDK for JavaScript 4.25

The collection of VoxelSlice.

verticalExaggeration

Property

Type: number

The vertical exaggeration factor.

Default value: 1

verticalOffset

Property

Type: number

The vertical offset amount.

Default value: 0

volumeId

readonly Property

Type: number

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

Default value: 0

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): VoxelVolumeStyle
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): VoxelVolumeStyle

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: VoxelVolumeStyle
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.