require(["esri/geometry/operators/graphicBufferOperator"], (graphicBufferOperator) => { /* code goes here */ });
import * as graphicBufferOperator from "@arcgis/core/geometry/operators/graphicBufferOperator.js";
esri/geometry/operators/graphicBufferOperator
Creates planar buffers around 2D geometries using graphical joins and caps.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Creates a buffer around the input geometries, using graphical joins and caps. | graphicBufferOperator |
Method Details
-
Creates a buffer around the input geometries, using graphical joins and caps.
Both
maxDeviationandmaxVerticesInFullCirclecontrol the quality of round joins that are in the buffers. The precision of each buffer is defined bymaxDeviationunless the number of required vertices is too large.ParametersSpecificationThe input geometries to be buffered.
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 theunitoption is set, the default is the geometries spatial reference unit.joins StringDefines the buffers shape where geometries are joined.
Possible Values:"round"|"miter"|"bevel"
caps StringDefines the buffers shape at the end points of the geometries.
Possible Values:"round"|"butt"|"square"
options ObjectoptionalAdditional options.
SpecificationmaxDeviation NumberoptionalDefault Value: NaNThe 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
unitoption is set, the default is the geometries spatial reference unit.maxVerticesInFullCircle NumberoptionalDefault Value: 96The maximum number of vertices in the polygon produced from a buffered point.
miterLimit NumberoptionalDefault Value: 10Defines when miter joins are replaced with bevel joins.
union BooleanoptionalDefault Value: falseIndicates if the buffer geometries should be unioned. When set to
true, the output will be a single geometry.unit LengthUnitoptionalThe length unit of the buffer distances and max deviation. An error will be thrown if this is set for Geographic Coordinate Systems.
ReturnsExample// Buffer two polylines with different distances and buffer styles. const buffers = graphicBufferOperator.executeMany( [polyline1, polyline2], [1000, 1500], "square", "round", 10, );