ExportHelper.exportExcel Method

This method is static.

Parameters

excelOptions

Type: Object

(optional) An object literal with values for the following properties:
     appendDateToFileName    [type: bool, optional]                                  - Specify true if the date should be included in the export filename.
     fileNameDatePlacement   [type: dundas.export.ExportFileNamePlacement, optional] - Optionally customize where to include the date when appending/adding it to the filename.
     fileNameDateFormat      [type: String, optional]                                - Optionally customize the date format to use when including the date.
     overrideFileName        [type: String, optional]                                - The filename to be used for the exported file rather than the system generated name.
     openOnCompletion        [type: bool, optional]                                  - Indicates whether to open/download the export file when ready. The default value is true.
     enableOverlay           [type: bool, optional]                                  - Indicates whether to show an overlay while exporting. The default value is true.
     selection               [type: dundas.export.ExportSelection, optional]         - Indicates what to export. Must be ENTIRE_VIEW, MULTIPLE_ITEMS, or ALL_VISIBLE. The default value is ENTIRE_VIEW.
     adapterIds              [type: Array, elementType: String, optional]            - The list of adapter IDs that will be exported to excel. Only used if selection is set to MULTIPLE_ITEMS.
     sortableDates           [type: bool, optional]                                  - Indicates whether or not the dates should be exported so they can be sorted. The default value is true.
     includeParameterValues  [type: bool, optional]                                  - Specify true if parameter values affecting the data rendered by the adapter should be exported.
     parameterValuesLocation [type: dundas.export.ExcelParameterValuesLocation, optional] - Indicates where parameter values should be positioned in the sheet. The default value is BOTTOM.
     includeImages           [type: bool, optional]                                  - Specify true if images of the adapters should be exported.
     freezeHeaderRows        [type: bool, optional]                                  - Specify true if the header rows in excel should be frozen.
     excludeStyles           [type: bool, optional]                                  - Specify true to exclude styling (fonts, background colors, state coloring, etc.) from tables and report text.
     skipHeaders             [type: bool, optional]                                  - Specify true to skip output of the column headers.
     includeDataImages       [type: bool, optional]                                  - Specify true if 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