differenceOperator | References | ArcGIS Maps SDK for JavaScript

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

Performs a topological difference operation on 2D geometries.

Difference operator

Functions

Name	Return Type	Object
`execute`	`GeometryWithoutMeshUnion \| null \| undefined`
`executeMany`	`(GeometryWithoutMeshUnion \| null \| undefined)[]`
`supportsCurves`

Function

Performs the topological difference operation on the two geometries.

Signature: execute (geometry: GeometryUnion, subtractor: GeometryUnion): GeometryWithoutMeshUnion | null | undefined

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The geometry instance on the left hand side of the subtraction.
subtractor	`GeometryUnion`	The geometry on the right hand side being subtracted.

Returns: GeometryWithoutMeshUnion | null | undefined
Returns the result of the subtraction from the geometry, or null. The result has the dimensions of the geometry.

// Creates a new geometry based on the difference of two polygons
const difference = differenceOperator.execute(polygon1, polygon2);

Function

Performs the Topological difference operation on the geometry set.

Signature: executeMany (geometries: GeometryUnion[], subtractor: GeometryUnion): (GeometryWithoutMeshUnion | null | undefined)[]

Parameter	Type	Description	Required
geometries	`GeometryUnion[]`	The set of geometry instance to be subtracted by the `subtractor`. All the geometries must have the same spatial reference.
subtractor	`GeometryUnion`	The geometry on the right hand side being subtracted.

Returns: (GeometryWithoutMeshUnion | null | undefined)[]
Returns an array whose elements are the result of subtracting each input geometry from geometries, or null. The result has the dimensions of the geometries.

Variable

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