IDashboardExportTabularOptions

IDashboardExportTabularOptions.dashboardFiltersOverridepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

If true, the dashboard filters will be applied to the exported dashboard

dashboardFiltersOverride?: FilterContextItem[];

IDashboardExportTabularOptions.dashboardTabsFiltersOverridespropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Override stored dashboard filters per tab with custom filters

dashboardTabsFiltersOverrides?: FiltersByTab;

IDashboardExportTabularOptions.dashboardTabsParametersOverridespropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Per-tab parameter overrides. Key is tabId; values drive AFM execution and info-sheet rendering for that tab’s sub-export. Mirrors dashboardTabsFiltersOverrides.

dashboardTabsParametersOverrides?: Record<string, IDashboardExportParameter[]>;

IDashboardExportTabularOptions.exportInfopropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

If true, the export info will be included in the file

exportInfo?: boolean;

IDashboardExportTabularOptions.formatpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export format. Defaults to “XLSX” if not specified.

format?: "XLSX" | "PDF";

IDashboardExportTabularOptions.mergeHeaderspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

If true, the headers will be merged into a single row

mergeHeaders?: boolean;

IDashboardExportTabularOptions.pdfConfigurationpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

PDF-specific configuration options. Only applicable when format is “PDF”.

pdfConfiguration?: {
        pageSize?: "A3" | "A4" | "LETTER";
        pageOrientation?: "PORTRAIT" | "LANDSCAPE";
        showInfoPage?: boolean;
    };

IDashboardExportTabularOptions.timeoutpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Override the default export result polling timeout (in milliseconds).

timeout?: number;

Remarks

If not specified, there is still a default timeout applied. You can use this to make the timeout more aggressive or more relaxed than the default. We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.

IDashboardExportTabularOptions.titlepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Title for the export. If not provided, the dashboard title will be fetched.

title?: string;

IDashboardExportTabularOptions.widgetIdspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Widgets to export. If not provided, all widgets will be exported.

widgetIds?: string[];