require(["esri/geometry/operators/geodeticLengthOperator"], (geodeticLengthOperator) => { /* code goes here */ });
import * as geodeticLengthOperator from "@arcgis/core/geometry/operators/geodeticLengthOperator.js";
esri/geometry/operators/geodeticLengthOperator
Returns the geodetic length of a 2D geometry.
Notes
- Verify that
isLoaded()
returnstrue
before using this module. - Use
load()
to load this module's dependencies.
Property Overview
Name | Type | Summary | Object |
---|---|---|---|
Indicates if the operator supports input geometries that contain curves. | geodeticLengthOperator |
Property Details
-
Indicates if the operator supports input geometries that contain curves.
- Default Value:true
Method Overview
Name | Return Type | Summary | Object |
---|---|---|---|
Calculates the geodetic length of the input Geometry. | geodeticLengthOperator | ||
Indicates if all dependencies of this module have been loaded. | geodeticLengthOperator | ||
Promise | Loads this module's dependencies. | geodeticLengthOperator |
Method Details
-
execute
execute(geometry, options){Number}
-
Calculates the geodetic length of the input Geometry. Unless the
unit
option is set, the default is meters.ParametersSpecificationgeometry GeometryUnionThe input geometry.
options ObjectoptionalAdditional options.
SpecificationcurveType StringoptionalDefault Value: "geodesic"The type of geodetic curve used to determine the length.
Possible Values:"geodesic"|"loxodrome"|"great-elliptic"|"normal-section"|"shape-preserving"
unit LengthUnitoptionalThe length unit of the return value.
ReturnsType Description Number Returns the geodetic length of the input geometry. Exampleif (!geodeticLengthOperator.isLoaded()) { await geodeticLengthOperator.load(); } // Calculate the geodetic length of a polyline const length = geodeticLengthOperator.execute(polyline);
-
Loads this module's dependencies. This method must be called first if
isLoaded
returnsfalse
.ReturnsType Description Promise Resolves when the dependencies have been loaded. - See also