Packagecom.esri.bao.tasks.stdgeographies
Classpublic final class StdGeographiesFromExtentParameters
InheritanceStdGeographiesFromExtentParameters Inheritance BAUtilityParameters

The StdGeographiesFromExtentParameters class provides input parameters for the Standard Geographies from Extent task.


Example
ActionScript to create StdGeographiesFromExtentParameters and then use in the StdGeographiesFromExtentTask:
     
 var parameters : StdGeographiesFromExtentParameters = new StdGeographiesFromExtentParameters();
 
 parameters.geoLevelID = "US.ZIP5";
 parameters.analysisExtent = myExtent;
 
 // SpatialRelEnum.INTERSECTS is the default value for spatialRelationship.
 //parameters.spatialRelationship = SpatialRelEnum.INTERSECTS;
 
 stdGeographiesFromExtentTask.execute(parameters, new Responder(resultHandler, faultHandler));
 
 

See also

StdGeographiesFromExtentTask


Public Properties
 PropertyDefined by
  analysisExtent : Geometry
Spatial/geographic extent on which to perform the query (required).
StdGeographiesFromExtentParameters
  geoLevelID : String
Business Analyst Online data layer ID to query features in.
StdGeographiesFromExtentParameters
 InheritedresultType : BAResultType
Type of a result returned by the task associated with these parameters.
BAUtilityParameters
  spatialRelationship : SpatialRelEnum
The spatial selection method used with the AnalysisExtent to define the area of analysis.
StdGeographiesFromExtentParameters
 InheritedtaskName : String
Name of a Business Analyst task associated with these parameters.
BAUtilityParameters
Public Methods
 MethodDefined by
  
StdGeographiesFromExtentParameters(geoLevelID:String = null, analysisExtent:Geometry = null)
Creates a new instance of the StdGeographiesByAttributesParameters class.
StdGeographiesFromExtentParameters
  
toURLVariables():URLVariables
Converts task parameters to URL variables.
StdGeographiesFromExtentParameters
Property detail
analysisExtentproperty
analysisExtent:Geometry  [read-write]

Spatial/geographic extent on which to perform the query (required). This parameter expects a value of the Extent or Polygon type.

Implementation
    public function get analysisExtent():Geometry
    public function set analysisExtent(value:Geometry):void

See also

geoLevelIDproperty 
geoLevelID:String  [read-write]

Business Analyst Online data layer ID to query features in. The list of available geography levels could be retrieved with GetStandardGeographyLevelsTask task.

Implementation
    public function get geoLevelID():String
    public function set geoLevelID(value:String):void

See also

spatialRelationshipproperty 
spatialRelationship:SpatialRelEnum  [read-write]

The spatial selection method used with the AnalysisExtent to define the area of analysis.

The default value is SpatialRelEnum.INTERSECTS.

Implementation
    public function get spatialRelationship():SpatialRelEnum
    public function set spatialRelationship(value:SpatialRelEnum):void
Constructor detail
StdGeographiesFromExtentParameters()constructor
public function StdGeographiesFromExtentParameters(geoLevelID:String = null, analysisExtent:Geometry = null)

Creates a new instance of the StdGeographiesByAttributesParameters class.

Parameters
geoLevelID:String (default = null) — Business Analyst Online data layer ID to query features in.
 
analysisExtent:Geometry (default = null) — Analysis extent (an instance of the Extent or Polygon type).
Method detail
toURLVariables()method
public override function toURLVariables():URLVariables

Converts task parameters to URL variables.

Returns
URLVariables