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

title	description	menu	weight	flux/v0/tags	introduced
geo.ST_Distance() function	`geo.ST_Distance()` returns the distance from a given region to a specified GIS geometry.	flux_v0_ref name parent identifier geo.ST_Distance experimental/geo experimental/geo/ST_Distance	201	geotemporal	0.78.0

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

Function type signature

(geometry: A, region: B, ?units: {distance: string}) => float where A: Record, B: Record

{{% 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

Record that defines the unit of measurement for distance. Default is the geo.units option.