IExportConfig

IExportConfig.additionalExecutionspropertyAlpha

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

Pre-executed additional layers for multi-layer geo visualizations.

additionalExecutions?: ReadonlyArray<IExportAdditionalExecution>;

Remarks

When set, the export includes one sheet (XLSX) or file (CSV zip) per layer. The result that IExecutionResult.export() is called on is the main layer (index 0); these are the additional layers, in their original order. Each layer carries its own execution result so the backend can build per-layer overrides.

IExportConfig.conditionalFormattingpropertyAlpha

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

Conditional formatting rules to apply when generating the export.

conditionalFormatting?: IConditionalFormatting;

Remarks

Sent as-is; when combined with visualizationObjectId this replaces that visualization’s stored rules rather than merging with them.

IExportConfig.delimiterproperty

Applicable for CSV format; specifies the delimiter to use between values.

delimiter?: string;

IExportConfig.formatproperty

Format of the export file. Defaults to CSV if not specified.

format?: "xlsx" | "csv" | "raw" | "pdf";

IExportConfig.grandTotalsPositionproperty

Position of grand totals in the exported document.

grandTotalsPosition?: "pinnedBottom" | "pinnedTop" | "bottom" | "top";

Remarks

Takes precedence over the position specified in the visualization object. Applicable to all tabular export formats (XLSX, CSV, PDF).

IExportConfig.mergeHeadersproperty

Applicable for XLSX format; indicates whether headers and cells in the sheet should be merged.

mergeHeaders?: boolean;

IExportConfig.pdfConfigurationproperty

Applicable for PDF format; specifies configuration for PDF export.

pdfConfiguration?: IExportPdfConfig;

IExportConfig.showFiltersproperty

Applicable for XLSX, and PDF format; specifies filters to include as comments / metadata in the Excel sheet.

showFilters?: boolean;

Remarks

Filters provided here are purely to paint a better context for the person looking at the exported file. They serve no other purpose and are merely serialized in the export in a human-readable form. The visualizationObjectId has to be provided to make this work for PDF format.

IExportConfig.timeoutproperty

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.

IExportConfig.timezoneIdpropertyAlpha

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

Concrete IANA timezone ID used to resolve relative date filters and render date/time values in the export. Overrides the workspace/user timezone settings.

timezoneId?: string;

IExportConfig.titleproperty

Applicable for XLSX format; specifies title of the workbook.

title?: string;

IExportConfig.visualizationObjectCustomFiltersproperty

Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. (PDF only)

visualizationObjectCustomFilters?: Array<IFilter>;

IExportConfig.visualizationObjectIdproperty

Visualization object identifier. Used to ensure the export result is generated based on existing visualization in the PDF document. (PDF only)

visualizationObjectId?: string;