Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class StudyArea
InheritanceStudyArea Inheritance Object
Implements IJSONSupport
Subclasses AddressStudyArea, GeometryStudyArea, StandardGeographyStudyArea

Since : ArcGIS API 3.5 for Flex

The GeoEnrichment service uses the concept of a study area to define the location of the point or area that you want to enrich with additional information. If one or many points are input as a study area, the service will create a 1-mile ring buffer around the point to collect and append enrichment data. You can optionally change the ring buffer size or create drive-time service areas around the point. The most common method to determine the center point for a study areas is a set of one or many point locations defined as XY locations. More specifically, one or many input points (latitude and longitude) can be provided to the service to set the study areas that you want to enrich with additional information. You can create a buffer ring or drive-time service area around the points to aggregate data for the study areas. You can also return enrichment data for buffers around input line features.



Public Properties
 PropertyDefined By
  attributes : Object
Attributes returned as attributes of features in the results.
StudyArea
  comparisonGeographyLevels : Array
An array of comparison levels of geography
StudyArea
  options : StudyAreaOptions
Optional parameter to specify enrichment behavior.
StudyArea
  returnGeometry : Boolean = false
Optional parameter to request the output geometries in the response.
StudyArea
Public Methods
 MethodDefined By
  
toJSON(key:String = null):Object
Convert this StudyArea to a JSON object.
StudyArea
Property Detail
attributesproperty
public var attributes:Object

Attributes returned as attributes of features in the results.

comparisonGeographyLevelsproperty 
public var comparisonGeographyLevels:Array

An array of comparison levels of geography

See also

optionsproperty 
public var options:StudyAreaOptions

Optional parameter to specify enrichment behavior.

For points described as map coordinates, a 1-mile ring area centered on each site will be used by default.

This parameter is not needed and ignored for input polygon study areas.

You can use this parameter to change these default settings. With this parameter, the caller can override the default behavior describing how the enrichment attributes are appended to the input features described in studyAreas. For example, you can change the output ring buffer to 5 miles, change the number of output buffers created around each point, and also change the output buffer type to a drive-time service area rather than a simple ring buffer.

See also

returnGeometryproperty 
public var returnGeometry:Boolean = false

Optional parameter to request the output geometries in the response. When this parameter is set to true, the output geometries associated with each feature will be included in the response. The output geometries will be in the spatial reference system defined by outSpatialReference. return false

Method Detail
toJSON()method
public function toJSON(key:String = null):Object

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

Parameters

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

Returns
Object — JSON object

See also