| Package | com.esri.baserver.tasks.reports |
| Class | public class SummarizePointsParameters |
| Inheritance | SummarizePointsParameters  AnalysisAndReportParameters StandardReportParameters BATaskParameters Object |
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.
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.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| additionalFields : Array
Additional fields of the input pointLayer layer to be aggregated for areas of the
boundaries layer. | SummarizePointsParameters | ||
| analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | SummarizePointsParameters | ||
| areaDescField : String
Name of area description field in the boundaries layer. | SummarizePointsParameters | ||
| areaIDField : String
Name of area ID field in the boundaries layer. | SummarizePointsParameters | ||
| boundaries : Boundaries
The polygon layer whose features represent trade areas. | SummarizePointsParameters | ||
| outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | AnalysisAndReportParameters | |
| outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | AnalysisAndReportParameters | |
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisAndReportParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| pointLayer : PointLayer
The point layer containing point features to be summarized. | SummarizePointsParameters | ||
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisAndReportParameters | |
| 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. | AnalysisAndReportParameters | |
| standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | |
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
SummarizePointsParameters(outputTypes:OutputTypes = null)
Creates a new instance of the SummarizePointsParameters class. | SummarizePointsParameters | ||
| additionalFields | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesadditionalFields:Array
Additional fields of the input pointLayer layer to be aggregated for areas of the
boundaries layer.
Attribute fields specified in this array should contain numerical values.
public function get additionalFields():Array public function set additionalFields(value:Array):void| analysisExtent | property |
analysisExtent:GeometrySpatial/geographic extent to restrict analysis by. This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| areaDescField | property |
areaDescField:String
Name of area description field in the boundaries layer.
public function get areaDescField():String public function set areaDescField(value:String):void| areaIDField | property |
areaIDField:String
Name of area ID field in the boundaries layer.
The default value is "AREA_ID".
public function get areaIDField():String public function set areaIDField(value:String):void| boundaries | property |
boundaries:BoundariesThe polygon layer whose features represent trade areas.
public function get boundaries():Boundaries public function set boundaries(value:Boundaries):void| pointLayer | property |
pointLayer:PointLayerThe point layer containing point features to be summarized.
public function get pointLayer():PointLayer public function set pointLayer(value:PointLayer):void| SummarizePointsParameters | () | Constructor |
public function SummarizePointsParameters(outputTypes:OutputTypes = null)Creates a new instance of the SummarizePointsParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : SummarizePointsParameters = new SummarizePointsParameters();
// The PointLayer type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem,
// or an array of com.esri.bacore.PointRecord items.
// Set stores with a valid data type.
parameters.featureLayer = pointLayer;
// The Boundaries type could take either data as type
// com.esri.ags.tasks.FeatureSet, com.esri.baserver.FolderItem, or com.esri.bacore.StandardLayer, e.g.
//var boundaries:BoundaryLayer = 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.
parameters.additionalFields = ["SALES"];
// Set report parameters.
parameters.standardReportOptions = new ReportOptions("PDF");
summarizePointsTask.execute(parameters, new Responder(resultHandler, faultHandler));