@arcgis/core
Version:
ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API
32 lines (29 loc) • 1.38 kB
TypeScript
/**
* Performs a relational operation to determine if two 2D geometries are topologically equal.
*
* @since 4.31
*/
import type { GeometryUnion } from "../types.js";
/**
* 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](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/#acceleration) guide topic for more information.
*
* @param geometry - The geometry to accelerate.
* @returns Returns `true` if the geometry was successfully accelerated.
*/
export function accelerateGeometry(geometry: GeometryUnion): boolean;
/**
* Perform the equals operation on two geometries. The number of vertices and ordering of the vertices is not considered.
*
* @param geometry1 - The first geometry.
* @param geometry2 - The second geometry.
* @returns Returns `true` if the two geometries are topologically equal.
* @example
* // Returns true if two geometries are equal
* const isEqual = equalOperator.execute(polyline1, polyline2);
*/
export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean;
/**
* Indicates if the operator supports input geometries that contain curves.
* The value will always be `true`.
*/
export const supportsCurves: boolean;