Packagecom.esri.baserver.tasks.stdgeographies
Classpublic class StdGeographiesFromExtentParameters
InheritanceStdGeographiesFromExtentParameters Inheritance BAUtilityParameters Inheritance BABaseParameters Inheritance Object

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

View the examples

See also

StdGeographiesFromExtentTask


Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAUtilityParameters
  analysisExtent : Geometry
Spatial/geographic extent on which to perform the query (required).
StdGeographiesFromExtentParameters
  geoLevelID : String
ID of a standard geography level to find geography features in (required).
StdGeographiesFromExtentParameters
 InheritedresultType : BAResultType
[read-only] Type of a result returned by the task associated with these parameters.
BABaseParameters
  spatialRelationship : SpatialRelEnum
The spatial selection method used with the analysisExtent to define the area of analysis.
StdGeographiesFromExtentParameters
 InheritedtaskName : String
[read-only] Name of a Business Analyst Server task associated with these parameters.
BABaseParameters
Public Methods
 MethodDefined By
  
Creates a new instance of the StdGeographiesFromExtentParameters class.
StdGeographiesFromExtentParameters
Property Detail
analysisExtentproperty
analysisExtent:Geometry

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

ID of a standard geography level to find geography features in (required). The list of available geography levels could be retrieved with Get Standard Geography Levels task.


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

See also

spatialRelationshipproperty 
spatialRelationship:SpatialRelEnum

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()

Creates a new instance of the StdGeographiesFromExtentParameters class.

Examples
ActionScript to create StdGeographiesFromExtentParameters and then use in a Standard Geographies from Extent task:
                     
     var parameters : StdGeographiesFromExtentParameters = new StdGeographiesFromExtentParameters();
     
     // Set a standard geography level.
     parameters.geoLevelID = "US.States";
     
     // Set a data extent for analysis to myExtent that is a value of the Extent or Polygon type. 
     parameters.analysisExtent = myExtent;
      
     stdGeographiesFromExtentTask.execute(parameters, new Responder(resultHandler, faultHandler));