geodeticDistanceOperator

AMD: require(["esri/geometry/operators/geodeticDistanceOperator"], (geodeticDistanceOperator) => { /* code goes here */ });
ESM: import * as geodeticDistanceOperator from "@arcgis/core/geometry/operators/geodeticDistanceOperator.js";
Object: esri/geometry/operators/geodeticDistanceOperator
Since: ArcGIS Maps SDK for JavaScript 4.31

Calculates the shortest geodetic distance between two 2D geometries.

Notes

  • Verify that isLoaded() returns true before using this module.
  • Use load() to load this module's dependencies.

Geodetic distance operator

Property Overview

Name Type Summary Object

Indicates if the operator supports input geometries that contain curves.

geodeticDistanceOperator

Property Details

supportsCurves

Property
supportsCurves Boolean |null |undefinedreadonly

Indicates if the operator supports input geometries that contain curves.

Default Value:true

Method Overview

Name Return Type Summary Object

Calculates the shortest geodetic distance between two geometries.

geodeticDistanceOperator

Indicates if all dependencies of this module have been loaded.

geodeticDistanceOperator
Promise

Loads this module's dependencies.

geodeticDistanceOperator

Method Details

execute

Method
execute(geometry1, geometry2, options){Number}

Calculates the shortest geodetic distance between two geometries. Unless the unit option is set, the default is meters.

Parameters
Specification
geometry1 GeometryUnion

The first input geometry.

geometry2 GeometryUnion

The second input geometry.

options Object
optional

Additional options.

Specification
curveType String
optional
Default Value: "geodesic"

The type of geodetic curve used to determine the distance.

Possible Values:"geodesic"|"loxodrome"|"great-elliptic"|"normal-section"

unit LengthUnit
optional

The length unit of the distance.

Returns
Type Description
Number Returns the distance between the two geometries. Can return NaN for empty geometries.
Example
if (!geodeticDistanceOperator.isLoaded()) {
  await geodeticDistanceOperator.load();
}

// Calculate the geodetic distance between two geometries
const distance = geodeticDistanceOperator.execute(polyline1, polyline2);

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

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