IDashboardExportTabularOptions

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

IDashboardExportTabularOptions interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Options for exporting dashboard to tabular format.

Signature:

export interface IDashboardExportTabularOptions 

Properties

Property	Modifiers	Type	Description
dashboardFiltersOverride?		FilterContextItem[]	(ALPHA) (Optional) If true, the dashboard filters will be applied to the exported dashboard
exportInfo?		boolean	(ALPHA) (Optional) If true, the export info will be included in the file
format?		"XLSX" | "PDF"	(ALPHA) (Optional) Export format. Defaults to "XLSX" if not specified.
mergeHeaders?		boolean	(ALPHA) (Optional) If true, the headers will be merged into a single row
pdfConfiguration?		{ pageSize?: "A3" | "A4" | "LETTER"; pageOrientation?: "PORTRAIT" | "LANDSCAPE"; showInfoPage?: boolean; }	(ALPHA) (Optional) PDF-specific configuration options. Only applicable when format is "PDF".
title?		string	(ALPHA) (Optional) Title for the export. If not provided, the dashboard title will be fetched.
widgetIds?		string[]	(ALPHA) (Optional) Widgets to export. If not provided, all widgets will be exported.