Packagecom.esri.bao
Classpublic class ReportHeader
InheritanceReportHeader Inheritance BAReportHeader Inheritance Object

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



Public Properties
 PropertyDefined By
  address : String
Store address text.
ReportHeader
  address1 : String
Deprecated Since Community Analyst API for Flex 2.2: Please Use address
First line of the address text.
ReportHeader
  address2 : String
Deprecated Since Community Analyst API for Flex 2.2: Please Use address
Second line of the address text.
ReportHeader
  areaDescription : String
Area description text.
ReportHeader
  binaryLogo : ByteArray
Custom logo graphic specified as an array of bytes.
ReportHeader
 InheritedcustomHeaders : Object
[read-only] Custom report header options.
BAReportHeader
  customLogo : String
Deprecated Since Community Analyst API for Flex 2.2: Please Use logo
Custom logo specified as a complete URL reference.
ReportHeader
  latitude : String
Latitude field text.
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.
ReportHeader
  logo : String
Custom logo specified as a complete URL reference.
ReportHeader
  longitude : String
Longitude field text.
ReportHeader
  longitudeName : String
Custom name of the report longitude field.
ReportHeader
  longitudeValue : String
Value assigned to the report longitude field.
ReportHeader
  siteType : String
Deprecated Since Community Analyst API for Flex 2.2
Custom site type field name (this option isn't supported more).
ReportHeader
  siteTypeValue : String
Deprecated Since Community Analyst API for Flex 2.2
Custom value assigned to the site type field (this option isn't supported more).
ReportHeader
  siteUnitsName : String
Deprecated Since Community Analyst API for Flex 2.2
Custom site units field name (this option isn't supported more).
ReportHeader
  siteUnitsValue : String
Deprecated Since Community Analyst API for Flex 2.2
Custom value assigned to the site units field (this option isn't supported more).
ReportHeader
  standardGeographyValue : String
Deprecated Since Community Analyst API for Flex 2.2
Custom value assigned to the standard geography field (this option isn't supported more).
ReportHeader
 Inheritedsubtitle : String
Report subtitle.
BAReportHeader
  title : String
Custom report title.
ReportHeader
Public Methods
 MethodDefined By
  
ReportHeader(subtitle:String = null)
Creates a new instance of report header options.
ReportHeader
Property Detail
addressproperty
address:String

Since : Community Analyst API for Flex 2.2.

Store address text.


Implementation
    public function get address():String
    public function set address(value:String):void
address1property 
address1:String
Deprecated Since Community Analyst API for Flex 2.2: Please Use address

First line of the address text.

If deprecated address1 and address2 properties are used instead of the address property, their values will be concatenated using comma separator and assigned to the address property when this class instance will be serialized to request parameters.


Implementation
    public function get address1():String
    public function set address1(value:String):void
address2property 
address2:String
Deprecated Since Community Analyst API for Flex 2.2: Please Use address

Second line of the address text.

If deprecated address1 and address2 properties are used instead of the address property, their values will be concatenated using comma separator and assigned to the address property when this class instance will be serialized to request parameters.


Implementation
    public function get address2():String
    public function set address2(value:String):void
areaDescriptionproperty 
areaDescription:String

Since : Community Analyst API for Flex 2.2.

Area description text.


Implementation
    public function get areaDescription():String
    public function set areaDescription(value:String):void
binaryLogoproperty 
binaryLogo:ByteArray

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 (logo). The binaryLogo and logo properties are mutually exclusive.


Implementation
    public function get binaryLogo():ByteArray
    public function set binaryLogo(value:ByteArray):void
customLogoproperty 
customLogo:String
Deprecated Since Community Analyst API for Flex 2.2: Please Use logo

Custom logo specified as a complete URL reference.


Implementation
    public function get customLogo():String
    public function set customLogo(value:String):void
latitudeproperty 
latitude:String

Latitude field text.


Implementation
    public function get latitude():String
    public function set latitude(value:String):void
latitudeNameproperty 
latitudeName:String

Custom name of the report latitude field.

Since Community Analyst API for Flex 2.2, the latitudeName and latitudeValue properties are replaced with the latitude value, but they could be still used for assignment the latitude name and value separately. If you don't assign the latitude property value, but assign the latitudeValue instead, the latitude property will be combined as latitudeName + ": " + latitudeValue when this class instance will be serialized to request parameters.

The default value is "Latitude".


Implementation
    public function get latitudeName():String
    public function set latitudeName(value:String):void
latitudeValueproperty 
latitudeValue:String

Value assigned to the report latitude field.

Since Community Analyst API for Flex 2.2, the latitudeName and latitudeValue properties are replaced with the latitude value, but they could be still used for assignment the latitude name and value separately. If you don't assign the latitude property value, but assign the latitudeValue instead, the latitude property will be combined as latitudeName + ": " + latitudeValue when this class instance will be serialized to request parameters.


Implementation
    public function get latitudeValue():String
    public function set latitudeValue(value:String):void
locationNameproperty 
locationName:String

Custom location name.


Implementation
    public function get locationName():String
    public function set locationName(value:String):void
logoproperty 
logo:String

Since : Community Analyst API for Flex 2.2.

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 (logo). The binaryLogo and logo properties are mutually exclusive.


Implementation
    public function get logo():String
    public function set logo(value:String):void
longitudeproperty 
longitude:String

Longitude field text.


Implementation
    public function get longitude():String
    public function set longitude(value:String):void
longitudeNameproperty 
longitudeName:String

Custom name of the report longitude field.

Since Community Analyst API for Flex 2.2, the longitudeName and longitudeValue properties are replaced with the longitude value, but they could be still used for assignment the longitude name and value separately. If you don't assign the longitude property value, but assign the longitudeValue instead, the longitude property will be combined as longitudeName + ": " + longitudeValue when this class instance will be serialized to request parameters.

The default value is "Longitude".


Implementation
    public function get longitudeName():String
    public function set longitudeName(value:String):void
longitudeValueproperty 
longitudeValue:String

Value assigned to the report longitude field.

Since Community Analyst API for Flex 2.2, the longitudeName and longitudeValue properties are replaced with the longitude value, but they could be still used for assignment the longitude name and value separately. If you don't assign the longitude property value, but assign the longitudeValue instead, the longitude property will be combined as longitudeName + ": " + longitudeValue when this class instance will be serialized to request parameters.


Implementation
    public function get longitudeValue():String
    public function set longitudeValue(value:String):void
siteTypeproperty 
siteType:String
Deprecated Since Community Analyst API for Flex 2.2

Custom site type field name (this option isn't supported more).


Implementation
    public function get siteType():String
    public function set siteType(value:String):void
siteTypeValueproperty 
siteTypeValue:String
Deprecated Since Community Analyst API for Flex 2.2

Custom value assigned to the site type field (this option isn't supported more).


Implementation
    public function get siteTypeValue():String
    public function set siteTypeValue(value:String):void
siteUnitsNameproperty 
siteUnitsName:String
Deprecated Since Community Analyst API for Flex 2.2

Custom site units field name (this option isn't supported more).


Implementation
    public function get siteUnitsName():String
    public function set siteUnitsName(value:String):void
siteUnitsValueproperty 
siteUnitsValue:String
Deprecated Since Community Analyst API for Flex 2.2

Custom value assigned to the site units field (this option isn't supported more).


Implementation
    public function get siteUnitsValue():String
    public function set siteUnitsValue(value:String):void
standardGeographyValueproperty 
standardGeographyValue:String
Deprecated Since Community Analyst API for Flex 2.2

Custom value assigned to the standard geography field (this option isn't supported more).


Implementation
    public function get standardGeographyValue():String
    public function set standardGeographyValue(value:String):void
titleproperty 
title:String

Since : Community Analyst API for Flex 2.2.

Custom report title.


Implementation
    public function get title():String
    public function set title(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) — Custom report subtitle.