touchesOperator

AMD: require(["esri/geometry/operators/touchesOperator"], (touchesOperator) => { /* code goes here */ });
ESM: import * as touchesOperator from "@arcgis/core/geometry/operators/touchesOperator.js";
Object: esri/geometry/operators/touchesOperator
Since: ArcGIS Maps SDK for JavaScript 4.31
beta

Perform a relational operation to determine if one 2D geometry touches another 2D geometry.

Method Overview

Name Return Type Summary Object

Accelerate a geometry.

touchesOperator

Perform a touches operation on two geometries.

touchesOperator

Method Details

accelerateGeometry

Method
accelerateGeometry(geometry){Boolean}

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).

Parameter
geometry Geometry

The geometry to accelerate.

Returns
Type Description
Boolean Returns true if the geometry was successfully accelerated.

execute

Method
execute(geometry1, geometry2){Boolean}

Perform a touches operation on two geometries.

Parameters
geometry1 Geometry

The base geometry that is tested for the "touches" relationship with geometry2.

geometry2 Geometry

The comparison geometry that is tested for the "touches" relationship with geometry1.

Returns
Type Description
Boolean 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);

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.