| Package | com.flexmonster.pivot.vo |
| Class | public class ExportOptions |
| Inheritance | ExportOptions  Object |
| Property | Defined By | ||
|---|---|---|---|
| destinationType : String = file
Defines where the component's content will be exported. | ExportOptions | ||
| excelSheetName : String
Excel only. | ExportOptions | ||
| filename : String
Default name of the resulting file. | ExportOptions | ||
| fontUrl : String
PDF only. | ExportOptions | ||
| footer : String
PDF and HTML only. | ExportOptions | ||
| header : String
PDF and HTML only. | ExportOptions | ||
| pageOrientation : String = portrait
PDF only. | ExportOptions | ||
| showFilters : Object = null
Excel only. | ExportOptions | ||
| showHeaders : Boolean = true
Show grid headers. | ExportOptions | ||
| url : String = ()
To save file to the server you should provide the component with a path to the server-side script which can save this file. | ExportOptions | ||
| useOlapFormattingInExcel : Boolean = true
Excel only. | ExportOptions | ||
| Constant | Defined By | ||
|---|---|---|---|
| PAGE_ORIENTATION_LANDSCAPE : String = landscape [static]
The constant to define landscape page orientation for pdf
| ExportOptions | ||
| PAGE_ORIENTATION_PORTRAIT : String = portrait [static]
The constant to define portrait page orientation for pdf
| ExportOptions | ||
| destinationType | property |
public var destinationType:String = file
Defines where the component's content will be exported. Destination type can be DestinationType.FILE, DestinationType.SERVER or DestinationType.CLIPBOARD. Default value is DestinationType.FILE.
Please note that binary files (image, PDF, Excel) cannot be saved to the clipboard due to the Flash Player security policy.
See also
| excelSheetName | property |
public var excelSheetName:String
Excel only. The name of sheet in the resulting file. Default value is "". If value is "" and the grid title is defined, the grid title will be used as a sheet name.
| filename | property |
public var filename:String
Default name of the resulting file. Default value is "".
| fontUrl | property |
public var fontUrl:StringPDF only. Specifies the path to the external font (TTF) which will be used during exporting. This is optional. Default value is "".
| footer | property |
public var footer:StringPDF and HTML only. Footer in HTML format which is added to exported file. Only limited amount of tags are supported for PDF export: div, p, span, br, img with base64 src, some basic inline styles. The following tokens can be used for PDF export: ##TITLE##, ##CURRENT-DATE##, ##PAGE-NUMBER##, ##TOTAL-PAGES##. They will be replaced by appropriate data. The following tokens can be used for HTML export: ##TITLE##, ##CURRENT-DATE##. They will be replaced by appropriate data.
| header | property |
public var header:StringPDF and HTML only. Header in HTML format which is added to exported file. Only limited amount of tags are supported for PDF export: div, p, span, br, img with base64 src, some basic inline styles. The following tokens can be used for PDF export: ##TITLE##, ##CURRENT-DATE##, ##PAGE-NUMBER##, ##TOTAL-PAGES##. They will be replaced by appropriate data. The following tokens can be used for HTML export: ##TITLE##, ##CURRENT-DATE##. They will be replaced by appropriate data.
| pageOrientation | property |
public var pageOrientation:String = portrait
PDF only. Specifies page orientation. Default value is PAGE_ORIENTATION_PORTRAIT.
| showFilters | property |
public var showFilters:Object = nullExcel only. Indicates whether the filters info will be shown (true) in exported file or not (false). Default value is false.
| showHeaders | property |
public var showHeaders:Boolean = true
Show grid headers. Default value is true.
| url | property |
public var url:String = ()To save file to the server you should provide the component with a path to the server-side script which can save this file.
| useOlapFormattingInExcel | property |
public var useOlapFormattingInExcel:Boolean = trueExcel only. This parameter is useful if the OLAP formatting is applied on the grid (OptionsManager.useOlapFormatting is true). It indicates whether the data cells will be exported as formatted strings (true) or as numbers without applied OLAP format (false). Default value is true.
| PAGE_ORIENTATION_LANDSCAPE | Constant |
public static const PAGE_ORIENTATION_LANDSCAPE:String = landscapeThe constant to define landscape page orientation for pdf
| PAGE_ORIENTATION_PORTRAIT | Constant |
public static const PAGE_ORIENTATION_PORTRAIT:String = portraitThe constant to define portrait page orientation for pdf