Sets 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 | more details The spatial reference in which the geometries are buffered. | more details | BufferParameters | |
String | more details The name of the class. | more details | Accessor | |
Number[] | more details The distances the input features are buffered. | more details | BufferParameters | |
Boolean | more details If the input geometries are in a geographic coordinate system, set geodesic to | more details | BufferParameters | |
Geometry[] | more details The input geometries to buffer. | more details | BufferParameters | |
SpatialReference | more details The spatial reference for the returned geometries. | more details | BufferParameters | |
Boolean | more details If | more details | BufferParameters | |
String | more details The units for calculating each buffer distance. | more details | BufferParameters |
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 byoutSpatialReference
. IfoutSpatialReference
is also not specified, they are buffered in the spatial reference of the features.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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. ThebufferSpatialReference
property 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.
-
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 bybufferSpatialReference
. IfbufferSpatialReference
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 frombufferSpatialReference
. IfbufferSpatialReference
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 details | BufferParameters | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | BufferParameters |
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 ObjectA 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.