Class: BufferParametersE-mail This Topic Printable Version Give Us Feedback

Description

Sets the distances, units, and other parameters for a buffer operation.

Class hierarchy

esri.tasks.BufferParameters

Constructor

Constructor Description
esri.tasks.BufferParameters() Creates a new BufferParameters object. The constructor takes no parameters.

Properties

Property Type Description
bufferSpatialReference SpatialReference The 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.
distances Number[] The distances the input features are buffered. The distance units are specified by unit.
features Graphic[] The input graphic or feature to buffer.
outSpatialReference SpatialReference The of the 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.
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. If unit is not specified, the units are derived from bufferSpatialReference. If bufferSpatialReference is not specified, the units are derived from the features. See the Constants table for values.

Constants

Constant Description
UNIT_FOOT Feet
UNIT_KILOMETER Kilometers
UNIT_METER Meters
UNIT_NAUTICAL_MILE Nautical Miles
UNIT_STATUTE_MILE Miles
UNIT_US_NAUTICAL_MILE US Nautical Miles
Constructor Detail

esri.tasks.BufferParameters()

Creates a new BufferParameters object. The constructor takes no parameters.
Properties Detail

<SpatialReference> bufferSpatialReference

The 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.

<Number[]> distances

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

<Graphic[]> features

The input graphic or feature to buffer.

<SpatialReference> outSpatialReference

The of the 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.

<Boolean> unionResults

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.
Known values: true | false
Default value: false

<Number> unit

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. See the Constants table for values.