Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class GeographyLevel
InheritanceGeographyLevel Inheritance Object
Implements IJSONSupport

Since : ArcGIS API 3.5 for Flex

A GeographyLevel works with IntersectingGeographies to define a study area of InfoGraphic with a feature from a standard geography layer. You may use this class to define your study area as a standard census unit (such as a state, county, tract, etc). To be used in favor of the levels property in the IntersectingGeographies class. Only limited layers are available to construct a GeographicLevel object. Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find the countries where data are available. The "ID" column in the Standard Geography Levels table lists all the layer IDs you may use.

See also

com.esri.ags.tasks.geoEnrichmentClasses.IntersectingGeographies
ArcGIS Help - GeoEnrichment service coverage


Public Properties
 PropertyDefined By
  countryId : String
The ID of the country for which data is retrieved.
GeographyLevel
  datasetId : String
The ID of the dataset to which variables used in this GeographyLevel belong.
GeographyLevel
  layerId : String
The ID of the layer.
GeographyLevel
Public Methods
 MethodDefined By
  
GeographyLevel(countryId:String = null, datasetId:String = null, layerId:String = null)
Creates a new GeographyLevel object.
GeographyLevel
  
toJSON(key:String = null):Object
Convert this GeographyLevel to a JSON object.
GeographyLevel
Property Detail
countryIdproperty
public var countryId:String

The ID of the country for which data is retrieved.

Optional when constructing a GeographyLevel. If not specified, the server will automatically determine the country. Specifying the country ID can eliminate computational cost and potentially improve the performance of your application.

Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find the countries where data are available. The "Two-Digit Country Code" column in the first table lists all the country codes you may use.

The default value is null.

See also

datasetIdproperty 
public var datasetId:String

The ID of the dataset to which variables used in this GeographyLevel belong.

Optional when constructing a GeographyLevel. If not specified, the server will automatically determine the dataset. Specifying the dataset ID can eliminate computational cost and potentially improve the performance of your application.

Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find available dataset. Request latest available datasets with the getAvailableCountries() function of the GeoEnrichmentTask

The default value is null.

See also

layerIdproperty 
public var layerId:String

The ID of the layer.

Required when constructing a GeographyLevel.

Refer to the GeoEnrichment Coverage section of the ArcGIS GeoEnrichment Service documentation to find the countries where data are available. The "ID" column in the Standard Geography Levels table lists all the layer IDs you may use.

The default value is null.

See also

com.esri.ags.tasks.GeoEnrichmentTask.getAvailableCountries()
com.esri.ags.tasks.geoenrichClasses.GeographyDataset
ArcGIS Help - GeoEnrichment service coverage
com.esri.ags.tasks.geoenrichClasses.GeographyLayer
Constructor Detail
GeographyLevel()Constructor
public function GeographyLevel(countryId:String = null, datasetId:String = null, layerId:String = null)

Creates a new GeographyLevel object.

Parameters
countryId:String (default = null) — The ID of the country for which data is retrieved.
 
datasetId:String (default = null) — The ID of the dataset to which variables used in this GeographyLevel belong.
 
layerId:String (default = null) — The ID of the layer.
Method Detail
toJSON()method
public function toJSON(key:String = null):Object

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

Parameters

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

Returns
Object — JSON object

See also