Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class IntersectingGeography
InheritanceIntersectingGeography Inheritance Object
Implements IJSONSupport
Subclasses ExternalIntersectingGeography, StandardIntersectingGeography

Since : ArcGIS API 3.5 for Flex

An IntersectingGeography defines 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 be the GeoEnrichment service for each country using the StandardIntersectingGeography class.

You can also intersect features from a publicly available feature service using the ExternalIntersectingGeography class.



Public Properties
 PropertyDefined By
  geometryType : String
Specifies how input studyAreas should intersect specified geography.
IntersectingGeography
  name : String
Optional alias name you want to give the output geography layer being intersected.
IntersectingGeography
  outFields : Array
You can optionally define the list of output fields from the intersected layer that will be appended to the GeoEnrichment response as geocontext items.
IntersectingGeography
  spatialRelationship : String = esriSpatialRelIntersects
The optional spatial relationship to be applied on the intersecting layer.
IntersectingGeography
  where : String
You can define an optional where clause.
IntersectingGeography
Public Methods
 MethodDefined By
  
toJSON(key:String = null):Object
Convert this IntersectingGeography to a JSON object.
IntersectingGeography
Property Detail
geometryTypeproperty
public var geometryType:String

Specifies how input studyAreas should intersect specified geography.

nameproperty 
public var name:String

Optional alias name you want to give the output geography layer being intersected. For example, you can set the name of U.S.Counties to just Counties in the GeoEnrichment output.

outFieldsproperty 
public var outFields:Array

You can optionally define the list of output fields from the intersected layer that will be appended to the GeoEnrichment response as geocontext items.

spatialRelationshipproperty 
public var spatialRelationship:String = esriSpatialRelIntersects

The optional spatial relationship to be applied on the intersecting layer.

The supported spatial relationships include intersects, contains, envelope intersects, within, and so on.

The default spatial relationship is intersects (esriSpatialRelIntersects).

whereproperty 
public var where:String

You can define an optional where clause.

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

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

Parameters

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

Returns
Object — JSON object

See also