exportDashboardToExcel()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the IExportDashboardToExcel command. Dispatching this command will result in a request to export the dashboard to a EXCEL file. If successful, an instance of IDashboardExportToExcelResolved will be emitted with the URL of the resulting file.
export declare function exportDashboardToExcel(mergeHeaders: boolean, exportInfo: boolean, widgetIds?: string[], fileName?: string, format?: "XLSX" | "PDF", pdfConfiguration?: PdfConfiguration, correlationId?: string): IExportDashboardToExcel;
Parameters
Parameter | Type | Description |
|---|---|---|
mergeHeaders | boolean | if true, the headers will be merged into a single row |
exportInfo | boolean | if true, the export info will be included in the EXCEL file |
widgetIds | string[] | (Optional) if provided, the widgets with the given ids will be exported |
fileName | string | (Optional) if provided, the file will be saved with the given name |
format | “XLSX” | “PDF” | (Optional) |
pdfConfiguration | (Optional) | |
correlationId | string | (Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns