containsOperator | References | ArcGIS Maps SDK for JavaScript

import { accelerateGeometry, execute, supportsCurves } from "@arcgis/core/geometry/operators/containsOperator.js";

Since: ArcGIS Maps SDK for JavaScript 4.31

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.

Contains operator

Functions

Name	Return Type	Object
`accelerateGeometry`	`boolean`
`execute`	`boolean`
`supportsCurves`

accelerateGeometry

Function

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). See the Acceleration guide topic for more information.

Signature: accelerateGeometry (geometry: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry to accelerate.

Returns: boolean
Returns true if the geometry was successfully accelerated.

execute

Function

Perform the contains operation on two geometries.

Signature: execute (geometry1: GeometryUnion, geometry2: GeometryUnion): boolean

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The geometry that is tested for the "contains" relationship to `geometry2`.
geometry2	`GeometryUnion`	The geometry that is tested for the "within" relationship to `geometry1`.

Returns: boolean
Returns true if geometry1 contains geometry2.

Example

// Returns true if one geometry contains another
const isContained = containsOperator.execute(polygon1, polygon2);

Variables

supportsCurves

Variable

Indicates if the operator supports input geometries that contain curves. The value will always be true.

Type: boolean