Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class AddressStudyArea
InheritanceAddressStudyArea Inheritance StudyArea Inheritance Object

Since : ArcGIS API 3.5 for Flex

An AddressStudyArea defines a location in the form of an address geocoded by the GeoEnrichment service.

This form of study area will find the location of a street address, point of interest, place names or other supported location as a single string ("380 New York St, Redlands, CA") and the service returns a coordinate pair representing the address ("-117.1956, 34.0576"). Once a matched address is returned, you can create a buffer ring or drive-time service area around the point to aggregate data for the study area.

When street address strings are used as study area locations, geocoding of the location and enrichment occurs in a single call to the GeoEnrichment service. More specifically, determining the location of matched addresses, creating study area buffers around those points and the data aggregation and enrichment all seamlessly occur within the same request.

The service supports the geocoding parameters of the ArcGIS Online World Geocoding service.

View the examples

See also

Enrich with street address locations
ArcGIS Online World Geocoding service


Public Properties
 PropertyDefined By
  address : Object
The address of this study area.
AddressStudyArea
 Inheritedattributes : Object
Attributes returned as attributes of features in the results.
StudyArea
 InheritedcomparisonGeographyLevels : Array
An array of comparison levels of geography
StudyArea
 Inheritedoptions : StudyAreaOptions
Optional parameter to specify enrichment behavior.
StudyArea
 InheritedreturnGeometry : Boolean = false
Optional parameter to request the output geometries in the response.
StudyArea
Public Methods
 MethodDefined By
  
AddressStudyArea(address:Object = null)
Creates a new AddressStudyArea object.
AddressStudyArea
  
toJSON(key:String = null):Object
[override] Convert this AddressStudyArea to a JSON object.
AddressStudyArea
Property Detail
addressproperty
public var address:Object

The address of this study area.

Constructor Detail
AddressStudyArea()Constructor
public function AddressStudyArea(address:Object = null)

Creates a new AddressStudyArea object.

Parameters
address:Object (default = null) — The address of the study area
Method Detail
toJSON()method
override public function toJSON(key:String = null):Object

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

Parameters

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

Returns
Object — JSON object

See also

Examples
Point described as a single line address:
 address = { text: "380 New York St. Redlands, CA 92373" }
Point described as multiple field input addresses:
 address = { Address: "380 New York St.", Admin1: "Redlands", Admin2: "CA", Postal: 92373, CountryCode: "USA" }