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/stdlib/experimental/geo/st_contains.md

1.7 KiB
Raw Permalink Blame History

title description menu weight flux/v0/tags introduced
geo.ST_Contains() function `geo.ST_Contains()` returns boolean indicating whether the defined region contains a specified GIS geometry.
flux_v0_ref
name parent identifier
geo.ST_Contains experimental/geo experimental/geo/ST_Contains
201
geotemporal
0.78.0

geo.ST_Contains() returns boolean indicating whether the defined region contains a specified GIS geometry.

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.