HtmlExport
名前空間: HtmlExport
Table of contents
型の別名
関数
型の別名
CheckCancelCallback
Ƭ CheckCancelCallback: () => boolean
型宣言
▸ (): boolean
キャンセルする必要があるかどうかを確認するために呼び出されるコールバックの種類を定義します。
戻り値
boolean
HtmlExportResult
Ƭ HtmlExportResult: Object
エクスポート結果。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
data |
Blob | string |
エクスポート結果のコンテンツ。「multiPage = true」の場合、コンテンツは「string」です。それ以外の場合、コンテンツは「zip blob」です。 |
download |
(filename?: string) => void |
ブラウザをエクスポートの結果を含むファイルをダウンロードするためにトリガーします。 |
HtmlSettings
Ƭ HtmlSettings: Object
HTMLのエクスポート設定を定義します。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
autoPrint? |
boolean |
ページがロードされた後にページを印刷する用のスクリプトを追加するには、trueに設定します。 |
embedImages? |
"none" | "embed" | "external" |
画像をHTMLに埋め込みます。 |
multiPage? |
boolean |
各ページを個別のHTMLファイルとしてエクスポートします。 |
outputType? |
"html" | "zip" | "auto" |
HTMLファイルを使用してZIPアーカイブとしてエクスポートします。 |
title? |
string |
HTMLページのタイトル。 |
OnProgressCallback
Ƭ OnProgressCallback: (pageNumber: number) => void
型宣言
▸ (pageNumber): void
各ページが描画された後に呼び出されるコールバックの種類を定義します。
パラメータ
| 名前 | 型 |
|---|---|
pageNumber |
number |
戻り値
void
関数
exportDocument
▸ exportDocument(source, settings?, onProgress?, checkCancel?): Promise<HtmlExportResult>
指定されたPageDocumentをHTML形式にエクスポートし、文字列またはBLOBとして返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
source |
PageDocument | VDomRenderer |
エクスポートするPageDocument。 |
settings? |
HtmlSettings |
エクスポート設定。 |
onProgress? |
OnProgressCallback |
各シートが描画された後に呼び出されるコールバック。 |
checkCancel? |
CheckCancelCallback |
各シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合、描画処理がキャンセルされます。 |
戻り値
Promise<HtmlExportResult>