require(["esri/rest/support/ImageAreaParameters"], (ImageAreaParameters) => { /* code goes here */ });
import ImageAreaParameters from "@arcgis/core/rest/support/ImageAreaParameters.js";
esri/rest/support/ImageAreaParameters
Input parameters used by the ImageryLayer.measureAreaAndPerimeter() and imageService.measureAreaAndPerimeter() methods to perform imagery area and perimeter mensuration.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The area unit used for an area calculation. | ImageAreaParameters | ||
The name of the class. | Accessor | ||
The extent or polygon geometry used to perform the area and perimeter measurement. | ImageAreaParameters | ||
When | ImageAreaParameters | ||
Linear unit used for a perimeter calculation. | ImageAreaParameters | ||
Specifies the mosaic rule on how individual images should be mosaicked when the measure is computed. | ImageAreaParameters | ||
Specifies the pixel size. | ImageAreaParameters | ||
The string value representing the type of imagery mensuration. | ImageAreaParameters |
Property Details
-
areaUnit
PropertyareaUnit 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"
-
The extent or polygon geometry used to perform the area and perimeter measurement.
-
is3D
Propertyis3D 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 returnstrue.- Default Value:false
-
linearUnit
PropertylinearUnit LengthUnit |String -
Linear unit used for a perimeter calculation.
Possible Values:"decimal-degrees" |"points" |"unknown"
- Default Value:"meters"
-
mosaicRule
PropertymosaicRule MosaicRuleautocastSince: ArcGIS Maps SDK for JavaScript 4.27ImageAreaParameters 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.27ImageAreaParameters since 4.26, pixelSize added at 4.27. -
Specifies the pixel size. If pixel size is not specified,
pixelSizewill 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
Propertytype Stringreadonly -
The string value representing the type of imagery mensuration. The type is always
area-perimeterfor ImageAreaParameters.For ImageAreaParameters the type is always "area-perimeter".
Method Overview
| 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 | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | ImageAreaParameters |
Method Details
-
Inherited from Accessor
-
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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.