require(["esri/geometry/operators/containsOperator"], (containsOperator) => { /* code goes here */ });
import * as containsOperator from "@arcgis/core/geometry/operators/containsOperator.js";
esri/geometry/operators/containsOperator
Performs a relational operation to determine if one 2D geometry contains another 2D geometry. Geometry A contains geometry B, when B is the intersection of A and B. A contains B is equivalent to B within A. Geometry B can be non-simple geometry.
Property Overview
| Name | Type | Summary | Object |
|---|---|---|---|
Indicates if the operator supports input geometries that contain curves. | containsOperator |
Property Details
-
supportsCurves
PropertysupportsCurves Booleanreadonly -
Indicates if the operator supports input geometries that contain curves.
- Default Value:true
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Accelerate a geometry. | containsOperator | ||
Perform the contains operation on two geometries. | containsOperator |
Method Details
-
accelerateGeometry
MethodaccelerateGeometry(geometry){Boolean} -
Accelerate a geometry. This method prepares the geometry for faster contains operations when the same geometry is tested multiple times (e.g. in a loop with hundreds of iterations).
Parametergeometry GeometryUnionThe geometry to accelerate.
ReturnsType Description Boolean Returns trueif the geometry was successfully accelerated.
-
execute
Methodexecute(geometry1, geometry2){Boolean} -
Perform the contains operation on two geometries.
Parametersgeometry1 GeometryUnionThe geometry that is tested for the "contains" relationship to
geometry2.geometry2 GeometryUnionThe geometry that is tested for the "within" relationship to
geometry1.ReturnsType Description Boolean Returns trueifgeometry1containsgeometry2.Example// Returns true if one geometry contains another const isContained = containsOperator.execute(polygon1, polygon2);