ImageAreaParameters

AMD: require(["esri/rest/support/ImageAreaParameters"], (ImageAreaParameters) => { /* code goes here */ });
ESM: import ImageAreaParameters from "@arcgis/core/rest/support/ImageAreaParameters.js";
Class: esri/rest/support/ImageAreaParameters
Inheritance: ImageAreaParameters Accessor
Since: ArcGIS Maps SDK for JavaScript 4.26

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

See also

Constructors

new ImageAreaParameters(properties)

Parameter
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The area unit used for an area calculation.

ImageAreaParameters
String

The name of the class.

Accessor
Extent|Polygon

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

ImageAreaParameters
Boolean

When true, this method calculates the 3D measurements for the area and perimeter of a given geometry on an image service.

ImageAreaParameters
String

Linear unit used for a perimeter calculation.

ImageAreaParameters
MosaicRule

Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed.

ImageAreaParameters
PixelSize

Specifies the pixel size.

ImageAreaParameters

The string value representing the type of imagery mensuration.

ImageAreaParameters

Property Details

areaUnit String

The area unit used for an area calculation.

Possible Values:"square-millimeters"|"square-centimeters"|"square-decimeters"|"square-meters"|"square-kilometers"|"square-inches"|"square-feet"|"square-yards"|"square-miles"|"square-us-feet"|"acres"|"ares"|"hectares"

Default Value:"square-meters"

declaredClass Stringreadonly inherited

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

geometry Extent|Polygon

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

is3D 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 String

Linear unit used for a perimeter calculation.

Possible Values:"millimeters"|"centimeters"|"decimeters"|"meters"|"kilometers"|"inches"|"feet"|"yards"|"miles"|"nautical-miles"|"us-feet"

Default Value:"meters"

mosaicRule MosaicRuleautocast

Since: ArcGIS Maps SDK for JavaScript 4.27 ImageAreaParameters since 4.26, mosaicRule added at 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 will be used.

pixelSize PixelSizeautocast

Since: ArcGIS Maps SDK for JavaScript 4.27 ImageAreaParameters since 4.26, pixelSize added at 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

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

ImageAreaParameters
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

ImageAreaParameters

Method Details

addHandles(handleOrHandles, groupKey)inherited

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON(json){*}static

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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}

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

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.