areaOperator | API Reference | ArcGIS Maps SDK for JavaScript 4.31

areaOperator

AMD: require(["esri/geometry/operators/areaOperator"], (areaOperator) => { /* code goes here */ });

ESM: import * as areaOperator from "@arcgis/core/geometry/operators/areaOperator.js";

Object: esri/geometry/operators/areaOperator

Since: ArcGIS Maps SDK for JavaScript 4.31

beta

Returns the planar area of a 2D geometry in its spatial reference units.

Method Overview

Name	Return Type	Summary	Object
	Number	Calculates the planar area of the input geometry.	areaOperator

execute Method execute(geometry, options){Number}

Calculates the planar area of the input geometry.

Parameters

geometry Geometry

The geometry to calculate the area from.

options Object

optional

Additional options.

Specification

unit AreaUnit

optional

The area unit of the return value.

Returns

Type	Description
Number	Returns the planar area of the geometry.

Example

// Calculate the area of a polygon
const area = areaOperator.execute(polygon);