HtmlExport
Namespace: HtmlExport
Table of contents
Type aliases
Functions
Type aliases
CheckCancelCallback
Ƭ CheckCancelCallback: () => boolean
Type declaration
▸ (): boolean
Defines a type of callback that gets called to check if cancellation was requested.
Returns
boolean
HtmlExportResult
Ƭ HtmlExportResult: Object
Export result.
Type declaration
| Name | Type | Description |
|---|---|---|
data |
Blob | string |
Result content. The content is 'string' if 'multiPage = true', otherwise content is zip blob. |
download |
(filename?: string) => void |
Triggers browser download of file with export result. |
HtmlSettings
Ƭ HtmlSettings: Object
Defines HTML export settings.
Type declaration
| Name | Type | Description |
|---|---|---|
autoPrint? |
boolean |
Set to true to add script for a printing page when it is loaded. |
embedImages? |
"none" | "embed" | "external" |
Embed images into HTML. |
multiPage? |
boolean |
Export each page as separate HTML file. |
outputType? |
"html" | "zip" | "auto" |
Export as ZIP archive with HTML files. |
title? |
string |
A title for an HTML page. |
OnProgressCallback
Ƭ OnProgressCallback: (pageNumber: number) => void
Type declaration
▸ (pageNumber): void
Defines a type of callback that gets called after each page is rendered.
Parameters
| Name | Type |
|---|---|
pageNumber |
number |
Returns
void
Functions
exportDocument
▸ exportDocument(source, settings?, onProgress?, checkCancel?): Promise<HtmlExportResult>
Exports a provided PageDocument to the HTML format and returns it as string or Blob.
Parameters
| Name | Type | Description |
|---|---|---|
source |
PageDocument | VDomRenderer |
PageDocument to export. |
settings? |
HtmlSettings |
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 rendering process will be canceled if the function returns true. |
Returns
Promise<HtmlExportResult>