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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | more details The name of the class. | more details | Accessor | |
| Polygon | more details Polygon whose area is to be computed and displayed in the view. | more details | AreaMeasurementAnalysis | |
| SystemOrAreaUnit | more details Unit system (imperial, metric) or specific unit used for displaying the computed area in the view. | more details | AreaMeasurementAnalysis |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
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 SystemOrAreaUnit
-
Unit system (imperial, metric) or specific unit used for displaying the computed area in the view.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| this | more details Creates a deep clone of this object. | more details | AreaMeasurementAnalysis | |
| more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor |
Method Details
-
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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.