AMD:
require(["esri/geometry/operators/relateOperator"], (relateOperator) => { /* code goes here */ });
ESM:
import * as relateOperator from "@arcgis/core/geometry/operators/relateOperator.js";
Object:
esri/geometry/operators/relateOperator
Since: ArcGIS Maps SDK for JavaScript 4.31
beta
Performs a relational operation between two 2D geometries using the DE-9IM matrix encoded as a string. The DE-9IM matrix is a 3x3 matrix that describes the topological relationship between two geometries.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Accelerate a geometry. | relateOperator | ||
| relateOperator | |||
| relateOperator |
Method Details
-
accelerateGeometry
MethodaccelerateGeometry(geometry){Boolean} -
Accelerate a geometry. This method prepares the geometry for faster relate operations when the same geometry is tested multiple times (e.g. in a loop with hundreds of iterations).
Parametergeometry GeometryThe geometry to accelerate.
ReturnsType Description Boolean Returns trueif the geometry was successfully accelerated.
-
execute
Methodexecute(geometry1, geometry2, relation){Boolean} -
ParametersReturns
Type Description Boolean Returns trueif the two geometries satisfy the DE-9IM matrix relation.Example// Returns true if the polygon geometry completely // contains the polyline based on the DE-9IM string const isRelated = relateOperator.execute(polygon, polyline, "TTTFFTFFT");