ImageVolumeParameters | References | ArcGIS Maps SDK for JavaScript

import ImageVolumeParameters from "@arcgis/core/rest/support/ImageVolumeParameters.js";

Inheritance:: ImageVolumeParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.32

Input parameters for the ImageryLayer.calculateVolume() method on ImageryLayer.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ImageVolumeParametersProperties`

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.

Property	Type	Class
`baseType`	`BaseType`
`constantZ`	`number \| null`
`declaredClass` readonly inherited	`string`	Accessor
`geometries`	`Polygon[] \| Extent[]`
`mosaicRule`	`MosaicRule \| null \| undefined`
`pixelSize`	`Point \| null \| undefined`

baseType

Property

Type: BaseType

Surface type of the base elevation plane. The value for each base elevation plane described in the following table:

Type	Description
constant	A user defined value that defines the constant z-value for the base surface.
plane	Best fitting plane.
minimum	The lowest elevation on the perimeter of the geometries.
maximum	The highest elevation on the perimeter of the geometries.
average	The average elevation on the perimeter of the geometries.

Default value: "plane"

constantZ

Property

Type: number | null

Constant Z value.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

geometries

autocast Property

Type: Polygon[] | Extent[]

An array of geometries containing extents or polygons.

mosaicRule

autocast Property

Type: MosaicRule | null | undefined

Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed. When a mosaic rule is not specified, the current settings on the ImageryLayer.mosaicRule will be used.

pixelSize

autocast Property

Type: Point | null | undefined

Specifies the pixel size. If pixel size is not specified, pixelSize will default to the base resolution of the image service. The raster at the specified pixel size in the mosaic dataset will be used for the volume calculation.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`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

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
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.

Type definitions

BaseType

Type definition

Surface type of the base elevation plane. The value for each base elevation plane described in the following table:

Type	Description
constant	A user defined value that defines the constant z-value for the base surface.
plane	Best fitting plane.
minimum	The lowest elevation on the perimeter of the geometries.
maximum	The highest elevation on the perimeter of the geometries.
average	The average elevation on the perimeter of the geometries.

See also

baseType

Type: "constant" | "plane" | "minimum" | "maximum" | "average"