ImageAreaParameters | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ImageAreaParameters→BaseImageMeasureParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.26

Input parameters used by the ImageryLayer.measureAreaAndPerimeter() and measureAreaAndPerimeter() methods to perform imagery area and perimeter mensuration.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ImageAreaParametersProperties`

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
`areaUnit`	`Exclude<AreaUnit, "square-nautical-miles">`
`declaredClass` readonly inherited	`string`	Accessor
`geometry`	`Extent \| Polygon`
`is3D`	`boolean`
`linearUnit`	`LengthUnit`
`mosaicRule` inherited	`MosaicRule \| null \| undefined`	BaseImageMeasureParameters
`pixelSize` inherited	`Point`	BaseImageMeasureParameters
`type` readonly	`"area-perimeter"`

areaUnit

Property

Type: Exclude<AreaUnit, "square-nautical-miles">

The area unit used for an area calculation.

Default value: "square-meters"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

geometry

autocast Property

Type: Extent | Polygon

The extent or polygon geometry used to perform the area and perimeter measurement.

is3D

Property

Type: boolean

When true, this method calculates the 3D measurements for the area and perimeter of a given geometry on an image service. The elevation surface will be incorporated when performing the calculations. 3D calculation can only be done when the layer's capabilities.mensuration.supports3D returns true.

Default value: false

linearUnit

Property

Type: LengthUnit

Linear unit used for a perimeter calculation.

Default value: "meters"

mosaicRule

autocast inherited Property

Type: MosaicRule | null | undefined

Inherited from: BaseImageMeasureParameters

Since: ArcGIS Maps SDK for JavaScript 4.27

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 inherited Property

Type: Point

Inherited from: BaseImageMeasureParameters

Since: ArcGIS Maps SDK for JavaScript 4.27

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 Measure calculation.

type

readonly Property

Type: "area-perimeter"

The string value representing the type of imagery mensuration. The type is always area-perimeter for ImageAreaParameters.

Methods

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

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.