relate

Computes the DE-9IM string for a pair of geometries a and b.

The result is a 9-character string described by the regular expression /^[F012]{9}$/.
Each character represents a dimension of intersection:

• F - no intersection (-1 dimension)
• 0 - point
• 1 - line
• 2 - area

warning

Do not use this function with invalid geometries. You will get unexpected results.

Parameters

Name	Type	Description
a	Geometry | Prepared<Geometry>	First geometry
b	Geometry	Second geometry

Returns

string

DE-9IM matrix string for the spacial relationship between geometries a and b

Throws

• GEOSError on unsupported geometry types (curved)

See also

• relatePattern returns true if spatial relationship between two geometries matches the specified pattern
• prepare improves performance of repeated calls against a single geometry

Examples

const a = point([ 0, 0 ]);
const b = lineString([ [ 0, 0 ], [ 1, 0 ] ]);
const ab_relate = relate(a, b); // 'F0FFFF102'
const ba_relate = relate(b, a); // 'FF10F0FF2'

const a = point([ 0, 0 ]); const b = lineString([ [ 0, 0 ], [ 1, 0 ] ]); const ab_relate = relate(a, b); // 'F0FFFF102' const ba_relate = relate(b, a); // 'FF10F0FF2'