disjointOperator | API Reference | ArcGIS Maps SDK for JavaScript 4.31

disjointOperator

AMD: require(["esri/geometry/operators/disjointOperator"], (disjointOperator) => { /* code goes here */ });

ESM: import * as disjointOperator from "@arcgis/core/geometry/operators/disjointOperator.js";

Object: esri/geometry/operators/disjointOperator

Since: ArcGIS Maps SDK for JavaScript 4.31

beta

Performs a relational operation to determine if one 2D geometry is disjoint (doesn't intersect in any way) with another 2D geometry. This operator can be used with non-simple geometries.

Method Overview

Name	Return Type	Summary	Object
	Boolean	Accelerate a geometry.	disjointOperator
	Boolean	Perform a disjoint operation on two geometries.	disjointOperator

Method Details

accelerateGeometry Method accelerateGeometry(geometry){Boolean}

Accelerate a geometry. This method prepares the geometry for faster disjoint 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 disjoint operation on two geometries.

Parameters

geometry1 Geometry

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

geometry2 Geometry

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

Returns

Type	Description
Boolean	Returns `true` if `geometry1` and `geometry2` are disjoint (don't intersect in any way).

Example

// Returns true if a geometry is not contained in another.
// Operates the opposite of contains.
const isDisjointed = disjointOperator.execute(polygon1, polygon2);