Package | com.esri.bacore |
Class | public class ReportOptions |
Inheritance | ReportOptions Object |
Implements | IJsonObject |
The report header
property is optional.
The report format
property is required.
The templateName
is required in summary reports.
Other properties specify binding of fields of a boundary layer with summary report header fields.
See also
Property | Defined By | ||
---|---|---|---|
areaTitleField : String
Area description attribute field name in a boundary layer used as a source for summary report. | ReportOptions | ||
format : String
Report format (required). | ReportOptions | ||
header : BAReportHeader
Custom report header parameters (optional). | ReportOptions | ||
locationNameField : String
Location attribute field name in a boundary layer used as a source for summary report. | ReportOptions | ||
storeAddressField : String
Store address attribute field name in a boundary layer used as a source for summary report. | ReportOptions | ||
storeLatitudeField : String
Store latitude attribute field name in a boundary layer used as a source for summary report. | ReportOptions | ||
storeLongitudeField : String
Store longitude attribute field name in a boundary layer used as a source for summary report. | ReportOptions | ||
templateName : String
Report template name. | ReportOptions |
Method | Defined By | ||
---|---|---|---|
ReportOptions(format:String = null, templateName:String = null, header:BAReportHeader = null)
Creates a new instance of the ReportOptions object. | ReportOptions |
areaTitleField | property |
areaTitleField:String
Area description attribute field name in a boundary layer used as a source for summary report.
The default value is "AREA_DESC2"
.
public function get areaTitleField():String
public function set areaTitleField(value:String):void
format | property |
format:String
Report format (required).
public function get format():String
public function set format(value:String):void
header | property |
header:BAReportHeader
Custom report header parameters (optional).
public function get header():BAReportHeader
public function set header(value:BAReportHeader):void
locationNameField | property |
locationNameField:String
Location attribute field name in a boundary layer used as a source for summary report.
The default value is "SITE_NAME"
.
public function get locationNameField():String
public function set locationNameField(value:String):void
storeAddressField | property |
storeAddressField:String
Store address attribute field name in a boundary layer used as a source for summary report.
The default value is "STORE_ADDR"
.
public function get storeAddressField():String
public function set storeAddressField(value:String):void
storeLatitudeField | property |
storeLatitudeField:String
Store latitude attribute field name in a boundary layer used as a source for summary report.
The default value is "STORE_LAT"
.
public function get storeLatitudeField():String
public function set storeLatitudeField(value:String):void
storeLongitudeField | property |
storeLongitudeField:String
Store longitude attribute field name in a boundary layer used as a source for summary report.
The default value is "STORE_LONG"
.
public function get storeLongitudeField():String
public function set storeLongitudeField(value:String):void
templateName | property |
templateName:String
Report template name. The template name is used in summary reports only. It should be a valid report name returned by a Get Report Templates task.
public function get templateName():String
public function set templateName(value:String):void
See also
ReportOptions | () | Constructor |
public function ReportOptions(format:String = null, templateName:String = null, header:BAReportHeader = null)
Creates a new instance of the ReportOptions object.
Parametersformat:String (default = null ) — The report format.
| |
templateName:String (default = null ) — The report template name.
| |
header:BAReportHeader (default = null ) — The report header. Allows a customization of report header parameters.
|