Packagecom.esri.bao
Classpublic class ReportHeader
InheritanceReportHeader Inheritance BAReportHeader

The ReportHeader class specifies custom report header options available in the Business Analyst Online API.



Public Properties
 PropertyDefined by
  address1 : String
First line of the address field in a report.
ReportHeader
  address2 : String
Second line of the address field in a report.
ReportHeader
  binaryLogo : ByteArray
Custom logo graphic specified as an array of bytes.
ReportHeader
 InheritedcustomHeaders : Object
Custom report header options.
BAReportHeader
  customLogo : String
Custom logo specified as a complete URL reference.
ReportHeader
  latitudeName : String
Custom name of the report latitude field.
ReportHeader
  latitudeValue : String
Value assigned to the report latitude field.
ReportHeader
  locationName : String
Custom location name in the report.
ReportHeader
  longitudeName : String
Custom name of the report longitude field.
ReportHeader
  longitudeValue : String
Value assigned to the report longitude field.
ReportHeader
  siteType : String
Custom site type field name in the report.
ReportHeader
  siteTypeValue : String
Custom value assigned to the site type field in the report.
ReportHeader
  siteUnitsName : String
Custom site units field name in the report.
ReportHeader
  siteUnitsValue : String
Custom value assigned to the site units field in the report.
ReportHeader
  standardGeographyValue : String
Custom value assigned to the standard geography field in the report.
ReportHeader
 Inheritedsubtitle : String
Report subtitle.
BAReportHeader
Public Methods
 MethodDefined by
  
ReportHeader(subtitle:String = null)
Creates a new instance of report header options.
ReportHeader
Property detail
address1property
address1:String  [read-write]

First line of the address field in a report.

Implementation
    public function get address1():String
    public function set address1(value:String):void
address2property 
address2:String  [read-write]

Second line of the address field in a report.

Implementation
    public function get address2():String
    public function set address2(value:String):void
binaryLogoproperty 
binaryLogo:ByteArray  [read-write]

Custom logo graphic specified as an array of bytes. Custom report headers can include a custom logo graphic. A 200 X 200-pixel GIF image is recommended for the logo graphic. The logo graphic can be specified as an array of bytes (binaryLogo) or a complete URL reference to an image (customLogo). The binaryLogo and customLogo properties are mutually exclusive.

Implementation
    public function get binaryLogo():ByteArray
    public function set binaryLogo(value:ByteArray):void
customLogoproperty 
customLogo:String  [read-write]

Custom logo specified as a complete URL reference. Custom report headers can include a custom logo graphic. A 200 X 200-pixel GIF image is recommended for the logo graphic. The logo graphic can be specified as an array of bytes (binaryLogo) or a complete URL reference to an image (customLogo). The binaryLogo and customLogo properties are mutually exclusive.

Implementation
    public function get customLogo():String
    public function set customLogo(value:String):void
latitudeNameproperty 
latitudeName:String  [read-write]

Custom name of the report latitude field.

Implementation
    public function get latitudeName():String
    public function set latitudeName(value:String):void
latitudeValueproperty 
latitudeValue:String  [read-write]

Value assigned to the report latitude field.

Implementation
    public function get latitudeValue():String
    public function set latitudeValue(value:String):void
locationNameproperty 
locationName:String  [read-write]

Custom location name in the report.

Implementation
    public function get locationName():String
    public function set locationName(value:String):void
longitudeNameproperty 
longitudeName:String  [read-write]

Custom name of the report longitude field.

Implementation
    public function get longitudeName():String
    public function set longitudeName(value:String):void
longitudeValueproperty 
longitudeValue:String  [read-write]

Value assigned to the report longitude field.

Implementation
    public function get longitudeValue():String
    public function set longitudeValue(value:String):void
siteTypeproperty 
siteType:String  [read-write]

Custom site type field name in the report.

Implementation
    public function get siteType():String
    public function set siteType(value:String):void
siteTypeValueproperty 
siteTypeValue:String  [read-write]

Custom value assigned to the site type field in the report.

Implementation
    public function get siteTypeValue():String
    public function set siteTypeValue(value:String):void
siteUnitsNameproperty 
siteUnitsName:String  [read-write]

Custom site units field name in the report.

Implementation
    public function get siteUnitsName():String
    public function set siteUnitsName(value:String):void
siteUnitsValueproperty 
siteUnitsValue:String  [read-write]

Custom value assigned to the site units field in the report.

Implementation
    public function get siteUnitsValue():String
    public function set siteUnitsValue(value:String):void
standardGeographyValueproperty 
standardGeographyValue:String  [read-write]

Custom value assigned to the standard geography field in the report.

Implementation
    public function get standardGeographyValue():String
    public function set standardGeographyValue(value:String):void
Constructor detail
ReportHeader()constructor
public function ReportHeader(subtitle:String = null)

Creates a new instance of report header options.

Parameters
subtitle:String (default = null) — Report subtitle.