Packagecom.esri.ags.tasks.geoEnrichmentClasses
Classpublic class ReportParameters
InheritanceReportParameters Inheritance EnrichParametersBase Inheritance Object

Since : ArcGIS API 3.5 for Flex

Input parameters for an GeoEnrichmentTask.createReport() call.

See also

com.esri.ags.tasks.GeoEnrichmentTask.enrich()


Public Properties
 PropertyDefined By
 InheritedcountryId : String
Optional parameter to explicitly specify the country to query.
EnrichParametersBase
 InheriteddatasetId : String
Optional parameter to explicitly specify the dataset to query.
EnrichParametersBase
  fields : Object
Optional parameter specifies additional choices to customize the headers of reports.
ReportParameters
  format : String = pdf
Optional parameter to specify the format of the generated report.
ReportParameters
 InheritedinSpatialReference : SpatialReference
Optional parameter to define the input geometries in the studyAreas parameter in a specified spatial reference system.
EnrichParametersBase
  navigateToURL : Boolean = true
A flag that determines if calling createReport() automatically download the report by calling navigateToURL().
ReportParameters
  reportId : String
The report id.
ReportParameters
 InheritedstudyAreaOptions : StudyAreaOptions
Optional parameter to specify enrichment behavior.
EnrichParametersBase
 InheritedstudyAreas : Array
Required parameter to specify a list of input features to be enriched.
EnrichParametersBase
Public Constants
 ConstantDefined By
  FORMAT_PDF : String = pdf
[static]
ReportParameters
  FORMAT_XLSX : String = xlsx
[static]
ReportParameters
Property Detail
fieldsproperty
public var fields:Object

Optional parameter specifies additional choices to customize the headers of reports. The following custom header options can be specified:

addressStudy area address text.
areadesc2Area description text.
binarylogoCustom logo graphic specified as MIME64 string.
latitudeStudy area latitude text.
longitudeStudy area longitude text.
logoCustom logo graphic specified as a complete URL reference.
locationnameCustom location name.
reportstyleStyle to get the report in. Available styles are "Screen" and "Paper". Default: "Screen".
titleStudy area report title.

The default value is null.

See also

formatproperty 
public var format:String = pdf

Optional parameter to specify the format of the generated report. Possible values are "pdf" and "xlsx"

The default value is "pdf".

navigateToURLproperty 
public var navigateToURL:Boolean = true

A flag that determines if calling createReport() automatically download the report by calling navigateToURL().

Refer to the documentation of navigateToURL() for the security documentation.

The default value is true.

See also

reportIdproperty 
public var reportId:String

The report id.

The default value is null.

See also

Constant Detail
FORMAT_PDFConstant
public static const FORMAT_PDF:String = pdf

FORMAT_XLSXConstant 
public static const FORMAT_XLSX:String = xlsx