FRAMES | NO FRAMES
SummarizePointsParameters Type

Parameters of SummarizePoints task.

Availability: Business Analyst Server 10.0 SP1.

class SummarizePointsParameters : StandardReportParameters

Property Description
AdditionalFields (optional) Additional fields of the input PointLayer layer to be aggregated for areas of the Boundaries layer. Type String[].
AnalysisExtent (optional) Data extent to restrict the analysis. Type ExtentData.
AreaDescField (required) Name of area description field in the Boundaries layer. Type String.
AreaIDField (optional) Name of area ID field in the Boundaries layer. Type String.
Default: "AREA_ID".
Boundaries (required) The polygon layer whose features represent trade areas. Type DataLayer.
PointLayer (required) A point layer containing point features to be summarized. Type PointLayer.
StandardReportOptions Report parameters. The TemplateName parameter is ignored. Type ReportOptions. Inherited from StandardReportParameters.
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 analysis can be restricted to an analysis extent if the AnalysisExtent parameter is specified. Attribute fields specified in the AdditionalFields array should contain numerical values.

See Also