require(["esri/rest/support/BufferParameters"], (BufferParameters) => { /* code goes here */ });
import BufferParameters from "@arcgis/core/rest/support/BufferParameters.js";
esri/rest/support/BufferParameters
Sets the distances, units, and other parameters for the buffer() method on the geometryService.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The spatial reference in which the geometries are buffered. | BufferParameters | ||
The name of the class. | Accessor | ||
The distances the input features are buffered. | BufferParameters | ||
If the input geometries are in a geographic coordinate system, set geodesic to | BufferParameters | ||
The input geometries to buffer. | BufferParameters | ||
The spatial reference for the returned geometries. | BufferParameters | ||
If | BufferParameters | ||
The units for calculating each buffer distance. | BufferParameters |
Property Details
-
bufferSpatialReference
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 distances the input features are buffered. The distance units are specified by
unit
.
-
geodesic
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.
-
outSpatialReference
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
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
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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | BufferParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | BufferParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
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.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.