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

1.7 KiB

title description menu weight flux/v0/tags introduced
geo.ST_Intersects() function `geo.ST_Intersects()` tests if the specified GIS geometry intersects with the specified region and returns `true` or `false`.
flux_v0_ref
name parent identifier
geo.ST_Intersects experimental/geo experimental/geo/ST_Intersects
201
geotemporal
0.78.0

geo.ST_Intersects() tests if the specified GIS geometry intersects with the specified region and returns true or false.

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