Back to Influxdb

geo.ST_Length() function

content/flux/v0/stdlib/experimental/geo/st_length.md

latest1.3 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/experimental/geo/geo.flux#L318-L318 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

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

Function type signature
js
(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

Record that defines the unit of measurement for distance.