boundaryOperator | References | ArcGIS Maps SDK for JavaScript

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

Calculates the topological boundary of a 2D geometry.

Functions

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

Function

Calculates the boundary on the input geometry.

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

Parameter	Type	Description	Required
geometry	`GeometryUnion`	The input geometry.

Returns

GeometryWithoutMeshUnion | null | undefined

Returns the boundary geometry or null.

Using point or multipoint as the input geometry returns null.
Extent returns a polyline that bounds the extent.
Polyline returns a multipoint containing the end points of the polyline's parts.
Polygon returns a polyline describing its outer and inner rings.

// Calculate the boundary of a polygon
const boundaryGeometry = boundaryOperator.execute(polygon);

Function

Calculates the boundaries on a set of geometries.

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

Parameter	Type	Description	Required
geometries	`GeometryUnion[]`	The input geometries. All the geometries must have the same spatial reference.

Returns

(GeometryWithoutMeshUnion | null | undefined)[]

Returns the boundary geometries or null.

Using point or multipoint as the input geometry returns null.
Extent returns a polyline that bounds the extent.
Polyline returns a multipoint containing the end points of the polyline's parts.
Polygon returns a polyline describing its outer and inner rings.

Variable

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