import { withinAccelerateGeometry, accelerateGeometry, withinExecute, execute, withinSupportsCurves } from "@arcgis/core/geometry/operators/withinOperator.js";
Since
ArcGIS Maps SDK for JavaScript 4.31

Perform a relational operation to determine if one 2D geometry is within another 2D geometry. Geometry A is within geometry B when A is the intersection of A and B.

Geometry A can be non-simple geometry.

Within operator

Functions

withinAccelerateGeometry

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Accelerate a geometry. This method prepares the geometry for faster within 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
withinAccelerateGeometry (geometry: GeometryUnion): boolean

Parameters

ParameterTypeDescriptionRequired
geometry

The geometry to accelerate.

Returns
boolean

Returns true if the geometry was successfully accelerated.

accelerateGeometry

deprecated Function

Accelerate a geometry. This method prepares the geometry for faster within 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

ParameterTypeDescriptionRequired
geometry

The geometry to accelerate.

Returns
boolean

Returns true if the geometry was successfully accelerated.

withinExecute

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Perform a within operation on two geometries.

Signature
withinExecute (inner: GeometryUnion, outer: GeometryUnion): boolean

Parameters

ParameterTypeDescriptionRequired
inner

The base geometry that is tested for the "within" relationship with outer.

outer

The comparison geometry that is tested for the "contains" relationship with inner.

Returns
boolean

Returns true if inner is within outer.

Example
// Returns true if a geometry is completely within another
const isWithin = withinExecute(polygon1, polygon2);

execute

deprecated Function

Perform a within operation on two geometries.

Signature
execute (inner: GeometryUnion, outer: GeometryUnion): boolean

Parameters

ParameterTypeDescriptionRequired
inner

The base geometry that is tested for the "within" relationship with outer.

outer

The comparison geometry that is tested for the "contains" relationship with inner.

Returns
boolean

Returns true if inner is within outer.

Example
// Returns true if a geometry is completely within another
const isWithin = withinExecute(polygon1, polygon2);

Variables

withinSupportsCurves

Variable
Since
ArcGIS Maps SDK for JavaScript 5.2

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

Type
boolean

supportsCurves

deprecated Variable

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

Type
ReturnType