Skip to content
import VoxelVariable from "@arcgis/core/layers/voxel/VoxelVariable.js";
Inheritance:
VoxelVariableAccessor
Since
ArcGIS Maps SDK for JavaScript 4.24

Describes a single variable in the VoxelLayer.

See also

Constructors

Constructor

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
declaredClass
readonly inherited
description
readonly
id
readonly
name
readonly
renderingFormat
readonly
unit
readonly
volumeId
readonly

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

description

readonly Property
Type
string

The original data source description of the variable.

Default value
""

id

readonly Property
Type
number

The unique identifier for the variable.

name

readonly Property
Type
string

The original data source name of the variable.

renderingFormat

readonly Property
Type
VoxelFormat

A description of various properties of the variable as it is represented on the GPU.

unit

readonly Property
Type
string

The variable units.

Default value
""

volumeId

readonly Property
Type
number

The volumeId of the variable. Currently always 0.

Default value
0

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
toJSON
inherited
toJSON(): any

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

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.