ExportHelper.exportExcel Method

This method is static.

Parameters

excelOptions

Type: Object

(optional) An object literal with the default values for the following properties:                        
     appendDateToFileName    [type: bool]                                        - Value indicating whether or not the date should be appended to the export filename.
     overrideFileName        [type: String]                                      - The filename to be used for the exported file rather than the system generated name.
     openOnCompletion        [type: bool]                                        - Value indicating whether or not the export file should be opened/downloaded when ready.
     enableOverlay           [type: bool]                                        - Value indicating whether or not an overlay should be shown while export is taking place.            
     selection               [type: dundas.export.ExportSelection]               - Value indicating what will be exported to excel.  Must be one of the following: Entire View, Multiple Items, or All Visible.
     adapterIds              [type: Array, elementType: String]                  - The list of adapter IDs that will be exported to excel.  Can only be used if selection is set to Multiple Items.
     sortableDates           [type: bool]                                        - Value indicating whether or not the dates should be exported so they can be sorted.
     includeParameterValues  [type: bool]                                        - Value indicating whether or not parameter values effecting the data rendered by the adapter should be exported.
     parameterValuesLocation [type: dundas.export.ExcelParameterValuesLocation]  - Value indicating where parameter values should be positioned in the sheet.
     includeImages           [type: bool]                                        - Value indicating whether or not images of the adapters should be exported.
     freezeHeaderRows        [type: bool]                                        - Value indicating whether or not the header rows in excel should be frozen.
     excludeStyles           [type: bool]                                        - Value indicating whether or not styling (fonts, background colors, state coloring, etc.) from tables should be exported.
     skipHeaders             [type: bool]                                        - Value indicating whether or not to skip output of the column headers.
     includeDataImages       [type: bool]                                        - Value indicating whether or not data images should be placed in the Excel sheet.
     baseViewService         [type: dundas.views.BaseViewViewService, optional]  - Required only when exporting a view that's inside a SubCanvasViewContainer.
     view                    [type: dundas.entities.View, optional]              - View to export.  If not specified, view from baseViewService will be used if it was specified, else the current parent view will be exported.
 

Optional: True

Return Value