| Package | com.esri.baserver.tasks.tradeareas |
| Class | public class GridsParameters |
| Inheritance | GridsParameters  TradeAreaTaskParameters SummaryReportParameters BATaskParameters Object |
The analysisExtent parameter specifies the market area to create a vector based
graticule layer in. The grid size is specified by the gridCellSize
and distanceUnits parameters.
If the gridDataLayerID parameter is specified, the fields of this layer specified
in the summarization array and the symbolizationField parameter are appended
to the output feature class. The output map is thematically shaded if the gridDataLayerID
and symbolizationField parameters are specified.
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 | |
| aggregationHierarchy : String
Name of a data hierarchy used to calculate summarization fields. | GridsParameters | ||
| analysisExtent : Geometry
Spatial/geographic extent to apply analysis at (required). | GridsParameters | ||
| dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | TradeAreaTaskParameters | |
| distanceUnits : String
The distance units for the gridCellSize property. | GridsParameters | ||
| gridCellSize : Number
Size of grid cells (required). | GridsParameters | ||
| 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 | |
| summarizations : Array
Summarization fields to be appended to the output feature class. | GridsParameters | ||
| symbolizationField : String
Name of summarization field to do symbolization by. | GridsParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
GridsParameters(outputTypes:OutputTypes = null)
Creates a new instance of the GridsParameters class. | GridsParameters | ||
| aggregationHierarchy | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesaggregationHierarchy:StringName of a data hierarchy used to calculate summarization fields. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get aggregationHierarchy():String public function set aggregationHierarchy(value:String):voidSee also
| analysisExtent | property |
analysisExtent:GeometrySpatial/geographic extent to apply analysis at (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
| distanceUnits | property |
distanceUnits:String
The distance units for the gridCellSize property.
This should be a string constant from the com.esri.ags.Units class.
The default value is Units.MILES.
public function get distanceUnits():String public function set distanceUnits(value:String):void| gridCellSize | property |
gridCellSize:NumberSize of grid cells (required).
The default value is NaN.
public function get gridCellSize():Number public function set gridCellSize(value:Number):void| summarizations | property |
summarizations:ArraySummarization fields to be appended to the output feature class. This array should contain items of the String type. Available summarization fields can be retrieved with the Get Summarizations task.
public function get summarizations():Array public function set summarizations(value:Array):voidSee also
| symbolizationField | property |
symbolizationField:StringName of summarization field to do symbolization by.
public function get symbolizationField():String public function set symbolizationField(value:String):void| GridsParameters | () | Constructor |
public function GridsParameters(outputTypes:OutputTypes = null)Creates a new instance of the GridsParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : GridsParameters = new GridsParameters();
// Set grid cell size in units specified with distanceUnits.
parameters.gridCellSize = 5;
// Miles is the default value for distanceUnits.
//parameters.distanceUnits = Units.MILES
// Set a data extent for analysis to myExtent that is a value of the Extent or Polygon type.
parameters.analysisExtent = myExtent;
// Set summarization variables.
parameters.summarizations = ["TOTPOP_CY", "HHPOP_CY"];
gridsTask.execute(parameters, new Responder(resultHandler, faultHandler));