Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: BufferParameters
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.tasks.BufferParameters")
Description
(Added at v1.0)
Sets the distances, units, and other parameters for a buffer operation.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new esri.tasks.BufferParameters() | Creates a new BufferParameters object. |
Properties
| Name | Type | Summary |
|---|---|---|
| bufferSpatialReference | SpatialReference | The spatial reference in which the geometries are buffered. |
| distances | Number[] | The distances the input features are buffered. |
| geodesic | Boolean | If the input geometries are in geographic coordinate system set geodesic to true in order to generate a buffer polygon using a geodesic distance. |
| geometries | Geometry[] | The input geometries to buffer. |
| outSpatialReference | SpatialReference | The spatial reference for the returned geometries. |
| 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 | Number | The units for calculating each buffer distance. |
Constructor Details
Creates a new BufferParameters object. The constructor takes no parameters.
Sample:
var params = new esri.tasks.BufferParameters();
Property Details
<SpatialReference
SpatialReferenceThe spatial reference in which the geometries are buffered. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
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.
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.
Sample:
params.bufferSpatialReference = new esri.SpatialReference({wkid: 32662});
<Number[]
Number[]The distances the input features are buffered. The distance units are specified by unit.
Sample:
params.distances = [ dojo.byId('bufferDistance').value ];
<Boolean
BooleanIf the input geometries are in geographic coordinate system set geodesic to true in order 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. (Added at v2.7)Known values:
true | falseSample:
params.geodesic = true;
<Geometry[]
Geometry[]The input geometries to buffer. (Added at v2.0)
Sample:
params.geometries = [ evt.mapPoint ];
<SpatialReference
SpatialReferenceThe spatial reference for the returned geometries. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
If outSpatialReference is not specified, the output geometries are in the spatial reference specified by bufferSR. If bufferSpatialReference is also not specified, they are in the spatial reference of the features.
If outSpatialReference is not specified, the output geometries are in the spatial reference specified by bufferSR. If bufferSpatialReference is also not specified, they are in the spatial reference of the features.
Sample:
params.outSpatialReference = map.spatialReference;
<Boolean
BooleanIf 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.
Known values:
true | falseDefault value:
false<Number
NumberThe units for calculating each buffer distance. If
For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constants.
unit
is not specified, the units are derived from bufferSpatialReference. If bufferSpatialReference is not specified, the units are derived from the features. See the GeometryService
constants table for values.
For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constants.
Sample:
params.unit = esri.tasks.GeometryService.UNIT_KILOMETER;