Package | com.esri.bao.tasks.reports |
Class | public class BenchmarkReportParameters |
Inheritance | BenchmarkReportParameters StandardReportParameters BATaskParameters Object |
The benchmarkOptions
property specifies how to create the benchmark area:
Value | Description |
---|---|
BenchmarkOptions.USE_ONE_OF_THE_TRADE_AREAS
| selects the benchmark area by OID from the benchmark layer
(the benchmarkLayer and benchmarkAreaOID properties should be specified) |
BenchmarkOptions.USE_AVERAGE_VALUES
| creates the benchmark area by calculating average summarization values for all areas in trade area layers |
BenchmarkOptions.USE_MEDIAN_VALUES
| creates the benchmark area by calculating median summarization values for all areas in trade area layers |
BenchmarkOptions.USE_NONE
| means no benchmark (creates a report without comparison with benchmark) |
The taInRows
property determines the orientation of the summarization fields in the report:
true
value outputs the report with the summarization fields
in columns and the trade areas in rows.false
value (default) outputs the report with the summarization fields in rows and
the trade areas in columns.The fieldSortType
property specifies the sorting rules based on the sortFieldName
field:
Value | Description |
---|---|
BenchmarkSortOptions.SORT_NONE
| means no sorting |
BenchmarkSortOptions.SORT_BY_FIELD_ONLY
| sorts by the field itself |
BenchmarkSortOptions.SORT_BY_FIELD_DIFFERENCE
| sorts by calculated difference between the field value and the benchmark field value |
BenchmarkSortOptions.SORT_BY_FIELD_PERCENT
| sorts by calculating percent of the field value with respect to the benchmark field value |
BenchmarkSortOptions.SORT_BY_FIELD_INDEX
| sorts by the field index (available for some summarization fields) |
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 | ||
benchmarkAreaOID : int
OID of area from the benchmarkLayer layer to be used as a benchmark area. | BenchmarkReportParameters | ||
benchmarkLayer : Boundaries
Data layer used for calculating the benchmark area. | BenchmarkReportParameters | ||
benchmarkOptions : BenchmarkOptions
Benchmark area calculation method. | BenchmarkReportParameters | ||
fieldSortType : BenchmarkSortOptions
Report fields sorting options. | BenchmarkReportParameters | ||
outputTypes : OutputTypes
Task output types. | BATaskParameters | ||
resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | ||
sortFieldName : String
Name of a summarization field the field sorting will be based on. | BenchmarkReportParameters | ||
standardReportOptions : ReportOptions
Standard report options. | StandardReportParameters | ||
summarizations : Array
Array of names of variables the trade areas will be summarized by and compared with the benchmark. | BenchmarkReportParameters | ||
taInRows : Boolean
Report layout options. | BenchmarkReportParameters | ||
taLayersFields : Array
Array of names of fields of trade area layers that will appear in the report. | BenchmarkReportParameters | ||
taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | ||
tradeAreas : Array
Array containing one or more trade area layers to produce the benchmark report for. | BenchmarkReportParameters |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of the BenchmarkReportParameters class. | BenchmarkReportParameters |
benchmarkAreaOID | property |
benchmarkAreaOID:int
OID of area from the benchmarkLayer
layer to be used as a benchmark area.
Value of -1 means that OID is missing.
This property should be specified if benchmarkOptions
property is BenchmarkOptions.USE_ONE_OF_THE_TRADE_AREAS
.
The default value is -1
.
public function get benchmarkAreaOID():int
public function set benchmarkAreaOID(value:int):void
benchmarkLayer | property |
benchmarkLayer:Boundaries
Data layer used for calculating the benchmark area.
This property should be specified if benchmarkOptions
property is BenchmarkOptions.USE_ONE_OF_THE_TRADE_AREAS
.
public function get benchmarkLayer():Boundaries
public function set benchmarkLayer(value:Boundaries):void
benchmarkOptions | property |
benchmarkOptions:BenchmarkOptions
Benchmark area calculation method.
The default value is BenchmarkOptions.USE_NONE
.
public function get benchmarkOptions():BenchmarkOptions
public function set benchmarkOptions(value:BenchmarkOptions):void
fieldSortType | property |
fieldSortType:BenchmarkSortOptions
Report fields sorting options.
The default value is BenchmarkSortOptions.SORT_NONE
.
public function get fieldSortType():BenchmarkSortOptions
public function set fieldSortType(value:BenchmarkSortOptions):void
sortFieldName | property |
sortFieldName:String
Name of a summarization field the field sorting will be based on.
This property should be specified if fieldSortType
property value
is any except BenchmarkSortOptions.SORT_NONE
.
public function get sortFieldName():String
public function set sortFieldName(value:String):void
summarizations | property |
summarizations:Array
Array of names of variables the trade areas will be summarized by and compared with the benchmark. Available summarization fields can be retrieved from the Get Summarizations task. Type array of String items.
public function get summarizations():Array
public function set summarizations(value:Array):void
See also
taInRows | property |
taInRows:Boolean
Report layout options. The "trade areas in rows" layout is used by default.
The default value is true
.
public function get taInRows():Boolean
public function set taInRows(value:Boolean):void
taLayersFields | property |
taLayersFields:Array
Array of names of fields of trade area layers that will appear in the report. Type array of String items.
public function get taLayersFields():Array
public function set taLayersFields(value:Array):void
tradeAreas | property |
tradeAreas:Array
Array containing one or more trade area layers to produce the benchmark report for. The array should contain items of the Boundaries type.
public function get tradeAreas():Array
public function set tradeAreas(value:Array):void
See also
BenchmarkReportParameters | () | Constructor |
public function BenchmarkReportParameters()
Creates a new instance of the BenchmarkReportParameters class.
var parameters : BenchmarkReportParameters = new BenchmarkReportParameters(); // BenchmarkOptions.USE_NONE is the default value for benchmarkOptions. parameters.benchmarkOptions = BenchmarkOptions.USE_AVERAGE_VALUES; parameters.fieldSortType = BenchmarkSortOptions.SORT_BY_FIELD_DIFFERENCE; parameters.sortFieldName = "TOTPOP_CY"; parameters.summarizations = [ "TOTPOP_CY", "TOTHH_CY" ]; // true is the default value for taInRows. parameters.taInRows = false; parameters.taLayersFields = [ "STORE_ID" ]; // Trade areas can be either a feature set or standard layers. parameters.tradeAreas = [ taLayer1, taLayer2 ]; // Set report options. var reportOptions:ReportOptions = new ReportOptions("PDF"); reportOptions.header = new ReportHeader("Benchmark Report for two rings"); parameters.standardReportOptions = reportOptions; benchmarkReportTask.execute(parameters, new Responder(resultHandler, faultHandler));