▾
import { geodeticLengthIsLoaded, isLoaded, geodeticLengthLoad, load, geodeticLengthExecute } from "@arcgis/core/geometry/operators/geodeticLengthOperator.js";const { geodeticLengthIsLoaded, isLoaded, geodeticLengthLoad, load, geodeticLengthExecute } = await $arcgis.import("@arcgis/core/geometry/operators/geodeticLengthOperator.js");- Since
- ArcGIS Maps SDK for JavaScript 4.31
Returns the geodetic length of a 2D geometry.
Notes
Verify that isLoaded() returns true before using this module.
Use load() to load this module's dependencies.
Type definitions
GeodeticLengthOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.2
curveType
- Type
- GeodeticCurveType | undefined
The type of geodetic curve used to determine the length.
- Default value
- "geodesic"
unit
- Type
- LengthUnit | undefined
The length unit of the return value.
- Default value
- "meters"
Functions
geodeticLengthIsLoaded
- Since
- ArcGIS Maps SDK for JavaScript 5.2
Indicates if all dependencies of this module have been loaded.
- Signature
-
geodeticLengthIsLoaded (): boolean
- Returns
- boolean
Returns
trueif this module's dependencies have been loaded.
isLoaded
Indicates if all dependencies of this module have been loaded.
- Signature
-
isLoaded (): boolean
- Returns
- boolean
Returns
trueif this module's dependencies have been loaded.
geodeticLengthLoad
- Since
- ArcGIS Maps SDK for JavaScript 5.2
Loads this module's dependencies. This method must be called first if geodeticLengthIsLoaded returns false.
- See also
- Signature
-
geodeticLengthLoad (): Promise<void>
load
Loads this module's dependencies. This method must be called first if isLoaded returns false.
- See also
- Signature
-
load (): Promise<void>
geodeticLengthExecute
- Since
- ArcGIS Maps SDK for JavaScript 5.2
Calculates the geodetic length of the input Geometry.
Unless the unit option is set, the default is meters.
- Signature
-
geodeticLengthExecute (geometry: GeometryUnion, options?: GeodeticLengthOptions): number
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| geometry | The input geometry. | | |
| options | Additional options. | |
- Returns
- number
Returns the geodetic length of the input geometry.
- Example
- if (!geodeticLengthIsLoaded()) {await geodeticLengthLoad();}// Calculate the geodetic length of a polylineconst length = geodeticLengthExecute(polyline);
execute
Calculates the geodetic length of the input Geometry.
Unless the unit option is set, the default is meters.
- Signature
-
execute (geometry: GeometryUnion, options?: GeodeticLengthOptions): number
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| geometry | The input geometry. | | |
| options | Additional options. | |
- Returns
- number
Returns the geodetic length of the input geometry.
- Example
- if (!geodeticLengthIsLoaded()) {await geodeticLengthLoad();}// Calculate the geodetic length of a polylineconst length = geodeticLengthExecute(polyline);