BufferParameters

require(["esri/tasks/support/BufferParameters"], function(BufferParameters) { /* code goes here */ });
Class: esri/tasks/support/BufferParameters
Inheritance: BufferParameters Accessor
Since: ArcGIS API for JavaScript 4.0

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.
NameTypeSummaryClass
SpatialReference

The spatial reference in which the geometries are buffered.

more details
more detailsBufferParameters
String

The name of the class.

more details
more detailsAccessor
Number[]

The distances the input features are buffered.

more details
more detailsBufferParameters
Boolean

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

more details
more detailsBufferParameters
Geometry[]

The input geometries to buffer.

more details
more detailsBufferParameters
SpatialReference

The spatial reference for the returned geometries.

more details
more detailsBufferParameters
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.

more details
more detailsBufferParameters
String

The units for calculating each buffer distance.

more details
more detailsBufferParameters

Property Details

bufferSpatialReferenceSpatialReference

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.

declaredClassStringreadonly inherited

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

distancesNumber[]

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

geodesicBoolean

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.

geometriesGeometry[]

The input geometries to buffer.

outSpatialReferenceSpatialReference

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.

unionResultsBoolean

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.

unitString

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

NameReturn TypeSummaryClass
Object

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

more details
more detailsBufferParameters

Method Details

toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.