import * as symmetricDifferenceOperator from "@arcgis/core/geometry/operators/symmetricDifferenceOperator.js";
const symmetricDifferenceOperator = await $arcgis.import("@arcgis/core/geometry/operators/symmetricDifferenceOperator.js");
@arcgis/core/geometry/operators/symmetricDifferenceOperator
Returns the symmetric difference between 2D geometries, also known as exclusive OR, or XOR. The symmetric difference is the union of the geometries minus the intersection.
This operation can be performed only on geometries that have same dimension (e.g. points with points, lines with lines, polygons with polygons or envelopes, etc). Otherwise, the output will be the input geometry of the higher topological dimension.
- See also
Property Overview
| Name | Type | Summary | Object |
|---|---|---|---|
Indicates if the operator supports input geometries that contain curves. | symmetricDifferenceOperator |
Property Details
-
supportsCurves
PropertysupportsCurves Booleanreadonly -
Indicates if the operator supports input geometries that contain curves. The value will always be
true.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Performs the symmetric difference (XOR) operation on two geometries. | symmetricDifferenceOperator | ||
Performs the symmetric difference (XOR) operation on every geometry in | symmetricDifferenceOperator |
Method Details
-
execute
Methodexecute(leftGeometry, rightGeometry){GeometryUnion} -
Performs the symmetric difference (XOR) operation on two geometries.
ParametersleftGeometry GeometryUnionThe first geometry to be XOR'd.
rightGeometry GeometryUnionThe second geometry to be XOR'd.
ReturnsType Description GeometryUnion Returns the symmetric difference of the two geometries. The result has the higher of dimensions of the two geometries. Example// Calculate the symmetric difference of two polygons. const differencePolygon = symmetricDifferenceOperator.execute(polygon1, polygon2);
-
executeMany
MethodexecuteMany(inputGeometries, rightGeometry){GeometryUnion[]} -
Performs the symmetric difference (XOR) operation on every geometry in
inputGeometrieswithrightGeometry.ParametersinputGeometries GeometryUnion[]The set of geometries to be XOR'd by the
rightGeometry.rightGeometry GeometryUnionThe geometry being XOR'd with the
inputGeometries.ReturnsType Description GeometryUnion[] Returns an array of the result geometries.