docs-v2/content/flux/v0/stdlib/experimental/geo/stlength.md

1.7 KiB

title description menu weight flux/v0/tags introduced
geo.stLength() function `geo.stLength()` returns the [spherical length or distance](https://mathworld.wolfram.com/SphericalDistance.html) of the specified GIS geometry.
flux_v0_ref
name parent identifier
geo.stLength experimental/geo experimental/geo/stLength
201
geotemporal
0.78.0

geo.stLength() returns the spherical length or distance of the specified GIS geometry.

geo.stLength is used as a helper function for geo.ST_Length().

Function type signature
(geometry: A, units: {distance: string}) => float where A: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

geometry

({{< req >}}) GIS geometry to test. Can be either point or linestring geometry. Point geometry will always return 0.0.

units

({{< req >}}) Record that defines the unit of measurement for distance.