Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class EnrichParameters
InheritanceEnrichParameters Inheritance EnrichParametersBase Inheritance Object

Since : ArcGIS API 3.5 for Flex

Input parameters for an GeoEnrichmentTask.enrich() call.

See also

com.esri.ags.tasks.GeoEnrichmentTask.enrich()


Public Properties
 PropertyDefined By
 InheritedcountryId : String
Optional parameter to explicitly specify the country to query.
EnrichParametersBase
 InheriteddatasetId : String
Optional parameter to explicitly specify the dataset to query.
EnrichParametersBase
  forStorage : Boolean = false
Optional parameter to define if GeoEnrichment output is being stored.
EnrichParameters
 InheritedinSpatialReference : SpatialReference
Optional parameter to define the input geometries in the studyAreas parameter in a specified spatial reference system.
EnrichParametersBase
  intersectingGeographies : Array
Optional array of IntersectingGeography objects to explicitly define the geographic layers used to provide geographic context during the enrichment process.
EnrichParameters
  outSpatialReference : SpatialReference
Optional parameter to request the output geometries in a specified spatial reference system.
EnrichParameters
 InheritedstudyAreaOptions : StudyAreaOptions
Optional parameter to specify enrichment behavior.
EnrichParametersBase
 InheritedstudyAreas : Array
Required parameter to specify a list of input features to be enriched.
EnrichParametersBase
  variableIds : Array
Optional parameter to specify a subset of variable ids to be returned from one or more data collections.
EnrichParameters
Property Detail
forStorageproperty
public var forStorage:Boolean = false

Optional parameter to define if GeoEnrichment output is being stored.

The price for using the "enrich" method varies according to whether the data returned is being persisted, i.e. being stored, or whether it is merely being used in an interactive context and is discarded after being viewed.

If the data is being stored, the terms of use for the GeoEnrichment service require that you specify the "forStorage" parameter to true.

When this parameter is set to false, the output geometries and or output data cannot be stored.

The default value is false.

intersectingGeographiesproperty 
public var intersectingGeographies:Array

Optional array of IntersectingGeography objects to explicitly define the geographic layers used to provide geographic context during the enrichment process.

For example, you can use this optional parameter to return the U.S. county and ZIP Code that each input study area intersects.

You can intersect input features defined in the studyAreas parameter with standard geography layers that are provided by the GeoEnrichment service for each country.

You can also intersect features from a publicly available feature service.

See also

outSpatialReferenceproperty 
public var outSpatialReference:SpatialReference

Optional parameter to request the output geometries in a specified spatial reference system.

When returnGeometry is set to true, this optional parameter can be specified to explicitly indicate the spatial reference system of the output geometry.


Example
To display enrich results on a map, make sure to return geometries and setting the outSpatialReference as appropriate:
     <esri:EnrichParameters id="enrichParameters" outSpatialReference="{map.spatialReference}" >
variableIdsproperty 
public var variableIds:Array

Optional parameter to specify a subset of variable ids to be returned from one or more data collections.

A Data Collection is a pre-assembled list of attributes that will be used to enrich the input features.

With the variables parameter you can return a subset of variables Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.

See also