import { differenceExecute, execute, differenceExecuteMany, executeMany, differenceSupportsCurves } from "@arcgis/core/geometry/operators/differenceOperator.js";
Since
ArcGIS Maps SDK for JavaScript 4.31

Performs a topological difference operation on 2D geometries.

Difference operator

Functions

differenceExecute

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Performs the topological difference operation on the two geometries.

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

Parameters

ParameterTypeDescriptionRequired
geometry

The geometry instance on the left-hand side of the subtraction.

subtractor

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.

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

execute

deprecated Function

Performs the topological difference operation on the two geometries.

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

Parameters

ParameterTypeDescriptionRequired
geometry

The geometry instance on the left-hand side of the subtraction.

subtractor

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 same dimensions as geometry.

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

differenceExecuteMany

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Performs the topological difference operation on the geometry set.

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

Parameters

ParameterTypeDescriptionRequired
geometries

The set of geometry instances to be subtracted by the subtractor. All the geometries must have the same spatial reference.

subtractor

The geometry on the right-hand side being subtracted.

Returns
(GeometryWithoutMeshUnion | null | undefined)[]

Returns an array whose elements are the result of subtracting subtractor from each input geometry in geometries. Individual entries may be null or undefined. Each result has the dimensions of its corresponding input geometry.

executeMany

deprecated Function

Performs the topological difference operation on the geometry set.

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

Parameters

ParameterTypeDescriptionRequired
geometries

An array of geometries. All the geometries must have the same spatial reference.

subtractor

The geometry to be subtracted from each and every geometry in geometries.

Returns
(GeometryWithoutMeshUnion | null | undefined)[]

Returns an array whose elements are the result of subtracting subtractor from each input geometry in geometries. Individual entries may be null or undefined. Each result has the dimensions of its corresponding input geometry.

Variables

differenceSupportsCurves

Variable
Since
ArcGIS Maps SDK for JavaScript 5.2

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

Type
boolean

supportsCurves

deprecated Variable

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

Type
ReturnType