ST_Overlaps

Overlaps

ST_Overlaps takes two geometry columns and returns a boolean column. The function returns True if the first geometry and the second geometry spatially overlap; otherwise, it returns False. Two geometries overlap when their intersection is the same geometry type as either of the inputs but not equal to either of the inputs.

FunctionSyntax
Pythonoverlaps(geometry1, geometry2)
SQLST_Overlaps(geometry1, geometry2)
Scalaoverlaps(geometry1, geometry2)

For more details, go to the GeoAnalytics for Microsoft Fabric API reference for overlaps.

This function implements the OpenGIS Simple Features Implementation Specification for SQL 1.2.1.

Examples

PythonPythonSQLScala
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
from geoanalytics_fabric.sql import functions as ST, Linestring, Polygon

data = [
    (Linestring([[[10,10],[30,30]]]), Linestring([[[20,20],[40,40]]])),
    (Linestring([[[0,0],[10,10],[20,0]]]), Linestring([[[10,10],[30,30]]])),
]

df = spark.createDataFrame(data, ["linestring1", "linestring2"])

df.select(ST.overlaps("linestring1", "linestring2").alias("overlaps")).show()
Result
Use dark colors for code blocksCopy
1
2
3
4
5
6
+--------+
|overlaps|
+--------+
|    true|
|   false|
+--------+

Version table

ReleaseNotes

1.0.0-beta

Python, SQL, and Scala functions introduced

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.