geo.stDistance() function

<!------------------------------------------------------------------------------ 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#L220-L223 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

geo.stDistance() returns the distance from a given region to a specified GIS geometry.

geo.stDistance is used as a helper function for geo.ST_Distance().

Function type signature

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

Parameters

region

({{< req >}}) Region to test. Specify record properties for the shape.

geometry

({{< req >}}) GIS geometry to test. Can be either point or linestring geometry.

units

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