FRAMES | NO FRAMES
GridsParameters Type

Parameters of Grids task.

Availability: Business Analyst Server.

class GridsParameters : SummaryReportParameters

Property Description
AggregationHierarchy (optional) Name of a hierarchy of data layers used to calculate summarization fields. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
AnalysisExtent Data extent for analysis. Type ExtentData.
DistanceUnits The distance units for the GridCellSize property. Type esriUnits.
GridCellSize Size of grid cells. Type Double.
GridDataLayerID (optional) ID of a grid data layer to get demography from. Type String. This property is deprecated.
Summarizations (optional) Fields of grid data layer to be appended to the output feature layer. Type String[].
SymbolizationField (optional) Name of field from the grid data layer for symbolization. Type String.
DataHierarchy (optional) Name of a hierarchy of data layers used for generating summary reports. Type String. Use the GetDataHierarchies lookup operation to query available geography hierarchies. Available with Business Analyst Server 10.0.
ReportOptions Array specifying reports that will be generated using trade/service areas as boundary areas for analysis. Use the GetReportTemplates lookup operation to query available report templates. Type ReportOptions[]. Inherited from SummaryReportParameters.
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Remarks

The AnalysisExtent property specifies the market area to create a vector based graticule layer. The grid size is specified by the GridCellSize and DistanceUnits property.

Optional summarization fields specified in the Summarizations array and in the SymbolizationField property are calculated for every grid cell using the hierarchy of data layers specified with the AggregationHierarchy property and are appended to the output feature layer. The output map is thematically shaded if the SymbolizationField property is specified.

NOTE: Since Business Analyst Server 10.0, the GridDataLayerID and SummaryDataLayerID propertiess are replaced with optional AggregationHierarchy and DataHierarchy properties, respectively.

See Also