| Package | com.esri.baserver.tasks.reports |
| Class | public class PointsInPolygonReportParameters |
| Inheritance | PointsInPolygonReportParameters  StandardReportParameters StandardReportParameters BATaskParameters Object |
The analysis can be restricted to an analysis extent if the analysisExtent parameter is specified.
The additionalFields parameter allows user to show additional fields of the boundary layer in the report.
Output options for this task include creating a report (outputTypes.getReport). You need not specify the output options for this task because the getReport output type is set by default.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| additionalFields : Array
Additional fields of the featureLayer layer to be shown in the report. | PointsInPolygonReportParameters | ||
| analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | PointsInPolygonReportParameters | ||
| boundaryIDField : String
Name of the unique area ID field in the boundaryLayer layer (required). | PointsInPolygonReportParameters | ||
| boundaryLayer : Boundaries
A polygon layer whose areas are used in the report (required). | PointsInPolygonReportParameters | ||
| featureLayer : PointLayer
A point layer containing point features whose locations are tested to lie
within areas of the boundaryLayer layer (required). | PointsInPolygonReportParameters | ||
| outputReportItem : FolderItem
Configuration options for storing the output report in the repository. | StandardReportParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| reportOrientation : ReportOrientation
Orientation of the report. | PointsInPolygonReportParameters | ||
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | |
| standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | |
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the PointsInPolygonReportParameters class. | PointsInPolygonReportParameters | ||
| additionalFields | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesadditionalFields:Array
Additional fields of the featureLayer layer to be shown in the report.
This array should contain String type items.
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
| boundaryIDField | property |
boundaryIDField:String
Name of the unique area ID field in the boundaryLayer layer (required).
public function get boundaryIDField():String public function set boundaryIDField(value:String):void| boundaryLayer | property |
boundaryLayer:BoundariesA polygon layer whose areas are used in the report (required).
public function get boundaryLayer():Boundaries public function set boundaryLayer(value:Boundaries):void| featureLayer | property |
featureLayer:PointLayer
A point layer containing point features whose locations are tested to lie
within areas of the boundaryLayer layer (required).
public function get featureLayer():PointLayer public function set featureLayer(value:PointLayer):void| reportOrientation | property |
reportOrientation:ReportOrientationOrientation of the report.
The default value is ReportOrientation.PORTRAIT.
public function get reportOrientation():ReportOrientation public function set reportOrientation(value:ReportOrientation):void| PointsInPolygonReportParameters | () | Constructor |
public function PointsInPolygonReportParameters()Creates a new instance of the PointsInPolygonReportParameters class.
var parameters : PointsInPolygonReportParameters = new PointsInPolygonReportParameters();
// 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, e.g.
//var points:Array = [new PointRecord("store_1", "Store 1", "1", 34.052074, -117.207841)];
// Set stores as an array of PointRecord items.
parameters.featureLayer = new PointLayer(points);
// 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 boundaryLayer with a valid data type.
parameters.boundaryLayer = boundaries;
// Set name of the unique area ID field in the boundaryLayer layer.
parameters.boundaryIDField = "ID";
// Set additional fields of the featureLayer layer.
parameters.additionalFields = ["name"];
// Set report parameters.
parameters.standardReportOptions = new ReportOptions("PDF");
pointsInPolygonReportTask.execute(parameters, new Responder(resultHandler, faultHandler));