[{"id":"0916473b-83fc-4a60-8609-02f91e8b1c34","tags":[]},{"id":"7132754a-4c4c-4ff9-a430-06e21c266171","tags":[]},{"id":"f07e4430-8605-4a45-8f8d-0853dbbf0b67","tags":[]},{"id":"66d528a4-f9c5-4684-9488-0a2a0169bf50","tags":[]},{"id":"52374753-a491-4926-80e3-1114a5aadc44","tags":[]},{"id":"787341a3-d970-4540-84ac-19ee64f0dbe2","tags":[]},{"id":"d44deed9-eae7-4df6-9fe8-1a114f316cdc","tags":[]},{"id":"db162604-9c16-4513-bd1b-1fff9790fcb2","tags":[]},{"id":"aa4305c5-df80-44b2-8a02-278524f919c1","tags":[]},{"id":"e16a581c-44c0-45af-99d3-3d54fc371d1d","tags":[]},{"id":"7c8ea105-1d11-46ff-9a56-3eb70dfd5958","tags":[]},{"id":"1dc18e5f-ddec-48d3-a6dc-4906881cf537","tags":[]},{"id":"3dbcc70b-09a5-4814-983e-4fcaf3a84ece","tags":[]},{"id":"e393d03d-1603-455b-9f38-52ea7b3934a6","tags":[]},{"id":"ddb7b27e-e503-474b-a5c4-5fd4b9f92f58","tags":[]},{"id":"f6ef6590-5d1e-483d-99da-6f7615b96065","tags":[]},{"id":"9d7dceaa-bfdb-4865-bd6e-7c8dfcec2d61","tags":[]},{"id":"16796d76-24d8-4ace-b4ad-84838fc00ae0","tags":[]},{"id":"c01d715e-e359-4a3d-9f68-8ff89deaaa97","tags":[]},{"id":"a47419f2-f009-4931-9b67-99399c32dfef","tags":[]},{"id":"131eb4bf-5169-4136-92b3-9b62db0052dd","tags":[]},{"id":"afed2c6f-a981-4b65-8198-9d554775cc58","tags":[]},{"id":"1a97d9a4-f978-413e-9f4d-a90139ac8e4f","tags":[]},{"id":"a98b4526-e99f-4060-895b-aa61baf20f13","tags":[]},{"id":"2f38c0ec-cd81-428f-81a5-abbd06a66196","tags":[]},{"id":"93b7867e-ec84-4f9e-b8bb-acbee73dc50c","tags":[]},{"id":"c8ea308b-fa39-4c39-9f43-b934f3cb8747","tags":[]},{"id":"ed51f39d-4ede-48d5-8632-bec35012c0fe","tags":[]},{"id":"d2fbaa32-1e7f-4281-aefd-c263009fa347","tags":[]},{"id":"a592e7dd-928d-4842-a48e-c30463d382bd","tags":[]},{"id":"142944fe-13da-4bc1-bf72-da37bd7f5cbd","tags":[]},{"id":"ee3085a1-3b3b-4569-89f8-dbc5404ede96","tags":[]},{"id":"7ede5633-cdbc-4ba2-a7ca-dfe5881dcaf3","tags":[]},{"id":"042d12e3-6361-430d-aa43-ee0366b5df1f","tags":[]},{"id":"8fb0ecc0-92a7-4865-b5ea-fac9f79ec715","tags":[]}]
        
(Showing Draft Content)

TabularDataExport

Namespace: TabularDataExport

Table of contents

Type aliases

Functions

Type aliases

CheckCancelCallback

Ƭ CheckCancelCallback: () => boolean

Type declaration

▸ (): boolean

The type of callback that gets called before sheet rendering, the render process will be canceled if the function returns true.

Returns

boolean


CsvSettings

Ƭ CsvSettings: Object

Csv export settings.

Type declaration

Name Type Description
colSeparator? string Columns separator character
outputType? "zip" | "plain" Export each table as separate file ('zip') or combine it to single CSV
quotationSymbol? string Quotation symbol
rowSeparator? string Rows separator character
tableSeparator? string Tables separator character

OnProgressCallback

Ƭ OnProgressCallback: (pageNumber: number) => void

Type declaration

▸ (pageNumber): void

The type of callback that gets called after each sheet is rendered.

Parameters
Name Type
pageNumber number
Returns

void


TabularDataExportResult

Ƭ TabularDataExportResult: Object

Export result

Type declaration

Name Type Description
data Blob | string Result content.
download (filename?: string) => void Triggers browser download of file with export result.

TabularDataSettings

Ƭ TabularDataSettings: Object

Tabular Data export settings.

Type declaration

Name Type Description
csvSettings? CsvSettings CSV export settings
format? "csv" Export format

Functions

exportDocument

exportDocument(source, settings?, onProgress?, checkCancel?): Promise<TabularDataExportResult>

Exports a provided PageDocument to the Tabular Data format and returns it as Blob or string.

Parameters

Name Type Description
source PageDocument | VDomRenderer The document to export.
settings? TabularDataSettings Export settings.
onProgress? OnProgressCallback The callback that gets called after each sheet is rendered.
checkCancel? CheckCancelCallback The callback that gets called before sheet rendering, the render process will be canceled if the function returns true.

Returns

Promise<TabularDataExportResult>