Skip to content
import ImageVolume from "@arcgis/core/rest/support/ImageVolume.js";
Inheritance:
ImageVolumeAccessor
Since
ArcGIS Maps SDK for JavaScript 4.32

The ImageryLayer.calculateVolume() method on ImageryLayer returns ImageVolumeResult containing array of this class.

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.

area

Property
Type
number

Area of the surface. Unit is square meters.

cut

Property
Type
number

The cut volume. Unit is cubic meters.

cutCellCount

Property
Type
number | null | undefined

Cut cell count.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

fill

Property
Type
number

The fill volume (negative). Unit is cubic meters.

fillCellCount

Property
Type
number | null | undefined

Fill cell count.

maxZ

Property
Type
number

Maximum z of the surface perimeter. Unit is meter.

meanZ

Property
Type
number

Average z of the surface perimeter. Unit is meter.

minZ

Property
Type
number

Minimum z of the surface perimeter. Unit is meter.

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.