boundaryOperator | API Reference | ArcGIS Maps SDK for JavaScript 4.32

boundaryOperator

AMD: require(["esri/geometry/operators/boundaryOperator"], (boundaryOperator) => { /* code goes here */ });

ESM: import * as boundaryOperator from "@arcgis/core/geometry/operators/boundaryOperator.js";

Object: esri/geometry/operators/boundaryOperator

Since: ArcGIS Maps SDK for JavaScript 4.31

Calculates the topological boundary of a 2D geometry.

Property Overview

Name	Type	Summary	Object
	Boolean	Indicates if the operator supports input geometries that contain curves.	boundaryOperator

supportsCurves Property supportsCurves Booleanreadonly

Indicates if the operator supports input geometries that contain curves.

Name	Return Type	Summary	Object
	GeometryUnion\|null\|undefined	Calculates the boundary on the input geometry.	boundaryOperator
	Array<(GeometryUnion\|null\|undefined)>	Calculates the boundaries on a set of geometries.	boundaryOperator

execute Method execute(geometry){GeometryUnion |null |undefined}

Calculates the boundary on the input geometry.

Parameter

geometry GeometryUnion

The input geometry.

Returns

Type	Description
GeometryUnion \| 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 = boundaryOperator.execute(polygon);

executeMany Method executeMany(geometries){Array<(GeometryUnion|null|undefined)>}

Calculates the boundaries on a set of geometries.

Parameter

geometries GeometryUnion []

The input geometries. All the geometries must have the same spatial reference.

Returns

Type	Description
Array<(GeometryUnion\|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.