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

Glossary Item Box

The SummarizePointsParameters class provides input parameters for the Summarize Points task.

Object Model

SummarizePointsParameters ClassExtentData ClassBoundaries ClassFolderItem ClassFolderItem ClassOutputTypes ClassPointLayer ClassRenderingParameters ClassBAResultType ClassReportOptions Class

Syntax

Remarks

The analysis can be restricted to an analysis extent if the AnalysisExtent parameter is specified. Attribute fields specified in the AdditionalFields list should contain numerical values.

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 StandardReportOptions 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, StandardReportOptions, and OutputAnalysisItem parameters are missing, the feature class output is requested.

Example

The code snippet below creates SummarizePointsParameters and then executes a Summarize Points task:
C#Copy Code
SummarizePointsParameters parameters = new SummarizePointsParameters();
            
// The PointLayer type could take either data as
// ESRI.ArcGIS.Client.Tasks.FeatureSet, ESRI.ArcGIS.Client.BAServer.FolderItem,
// or a list of ESRI.ArcGIS.Client.BACore.PointRecord items.
            
// Set PointLayer with a valid data type.
parameters.PointLayer = points;
            
// The Boundaries type could take either data as
// ESRI.ArcGIS.Client.Tasks.FeatureSet, ESRI.ArcGIS.Client.BAServer.FolderItem, 
// or ESRI.ArcGIS.Client.BACore.StandardLayer, e.g.
//Boundaries boundaries = new Boundaries(new StandardLayer("US.ZIP5", zipCodesArray));
            
// Set Boundaries with a valid data type.
parameters.Boundaries = boundaries;
            
// Set name of the unique area ID field in the Boundaries layer.
parameters.AreaIDField = "ID";
            
// Set additional fields of the PointLayer layer to be aggregated.
parameters.AdditionalFields = new List<string>() { "SALES" };
            
// Set report parameters. 
parameters.StandardReportOptions = new ReportOptions("PDF");
            
summarizePointsTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.BATaskParameters
      ESRI.ArcGIS.Client.BACore.Client.StandardReportParameters
         ESRI.ArcGIS.Client.BAServer.Tasks.AnalysisAndReportParameters
            ESRI.ArcGIS.Client.BAServer.Tasks.Reports.SummarizePointsParameters

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.