geodeticLengthOperator | API Reference | ArcGIS Maps SDK for JavaScript 4.31

geodeticLengthOperator

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

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

Object: esri/geometry/operators/geodeticLengthOperator

Method Overview

Return Type	Summary	Object
Number	Calculates the geodetic length of the input Geometry.	geodeticLengthOperator
Boolean	Indicates if all dependencies of this module have been loaded.	geodeticLengthOperator
Promise	Loads this module's dependencies.	geodeticLengthOperator

execute Method execute(geometry, options){Number}

Calculates the geodetic length of the input Geometry. Unless the unit option is set, the default is meters.

Parameters

Specification

geometry Geometry

The input geometry.

options Object

optional

Additional options.

Specification

curveType String

optional

Default Value: "geodesic"

The type of geodetic curve used to determine the length.

Possible Values:"geodesic"|"loxodrome"|"great-elliptic"|"normal-selection"|"shape-preserving"

unit LengthUnit

optional

The length unit of the return value.

Returns

Type	Description
Number	Returns the geodetic length of the input geometry.

Example

// Calculate the geodetic length of a polyline.
if (geodeticLengthOperator.isLoaded()) {
  const length = geodeticLengthOperator.execute(polyline);
}

isLoaded Method isLoaded(){Boolean}

Indicates if all dependencies of this module have been loaded.

Returns

Type	Description
Boolean	Returns `true` if this module's dependencies have been loaded.

load Method load(){Promise}

Loads this module's dependencies. This method must be called first if isLoaded returns false.

Returns

Type	Description
Promise	Resolves when the dependencies have been loaded.

See also