1.7 KiB
1.7 KiB
| title | description | menu | weight | flux/v0.x/tags | introduced | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| geo.stContains() function | `geo.stContains()` returns boolean indicating whether the defined region contains a specified GIS geometry. |
|
201 |
|
0.78.0 |
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
{{% 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
({{< req >}}) Record that defines the unit of measurement for distance.