Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class RingBuffer
InheritanceRingBuffer Inheritance StudyAreaOptions Inheritance Object

Since : ArcGIS API 3.5 for Flex

The study area is created with a ring buffers with a radius.



Public Properties
 PropertyDefined By
  radii : Array
An array of Number used to create drive buffers.
RingBuffer
  units : String
The units of the radii.
RingBuffer
Public Methods
 MethodDefined By
  
RingBuffer(radii:Array = null, units:String = null)
Creates a new RingBuffer.
RingBuffer
  
toJSON(key:String = null):Object
[override] Convert this RingBuffer to a JSON object.
RingBuffer
Public Constants
 ConstantDefined By
  FEET : String = esriFeet
[static] Specifies that the units are in feet.
RingBuffer
  KILOMETERS : String = esriKilometers
[static] Specifies that the units are in kilometers.
RingBuffer
  METERS : String = esriMeters
[static] Specifies that the units are in meters.
RingBuffer
  MILES : String = esriMiles
[static] Specifies that the units are in miles.
RingBuffer
Property Detail
radiiproperty
public var radii:Array

An array of Number used to create drive buffers.

unitsproperty 
public var units:String

The units of the radii. Supported options are:

Constructor Detail
RingBuffer()Constructor
public function RingBuffer(radii:Array = null, units:String = null)

Creates a new RingBuffer.

Parameters
radii:Array (default = null) — An array of Number used to create drive buffers.
 
units:String (default = null) — The units of the radii.
Method Detail
toJSON()method
override public function toJSON(key:String = null):Object

Convert this RingBuffer to a JSON object. If you need a JSON formatted string, you can pass this RingBuffer directly to JSONUtil.encode().

Parameters

key:String (default = null) — Unused but required for compatibility with JSON.stringify().

Returns
Object — JSON object

See also

Constant Detail
FEETConstant
public static const FEET:String = esriFeet

Specifies that the units are in feet.

KILOMETERSConstant 
public static const KILOMETERS:String = esriKilometers

Specifies that the units are in kilometers.

METERSConstant 
public static const METERS:String = esriMeters

Specifies that the units are in meters.

MILESConstant 
public static const MILES:String = esriMiles

Specifies that the units are in miles.