geo.stContains() function
geo.stContains() is experimental and subject to change at any time.
geo.stContains() returns boolean indicating whether the defined region contains a specified GIS geometry.
geo.stContains is used as a helper function for geo.ST_Contains().
Function type signature
(geometry: A, region: B, units: {distance: string}) => bool where A: Record, B: Record
For more information, see Function type signatures.
Parameters
region
(Required) Region to test. Specify record properties for the shape.
geometry
(Required) GIS geometry to test. Can be either point or linestring geometry.
units
(Required) Record that defines the unit of measurement for distance.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Flux and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.