import { boundaryExecute, execute, boundaryExecuteMany, executeMany, boundarySupportsCurves } from "@arcgis/core/geometry/operators/boundaryOperator.js";
Since
ArcGIS Maps SDK for JavaScript 4.31

Calculates the topological boundary of a 2D geometry.

Functions

boundaryExecute

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Calculates the boundary on the input geometry.

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

Parameters

ParameterTypeDescriptionRequired
geometry

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.
Example
// Calculate the boundary of a polygon
const boundaryGeometry = boundaryExecute(polygon);

execute

deprecated Function

Calculates the boundary on the input geometry.

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

Parameters

ParameterTypeDescriptionRequired
geometry

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.
Example
// Calculate the boundary of a polygon
const boundaryGeometry = boundaryExecute(polygon);

boundaryExecuteMany

Function
Since
ArcGIS Maps SDK for JavaScript 5.2

Calculates the boundaries on a set of geometries.

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

Parameters

ParameterTypeDescriptionRequired
geometries

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.

executeMany

deprecated Function

Calculates the boundaries on a set of geometries.

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

Parameters

ParameterTypeDescriptionRequired
geometries

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.

Variables

boundarySupportsCurves

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