Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/flux/v0.x/stdlib/experimental/geo/st_dwithin.md

1.9 KiB
Raw Permalink Blame History

title description menu weight flux/v0.x/tags introduced
geo.ST_DWithin() function `geo.ST_DWithin()` tests if the specified region is within a defined distance from the specified GIS geometry and returns `true` or `false`.
flux_0_x_ref
name parent identifier
geo.ST_DWithin experimental/geo experimental/geo/ST_DWithin
201
geotemporal
0.78.0

geo.ST_DWithin() tests if the specified region is within a defined distance from the specified GIS geometry and returns true or false.

Function type signature
(distance: A, geometry: B, region: C, ?units: {distance: string}) => bool where A: Comparable + Equatable, B: Record, C: 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.

distance

({{< req >}}) Maximum distance allowed between the region and geometry. Define distance units with the geo.units option.

units

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