BufferParameters

AMD: require(["esri/rest/support/BufferParameters"], (BufferParameters) => { /* code goes here */ });
ESM: import BufferParameters from "@arcgis/core/rest/support/BufferParameters";
Class: esri/rest/support/BufferParameters
Inheritance: BufferParameters Accessor
Since: ArcGIS API for JavaScript 4.20

Sets the distances, units, and other parameters for the buffer() method on the geometryService.

See also:

Constructors

new BufferParameters(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
SpatialReferencemore details

The spatial reference in which the geometries are buffered.

more detailsBufferParameters
Stringmore details

The name of the class.

more detailsAccessor
Number[]more details

The distances the input features are buffered.

more detailsBufferParameters
Booleanmore details

If the input geometries are in a geographic coordinate system, set geodesic to true to generate a buffer polygon using a geodesic distance.

more detailsBufferParameters
Geometry[]more details

The input geometries to buffer.

more detailsBufferParameters
SpatialReferencemore details

The spatial reference for the returned geometries.

more detailsBufferParameters
Booleanmore details

If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array.

more detailsBufferParameters
Stringmore details

The units for calculating each buffer distance.

more detailsBufferParameters

Property Details

bufferSpatialReference SpatialReference

The spatial reference in which the geometries are buffered.

If bufferSpatialReference is not specified, the geometries are buffered in the spatial reference specified by outSpatialReference. If outSpatialReference is also not specified, they are buffered in the spatial reference of the features.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

distances Number[]

The distances the input features are buffered. The distance units are specified by unit.

geodesic Boolean

If the input geometries are in a geographic coordinate system, set geodesic to true to generate a buffer polygon using a geodesic distance. The bufferSpatialReference property is ignored when geodesic is set to true. Requires ArcGIS Server 10.1 or greater geometry service. For more information, see the ArcGIS REST API documentation on the GeometryService buffer operation and the geodesic property.

geometries Geometry[]

The input geometries to buffer.

outSpatialReference SpatialReference

The spatial reference for the returned geometries.

If outSpatialReference is not specified, the output geometries are in the spatial reference specified by bufferSpatialReference. If bufferSpatialReference also is not specified, they are in the spatial reference of the features.

unionResults Boolean

If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array.

unit String

The units for calculating each buffer distance. If unit is not specified, the units are derived from bufferSpatialReference. If bufferSpatialReference is not specified, the units are derived from the features.

For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constants.

Possible Values:"feet"|"kilometers"|"meters"|"miles"|"nautical-miles"|"yards"

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsBufferParameters
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsBufferParameters

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.