IExportConfig

Home > @gooddata/sdk-backend-spi > IExportConfig

IExportConfig interface

Configuration for exports of results into tabular formats.

Signature:

export interface IExportConfig

Properties

PropertyModifiersTypeDescription
format?"xlsx" | "csv" | "raw" | "pdf"(Optional) Format of the export file. Defaults to CSV if not specified.
mergeHeaders?boolean(Optional) Applicable for XLSX format; indicates whether headers and cells in the sheet should be merged.
pdfConfiguration?IExportPdfConfig(Optional) Applicable for PDF format; specifies configuration for PDF export.
showFilters?boolean(Optional) Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in the Excel sheet.
title?string(Optional) Applicable for XLSX format; specifies title of the workbook.
visualizationObjectCustomFilters?Array<IFilter>(Optional) Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (PDF only)
visualizationObjectId?string(Optional) Visualization object identifier. Used to ensure the export result is generated based on existing visualization in the PDF document. (PDF only)
← IExecutionResultIExportDefinitionsQuery →