equalsOperator | References | ArcGIS Maps SDK for JavaScript

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

Since: ArcGIS Maps SDK for JavaScript 4.31

Performs a relational operation to determine if two 2D geometries are topologically equal.

Functions

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

accelerateGeometry

Function

Accelerate a geometry. This method prepares the geometry for faster equals 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 equals operation on two geometries. The number of vertices and ordering of the vertices is not considered.

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

Parameters

Parameter	Type	Description	Required
geometry1	`GeometryUnion`	The first geometry.
geometry2	`GeometryUnion`	The second geometry.

Returns: boolean
Returns true if the two geometries are topologically equal.

Example

// Returns true if two geometries are equal
const isEqual = equalOperator.execute(polyline1, polyline2);

Variables

supportsCurves

Variable

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

Type: boolean