| Package | com.esri.bao.tasks.stdgeographies |
| Class | public class StdGeographiesFromExtentParameters |
| Inheritance | StdGeographiesFromExtentParameters BAUtilityParameters BABaseParameters Object |
See also
| Property | Defined By | ||
|---|---|---|---|
![]() | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| analysisExtent : Geometry
Spatial/geographic extent on which to perform the query (required). | StdGeographiesFromExtentParameters | ||
| geoLevelID : String
Community Analyst data layer ID to query features in. | StdGeographiesFromExtentParameters | ||
![]() | resultType : 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 | ||
![]() | taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | |
| Method | Defined By | ||
|---|---|---|---|
StdGeographiesFromExtentParameters(geoLevelID:String = null, analysisExtent:Geometry = null)
Creates a new instance of the StdGeographiesByAttributesParameters class. | StdGeographiesFromExtentParameters | ||
toURLVariables():URLVariables [override]
Converts task parameters to URL variables. | StdGeographiesFromExtentParameters | ||
| analysisExtent | property |
analysisExtent:GeometrySpatial/geographic extent on which to perform the query (required). This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| geoLevelID | property |
geoLevelID:StringCommunity Analyst data layer ID to query features in. The list of available geography levels could be retrieved with GetStandardGeographyLevelsTask task.
public function get geoLevelID():String public function set geoLevelID(value:String):voidSee also
| spatialRelationship | property |
spatialRelationship:SpatialRelEnumThe spatial selection method used with the AnalysisExtent to define the area of analysis.
The default value is SpatialRelEnum.INTERSECTS.
public function get spatialRelationship():SpatialRelEnum public function set spatialRelationship(value:SpatialRelEnum):void| StdGeographiesFromExtentParameters | () | Constructor |
public function StdGeographiesFromExtentParameters(geoLevelID:String = null, analysisExtent:Geometry = null)Creates a new instance of the StdGeographiesByAttributesParameters class.
ParametersgeoLevelID:String (default = null) — Community Analyst data layer ID to query features in.
| |
analysisExtent:Geometry (default = null) — Analysis extent (an instance of the Extent or Polygon type).
|
| toURLVariables | () | method |
override public function toURLVariables():URLVariablesConverts task parameters to URL variables.
ReturnsURLVariables |
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));