Packagecom.esri.bacore
Classpublic class ReportOptions
InheritanceReportOptions Inheritance Object
Implements IJsonObject

The ReportOptions class specifies an output report format, a template name, and a custom header.

The report header property is optional. The report format property is required. The templateName is required in summary reports.

See also

SummaryReportParameters
StandardReportParameters


Public Properties
 PropertyDefined By
  format : String
Report format (required).
ReportOptions
  header : BAReportHeader
Custom report header parameters (optional).
ReportOptions
  templateName : String
Report template name.
ReportOptions
Public Methods
 MethodDefined By
  
ReportOptions(format:String = null, templateName:String = null, header:BAReportHeader = null)
Creates a new instance of the ReportOptions object.
ReportOptions
Property Detail
formatproperty
format:String

Report format (required).


Implementation
    public function get format():String
    public function set format(value:String):void
headerproperty 
header:BAReportHeader

Custom report header parameters (optional).


Implementation
    public function get header():BAReportHeader
    public function set header(value:BAReportHeader):void
templateNameproperty 
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.


Implementation
    public function get templateName():String
    public function set templateName(value:String):void

See also

Constructor Detail
ReportOptions()Constructor
public function ReportOptions(format:String = null, templateName:String = null, header:BAReportHeader = null)

Creates a new instance of the ReportOptions object.

Parameters
format: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.