Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class StandardGeographyStudyArea
InheritanceStandardGeographyStudyArea Inheritance StudyArea Inheritance Object

Since : ArcGIS API 3.5 for Flex

An StandardGeographyStudyArea defines a location in the form of a named statistical area.

This form of study area lets you define an area by the ID of a standard geographic statistical feature, such as a census or postal area, for example, to obtain enrichment information for a U.S. state, county, or ZIP Code or a Canadian province or postal code.

You can use the StandardGeographyQueryTask to find the ids for named statistical features.

View the examples

See also

com.esri.ags.tasks.StandardGeographyQueryTask
Enrich with named statistical areas


Public Properties
 PropertyDefined By
 Inheritedattributes : Object
Attributes returned as attributes of features in the results.
StudyArea
 InheritedcomparisonGeographyLevels : Array
An array of comparison levels of geography
StudyArea
  countryId : String
The id of the country.
StandardGeographyStudyArea
  geographyLayerId : String
The id of a geography layer for the country.
StandardGeographyStudyArea
  ids : Array
An array of geography ids in the geography layer.
StandardGeographyStudyArea
 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
  
toJSON(key:String = null):Object
[override] Convert this StandardGeographyStudyArea to a JSON object.
StandardGeographyStudyArea
Property Detail
countryIdproperty
public var countryId:String

The id of the country. For example : "US"

geographyLayerIdproperty 
public var geographyLayerId:String

The id of a geography layer for the country. For example : "US.States"

idsproperty 
public var ids:Array

An array of geography ids in the geography layer. For example, the California state in the geography layer "US.States": ["06"]

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

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

Parameters

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

Returns
Object — JSON object

See also

Examples
Map areas described as named administrative boundaries (e.g., U.S. state):
 var studyArea:StandardGeographyStudyArea = new StandardGeographyStudyArea();
 studyArea.countryId = "US";
 studyArea.geographyLayerId = "US.States";
 studyArea.ids = ["06"];
 
Map areas described as multiple named administrative boundaries (e.g., U.S. ZIP Codes):
 var studyArea:StandardGeographyStudyArea = new StandardGeographyStudyArea();
 studyArea.countryId = "US";
 studyArea.geographyLayerId = "US.ZIP5";
 studyArea.ids = ["92373","92129"];
 
Combined map areas described as multiple named administrative boundaries and return enrichment data for the union of the combined features (e.g., Canadian postal codes):
 var studyArea:StandardGeographyStudyArea = new StandardGeographyStudyArea();
 studyArea.countryId = "CA";
 studyArea.geographyLayerId = "CAN.FSA";
 studyArea.ids = ["M2H,M2N,L3T"];