import { isLoaded, load, execute, supportsCurves } from "@arcgis/core/geometry/operators/geodeticDistanceOperator.js";const { isLoaded, load, execute, supportsCurves } = await $arcgis.import("@arcgis/core/geometry/operators/geodeticDistanceOperator.js");- 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.
Type definitions
Options
Type definition
curveType
Property
- Type
- Exclude<GeodeticCurveType, "shape-preserving"> | undefined
The type of geodetic curve used to determine the distance.
- Default value
- "geodesic"
Functions
isLoaded
Function
Indicates if all dependencies of this module have been loaded.
- Signature
-
isLoaded (): boolean
- Returns
- boolean
Returns
trueif this module's dependencies have been loaded.
load
Function
Loads this module's dependencies. This method must be called first if isLoaded returns false.
- See also
- Signature
-
load (): Promise<void>
execute
Function
Calculates the shortest geodetic distance between two geometries.
Unless the unit option is set, the default is meters.
- Signature
-
execute (geometry1: GeometryUnion, geometry2: GeometryUnion, options?: Options): number
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| geometry1 | The first input geometry. | | |
| geometry2 | The second input geometry. | | |
| options | Additional options. | |
- Returns
- 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 geometriesconst distance = geodeticDistanceOperator.execute(polyline1, polyline2);