BufferParameters
require(["esri/tasks/support/BufferParameters"], function(BufferParameters) { /* code goes here */ });esri/tasks/support/BufferParametersSets the distances, units, and other parameters for the buffer() method on the GeometryService.
Constructors
- new BufferParameters(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| SpatialReference | The spatial reference in which the geometries are buffered. more details | more details | BufferParameters | |
| String | The name of the class. more details | more details | Accessor | |
| Number[] | The distances the input features are buffered. more details | more details | BufferParameters | |
| Boolean | If the input geometries are in a geographic coordinate system, set geodesic to | more details | BufferParameters | |
| Geometry[] | The input geometries to buffer. more details | more details | BufferParameters | |
| SpatialReference | The spatial reference for the returned geometries. more details | more details | BufferParameters | |
| Boolean | If | more details | BufferParameters | |
| String | The units for calculating each buffer distance. more details | more details | BufferParameters |
Property Details
- bufferSpatialReferenceSpatialReference
The spatial reference in which the geometries are buffered.
If
bufferSpatialReferenceis not specified, the geometries are buffered in the spatial reference specified byoutSpatialReference. IfoutSpatialReferenceis also not specified, they are buffered in the spatial reference of the features.
- Since: ArcGIS API for JavaScript 4.7
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
trueto generate a buffer polygon using a geodesic distance. ThebufferSpatialReferenceproperty is ignored when geodesic is set totrue. 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
outSpatialReferenceis not specified, the output geometries are in the spatial reference specified bybufferSpatialReference. IfbufferSpatialReferencealso 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
unitis not specified, the units are derived frombufferSpatialReference. IfbufferSpatialReferenceis 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 | |
|---|---|---|---|---|
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | BufferParameters |
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:Type Description Object The ArcGIS portal JSON representation of an instance of this class.