Esri Business Analyst Server API for Silverlight 2.2 Reference
GridsParameters Class
Members  Example  See Also  Send Feedback
ESRI.ArcGIS.Client.BAServer.Tasks.TradeAreas Namespace : GridsParameters Class

Glossary Item Box

The GridsParameters class provides input parameters for the Grids task.

Object Model

GridsParameters ClassExtentData ClassFolderItem ClassOutputTypes ClassRenderingParameters ClassBAResultType Class

Syntax

Remarks

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.

Example

The code snippet below creates GridsParameters and then executes a Grids task.
C#Copy Code
GridsParameters parameters = new GridsParameters();
             
// Set grid cell size in units specified with DistanceUnits.
parameters.GridCellSize = 5;
             
// Miles is the default value for DistanceUnits.
//parameters.DistanceUnits = esriUnits.esriMiles; 
             
// Set a data extent for analysis to ExtendData object specified with myExtent.
parameters.AnalysisExtent = myExtent;
             
// Set summarization variables.
parameters.Summarizations = new List<string>(){ "TOTPOP_CY", "HHPOP_CY" };
             
gridsTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2010-2012 Esri, Inc. All Rights Reserved.