Package | com.esri.baserver.tasks.reports |
Class | public class SummaryReportsParameters |
Inheritance | SummaryReportsParameters SummaryReportParameters BATaskParameters Object |
The summarization can be restricted to an analysis extent if the analysisExtent
parameter is specified. Optional singleAreaID
parameter restricts the summarization
to a single area of the boundary layer. The summarization can be applied to individual features,
to all features, and to both individual and all features.
This behavior is controlled with the reportSummarizationOptions
parameter.
Default is the summarization by individual features.
An optional areaIDField
parameter specifies a field of the boundaries
layer uniquely identifying an area. If this parameter is omitted, the area ID field is recognized
as follows: if the boundaries
layer is a standard layer, the "ID" field is used;
otherwise, the "AREA_ID" field is used.
Report items are usually sorted by area ID field values having the form "storeID_ringID".
If the area ID field has a value non-confirming to this template, the ringIDField
and storeIDField
parameters can be specified to provide the proper sorting.
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 | ||
analysisExtent : Geometry
Spatial/geographic extent to restrict analysis by. | SummaryReportsParameters | ||
areaIDField : String
The feature/area attribute field used to describe individual areas in the reports (optional). | SummaryReportsParameters | ||
boundaries : Boundaries
A custom geographic region of analysis that will be used in the Summary Reports analysis (required). | SummaryReportsParameters | ||
dataHierarchy : String
Name of a data hierarchy used for generating summary reports. | SummaryReportsParameters | ||
outputReportItems : Array
Array of FolderItem items specifying configuration options for storing
output reports in the repository. | SummaryReportsParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
reportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type. | SummaryReportParameters | ||
reportSummarizationOptions : BAReportSummarizationOptions
Report summarization options. | SummaryReportsParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
ringIDField : String
The feature/area attribute field used to describe individual
areas associated with the same store/point origin (optional). | SummaryReportsParameters | ||
storeIDField : String
The feature/area attribute field used to describe individual store/business/organization
IDs in the Boundaries parameter (optional). | SummaryReportsParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the SummaryReportsParameters class. | SummaryReportsParameters |
analysisExtent | property |
analysisExtent:Geometry
Spatial/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):void
See also
areaIDField | property |
areaIDField:String
The feature/area attribute field used to describe individual areas in the reports (optional).
public function get areaIDField():String
public function set areaIDField(value:String):void
boundaries | property |
boundaries:Boundaries
A custom geographic region of analysis that will be used in the Summary Reports analysis (required).
public function get boundaries():Boundaries
public function set boundaries(value:Boundaries):void
dataHierarchy | property |
dataHierarchy:String
Name of a data hierarchy used for generating summary reports. If this property value is null or empty, the default data hierarchy is used. List of available data hierarchies can be retrieved with Get Data Hierarchies task.
public function get dataHierarchy():String
public function set dataHierarchy(value:String):void
See also
outputReportItems | property |
outputReportItems:Array
Array of FolderItem items specifying configuration options for storing output reports in the repository.
public function get outputReportItems():Array
public function set outputReportItems(value:Array):void
reportSummarizationOptions | property |
reportSummarizationOptions:BAReportSummarizationOptions
Report summarization options.
The default value is BAReportSummarizationOptions.INDIVIDUAL_FEATURES
.
public function get reportSummarizationOptions():BAReportSummarizationOptions
public function set reportSummarizationOptions(value:BAReportSummarizationOptions):void
ringIDField | property |
ringIDField:String
The feature/area attribute field used to describe individual areas associated with the same store/point origin (optional).
public function get ringIDField():String
public function set ringIDField(value:String):void
storeIDField | property |
storeIDField:String
The feature/area attribute field used to describe individual store/business/organization IDs in the Boundaries parameter (optional).
Summary Reports associates this information with the input study areas.
The value for the boundaries
parameter can optionally contain an attribute
field that can be used to uniquely identify the store/business/organization associated
with each area. The value for the storeIDField
parameter creates this association.
public function get storeIDField():String
public function set storeIDField(value:String):void
SummaryReportsParameters | () | Constructor |
public function SummaryReportsParameters()
Creates a new instance of the SummaryReportsParameters class.
var parameters : SummaryReportsParameters = new SummaryReportsParameters(); // 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 the attribute field name in the boundaries layer which is associated with unique area IDs. // "ID" is the default value for areaIDField in the case of StandardLayer. // In other cases, "AREA_ID" is the default value. //parameters.areaIDField = "ID"; // Set report parameters. parameters.reportOptions = [ new ReportOptions("PDF", "Age by Sex Profile"), new ReportOptions("PDF", "Age by Income Profile") ]; summaryReportsTask.execute(parameters, new Responder(resultHandler, faultHandler));