Package | com.esri.bao.tasks.reports |
Class | public class SummaryReportsParameters |
Inheritance | SummaryReportsParameters SummaryReportParameters BATaskParameters Object |
Report items are sorted by area ID field having the form "storeID_ringID".
If the area ID field has a value non-confirming to this template, the
ringIDField
and storeIDField
properties can be specified to provide the proper sorting.
Output options for this task include creating a feature class for subsequent analysis (outputTypes.getFeatureClass), rendering output image (outputTypes.getMapImage), and creating a report (outputTypes.getReport). If output options are not specified, the report output is requested.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BATaskParameters | ||
areaIDField : String
A feature/area attribute field used to describe individual areas in the reports. | SummaryReportsParameters | ||
boundaries : Boundaries
A custom geographic region of analysis that will be used in the Summary Reports analysis. | SummaryReportsParameters | ||
outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | SummaryReportsParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
reportOptions : Array
Array of summary reports options constisting of items of the ReportOptions type. | SummaryReportParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
ringIDField : String
A feature/area attribute field used to describe individual
areas associated with the same store/point origin. | SummaryReportsParameters | ||
storeIDField : String
A feature/area attribute field used to describe individual store/business/organization
IDs in the Boundaries parameter. | SummaryReportsParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters |
Method | Defined By | ||
---|---|---|---|
SummaryReportsParameters(outputTypes:OutputTypes = null)
Creates a new instance of the SummaryReportsParameters class. | SummaryReportsParameters |
areaIDField | property |
areaIDField:String
A feature/area attribute field used to describe individual areas in the reports.
The default value is "AREA_ID"
.
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.
public function get boundaries():Boundaries
public function set boundaries(value:Boundaries):void
outputSpatialReference | property |
outputSpatialReference:SpatialReference
The spatial reference to return the output feature set in.
public function get outputSpatialReference():SpatialReference
public function set outputSpatialReference(value:SpatialReference):void
ringIDField | property |
ringIDField:String
A feature/area attribute field used to describe individual areas associated with the same store/point origin.
The default value is null
.
public function get ringIDField():String
public function set ringIDField(value:String):void
storeIDField | property |
storeIDField:String
A feature/area attribute field used to describe individual store/business/organization IDs in the Boundaries parameter.
Summary Reports analysis associates this information with the input study areas. The boundaries data layer can optionally contain an attribute field that can be used to uniquely identify the store/business/organization associated with each area. The value of this property creates this association.
The default value is null
.
public function get storeIDField():String
public function set storeIDField(value:String):void
SummaryReportsParameters | () | Constructor |
public function SummaryReportsParameters(outputTypes:OutputTypes = null)
Creates a new instance of the SummaryReportsParameters class.
ParametersoutputTypes:OutputTypes (default = null ) — Task output types.
|
var parameters : SummaryReportsParameters = new SummaryReportsParameters(); // Boundaries could be either of type com.esri.ags.tasks.FeatureSet or com.esri.bacore.StandardLayer. parameters.boundaries = new Boundaries(featureSet); // Set report options. parameters.reportOptions = [ new ReportOptions("PDF", "market_profile", new ReportHeader("Custom title")) ]; // "AREA_ID" is the default value for the areaIDField parameter. //parameters.areaIDField = "AREA_ID"; // getReport is the default option for this task. //parameters.outputTypes.getReport = true; summaryReportsTask.execute(parameters, new Responder(resultHandler, faultHandler));