TabularDataExport
Namespace: TabularDataExport
Table of contents
类型别名
函数
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>