AreaMeasurementAnalysis

AMD: require(["esri/analysis/AreaMeasurementAnalysis"], (AreaMeasurementAnalysis) => { /* code goes here */ });
ESM: import AreaMeasurementAnalysis from "@arcgis/core/analysis/AreaMeasurementAnalysis";
Class: esri/analysis/AreaMeasurementAnalysis
Inheritance: AreaMeasurementAnalysis Accessor
Since: ArcGIS API for JavaScript 4.23

AreaMeasurementAnalysis computes the area of a polygonal region and displays the measurement in a 3D SceneView.

To display an area measurement of a polygon, create a new instance of AreaMeasurementAnalysis, add it to SceneView.analyses and set the geometry property.

Use the AreaMeasurementAnalysisView3D to retrieve analysis results.

// create analysis
const areaMeasurement = new AreaMeasurementAnalysis({
  geometry: polygon
});

// add to scene view
sceneView.analyses.add(areaMeasurement);

// retrieve measured results from analysis view
const analysisView = await sceneView.whenAnalysisView(areaMeasurement);
await reactiveUtils.whenOnce(() => !analysisView.updating);

const result = analysisView.result;

Use the AreaMeasurement3D widget to add interactivity and allow users to change the geometry of the analysis.

Known Limitation

This analysis is only supported in a 3D SceneView.

See also

Constructors

new AreaMeasurementAnalysis(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 name of the class.

more details
Accessor
Polygon

Polygon whose area is to be computed and displayed in the view.

more details
AreaMeasurementAnalysis
SystemOrAreaUnit

Unit system (imperial, metric) or specific unit used for displaying the computed area in the view.

more details
AreaMeasurementAnalysis

Property Details

declaredClass Stringreadonly inherited

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

geometry Polygonautocast

Polygon whose area is to be computed and displayed in the view.

If the polygon has z-values then these will be treated as absolute values.

Known Limitation

For polygons with multiple rings, only the measurement of the first ring will be displayed.

Unit system (imperial, metric) or specific unit used for displaying the computed area in the view.

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.

more details
Accessor
this

Creates a deep clone of this object.

more details
AreaMeasurementAnalysis
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

clone(){this}

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
Type Description
this A deep clone of the class instance that invoked this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

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
Since: ArcGIS API for JavaScript 4.25

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");

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