bufferOperator | References | ArcGIS Maps SDK for JavaScript

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

Since: ArcGIS Maps SDK for JavaScript 4.31

Creates planar buffers around 2D geometries. A planar buffer calculates the area around a geometry using the straight line distance between points based on a flat, two-dimensional surface. This is suitable for rendering smaller areas within a projected coordinate system where the curvature of the Earth can be ignored, such as when all features are contained in one UTM zone. Planar buffers can introduce distortions and inaccuracies when applied over larger areas.

Buffer operator

See also

Type definitions

ExecuteOptions

Type definition

unit

Property

Type: LengthUnit | undefined

The length unit of the buffer distances and max deviation. The default is the input geometry's spatial reference unit. An error will be thrown if this is set for Geographic Coordinate Systems.

ExecuteManyOptions

Type definition

Supertypes: ExecuteOptions

maxDeviation

Property

Type: number | undefined

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

Default value: NaN

maxVerticesInFullCircle

Property

Type: number | undefined

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

Default value: 96

union

Property

Type: boolean | undefined

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

Default value: false

Functions

Name	Return Type	Object
`ExecuteOptions`
`ExecuteManyOptions`
`execute`	`Polygon \| null \| undefined`
`executeMany`	`Polygon[]`
`supportsCurves`

execute

Function

Creates a buffer around the input geometry.

Signature: execute (geometry: GeometryUnion, distance: number, options?: ExecuteOptions): Polygon | null | undefined

Parameters

Parameter	Type	Description
geometry	`GeometryUnion`	The input geometry to be buffered.
distance	`number`	The buffer distance for the geometry. Unless the `unit` option is set, the default is the geometry's spatial reference unit.
options	`ExecuteOptions`	Additional options.

Returns: Polygon | null | undefined
Returns the buffered geometry or null.

Example

// Buffer a polyline geometry
const bufferGeometry = bufferOperator.execute(polyline, 1000);

executeMany

Function

Creates a buffer around the input geometries.

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

Signature: executeMany (geometries: GeometryUnion[], distances: number[], options?: ExecuteManyOptions): Polygon[]

Parameters

Parameter	Type	Description
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.
options	`ExecuteManyOptions`	Additional options.

Returns: Polygon[]
Returns the buffered geometries.

Variables

supportsCurves

Variable

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

Type: boolean