| Package | com.esri.baserver.tasks.tradeareas |
| Class | public class StandardLevelsOfGeographyParameters |
| Inheritance | StandardLevelsOfGeographyParameters  TradeAreaTaskParameters SummaryReportParameters BATaskParameters Object |
The geographyLevelID parameter specifies the geography level whose geographic
units are exported to the output trade area.
There are two ways for selecting IDs of geographic units from the geography level—using an array of IDs or using a data table.
In the first case, the geographyIDs parameter explicitly specifies the list
of IDs of geographic units.
In the second case, the dataTable parameter specifies a data table and the
tableIDField parameter specifies the column of the data table which contains the
geography IDs required.
The optional appendFields parameter allows you to export all other columns
of the data table to the output trade area layer. Since the data table can contain records
with duplicated geography IDs, it is important to specify in this case how the data in rows
with a duplicated geographic ID are aggregated. The geographyFeaturesBehavior
parameter specifies the aggregation method—use data from the first matching row (default)
or summarize data for all rows having identical geographic IDs.
Output options for this task include rendering an output image (outputTypes.getMapImage), creating
a feature class for subsequent analysis (outputTypes.getFeatureClass), and/or
creating a report (outputTypes.getReport).
If no output options are specified, the required output options are specified as follows.
If the renderingParameters parameter is specified, the image output is requested.
If the reportOptions parameter is specified, the report is requested.
If the outputAnalysisItem parameter is specified, the output analysis feature class
will be stored in the repository. If renderingParameters,
reportOptions, and outputAnalysisItem parameters are missing,
the feature class output is requested.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| appendFields : Boolean
An option specifying whether append the dataTable fields to the output
trade area layer or not. | StandardLevelsOfGeographyParameters | ||
| dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | TradeAreaTaskParameters | |
| dataTable : TableData
A data table containing IDs of the geography level units to be exported
to the output trade area layer. | StandardLevelsOfGeographyParameters | ||
| geographyFeaturesBehavior : StdGeographyType
Method of aggregation rows of dataTable table having identical geography IDs. | StandardLevelsOfGeographyParameters | ||
| geographyIDs : Array
An array of IDs of the geography level units. | StandardLevelsOfGeographyParameters | ||
| geographyLevelID : String
ID of a geography level to get standard geographic units from (required). | StandardLevelsOfGeographyParameters | ||
| outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | TradeAreaTaskParameters | |
| outputReportItems : Array
Array of FolderItem items specifying configuration options for storing
output reports in the repository. | TradeAreaTaskParameters | |
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | TradeAreaTaskParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | TradeAreaTaskParameters | |
| reportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type. | SummaryReportParameters | |
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | |
| returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | TradeAreaTaskParameters | |
| tableIDField : String
The attribute field name in the input dataTable table which contains geography IDs. | StandardLevelsOfGeographyParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
StandardLevelsOfGeographyParameters(outputTypes:OutputTypes = null)
Creates a new instance of the StandardLevelsOfGeographyParameters class. | StandardLevelsOfGeographyParameters | ||
| appendFields | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesappendFields:Boolean
An option specifying whether append the dataTable fields to the output
trade area layer or not.
The default value is false.
public function get appendFields():Boolean public function set appendFields(value:Boolean):void| dataTable | property |
dataTable:TableDataA data table containing IDs of the geography level units to be exported to the output trade area layer.
public function get dataTable():TableData public function set dataTable(value:TableData):void| geographyFeaturesBehavior | property |
geographyFeaturesBehavior:StdGeographyType
Method of aggregation rows of dataTable table having identical geography IDs.
The default value is StdGeographyType.USE_FIRST.
public function get geographyFeaturesBehavior():StdGeographyType public function set geographyFeaturesBehavior(value:StdGeographyType):void| geographyIDs | property |
geographyIDs:ArrayAn array of IDs of the geography level units.
public function get geographyIDs():Array public function set geographyIDs(value:Array):void| geographyLevelID | property |
geographyLevelID:StringID of a geography level to get standard geographic units from (required). The list of available geography levels could be retrieved with Get Standard Geography Levels task.
public function get geographyLevelID():String public function set geographyLevelID(value:String):voidSee also
| tableIDField | property |
tableIDField:String
The attribute field name in the input dataTable table which contains geography IDs.
public function get tableIDField():String public function set tableIDField(value:String):void| StandardLevelsOfGeographyParameters | () | Constructor |
public function StandardLevelsOfGeographyParameters(outputTypes:OutputTypes = null)Creates a new instance of the StandardLevelsOfGeographyParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : StandardLevelsOfGeographyParameters = new StandardLevelsOfGeographyParameters();
// Set a geography level ID.
parameters.geographyLevelID = "US.ZIP5";
// Explicitely specify geography IDs in an array.
parameters.geographyIDs = ["92373", "92374"];
// Set report options.
var options:ReportOptions = new ReportOptions("PDF", "Age");
options.header = new ReportHeader("Report for Redlands ZIP Codes");
parameters.ReportOptions = [options];
standardLevelsOfGeographyTask.execute(parameters, new Responder(resultHandler, faultHandler));