graphicBufferOperator | API Reference | ArcGIS Maps SDK for JavaScript 4.32

Property Overview

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

Property Details

supportsCurves Property supportsCurves Booleanreadonly

Indicates if the operator supports input geometries that contain curves. This will produce densified output geometries.

Default Value:true

Method Overview

Name	Return Type	Summary	Object
	Polygon []	Creates a buffer around the input geometries, using graphical joins and caps.	graphicBufferOperator

Method Details

executeMany Method executeMany(geometries, distances, joins, caps, options){Polygon[]}

Creates a buffer around the input geometries, using graphical joins and caps.

Both maxDeviation and maxVerticesInFullCircle control the quality of round joins that are in the buffers. The precision of each buffer is defined by maxDeviation unless the number of required vertices is too large.

Parameters

Specification

geometries GeometryUnion []

The input geometries to be buffered. All the geometries must have the same spatial reference.

distances Number []

The buffer distances for the geometries. If the size of this array is less than the number of geometries in the input geometries, the last distance value is used for the rest of geometries. Unless the unit option is set, the default is the geometries spatial reference unit.

joins String

Defines the buffers shape where geometries are joined.

Miter joins are replaced with bevel when the ratio of the miter thickness to the buffer distance is greater than miter limit. The miter thickness is the distance from the vertex to the mitered corner of the buffer that this vertex generates.

Possible Values:"round"|"miter"|"bevel"

caps String

Defines the buffers shape at the end points of the geometries.

Points with square caps will be drawn as squares.
Open polylines paths with square caps degenerate to a point and will be drawn as squares (degenerate with zero tolerance).
Open polylines paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance).

Possible Values:"round"|"butt"|"square"

options Object

optional

Additional options.

Specification

maxDeviation Number

optional

Default Value: NaN

The max deviation of the result buffer from the true buffer in the geometries spatial reference units. When the value is NaN, internal logic is used to select the deviation based on the buffer distance. Unless the unit option is set, the default is the geometries spatial reference unit.

maxVerticesInFullCircle Number

optional

Default Value: 96

The maximum number of vertices in the polygon produced from a buffered point.

miterLimit Number

optional

Default Value: 10

Defines when miter joins are replaced with bevel joins.

union Boolean

optional

Default Value: false

Indicates if the buffer geometries should be unioned. When set to true, the output will be a single geometry.

unit LengthUnit

optional

The length unit of the buffer distances and max deviation. An error will be thrown if this is set for Geographic Coordinate Systems.

Returns

Type	Description
Polygon []	Returns the buffered geometries.

Example

// Buffer two polylines with different distances and buffer styles.
const buffers = graphicBufferOperator.executeMany(
  [polyline1, polyline2],
  [1000, 1500],
  "square",
  "round",
  10,
);