| FRAMES | NO FRAMES | |
Options of a report to be generated.
class ReportOptions
| Property | Description |
|---|---|
| AreaTitleField (optional) | Dynamic header field that will list a string description based on the value of the input FeatureSet's attribute field assigned to this property. See Remarks below. Type String. |
| LocationNameField (optional) | Dynamic header field that will list a string description based on the value of the input FeatureSet's attribute field assigned to this property. See Remarks below. Type String. |
| MapOptions (unsupported) | (Future functionality which is currently unsupported) |
| ReportFormat | Required format of report. Type String. |
| ReportHeader (optional) | Array of key/value pairs specifying header properties to be customized. Type KeyValue[]. |
| StoreAddressField (optional) | Dynamic header field that will list a string description based on the value of the input FeatureSet's attribute field assigned to this property. See Remarks below. Type String. |
| StoreLatitudeField (optional) | Dynamic header field that will list a string description based on the value of the input FeatureSet's attribute field assigned to this property. See Remarks below. Type String. |
| StoreLongitudeField (optional) | Dynamic header field that will list a string description based on the value of the input FeatureSet's attribute field assigned to this property. See Remarks below. Type String. |
| TemplateName | Report template name. Type String. |
See Get Report Templates to retrieve a list of available report templates and the supported custom fields/headers for each template.
"Dynamic Report Header Fields" are supported with the Summary Reports service. In order to support dynamic report headers, DataLayer as FeatureSet must be specified for the Summary Reports service Boundaries parameter and the AreaTitleField, LocationNameField, StoreAddressField, StoreLatitudeField, and StoreLongitudeField, if any, in the ReportOptions instance must contain the attribute field name(s) in the input FeatureSet that will be used to populate the dyanamic fields.
Use the GetReportTemplates lookup operation to query available report templates, formats, and customizable header fields.