@arcgis/core/geometry/operators/touchesOperator.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

/**
 * Perform a relational operation to determine if one 2D geometry touches another 2D geometry.
 *
 * ![Touches operator](https://developers.arcgis.com/javascript/latest/assets/references/core/operators/touches.png "Touches operator")
 *
 * @since 4.31
 */
import type { GeometryUnion } from "../types.js";

/**
 * Accelerate a geometry. This method prepares the geometry for faster touches 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 a touches operation on two geometries.
 *
 * @param geometry1 - The base geometry that is tested for the "touches" relationship with `geometry2`.
 * @param geometry2 - The comparison geometry that is tested for the "touches" relationship with `geometry1`.
 * @returns Returns `true` if the two geometries touch.
 * @example
 * // Returns true if the line vertex touches the edge of the polygon
 * const isTouching = touchOperator.execute(polygon, line);
 */
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;