PdfExport
名前空間: PdfExport
Table of contents
型の別名
- CheckCancelCallback
- DocumentSecurity
- OnProgressCallback
- PdfExportResult
- PdfFontDescriptor
- PdfSettings
- PdfSettingsInfo
- PdfVersion
- Permissions
関数
型の別名
CheckCancelCallback
Ƭ CheckCancelCallback: () => boolean
型宣言
▸ (): boolean
キャンセルする必要があるかどうかを確認するために呼び出されるコールバックの種類を定義します。
戻り値
boolean
DocumentSecurity
Ƭ DocumentSecurity: Object
文書のセキュリティ設定を定義します。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
ownerPassword? |
string |
ドキュメントを印刷または変更から保護します。[Permissions](PdfExport#permissions)を参照してください。 |
permissions? |
Permissions |
文書のアクセス許可。 |
userPassword? |
string |
パスワードで文書を暗号化します。 |
OnProgressCallback
Ƭ OnProgressCallback: (pageNumber: number) => void
型宣言
▸ (pageNumber): void
各ページが描画された後に呼び出されるコールバックの種類を定義します。
パラメータ
| 名前 | 型 |
|---|---|
pageNumber |
number |
戻り値
void
PdfExportResult
Ƭ PdfExportResult: Object
エクスポート結果。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
data |
Blob |
エクスポート結果のコンテンツ。 |
download |
(filename?: string) => void |
ブラウザをエクスポートの結果を含むファイルをダウンロードするためにトリガーします。 |
PdfFontDescriptor
Ƭ PdfFontDescriptor: Object
フォントの記述子を定義します。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
name |
string |
フォント名。 |
postscriptName? |
string |
フォントのポストスクリプト名。 |
source |
string | string[] |
フォントのソース。 |
style? |
string |
フォントスタイル。 |
useAsDefault? |
boolean |
フォントをデフォルトフォントとして使用する場合は、「True」です。 |
weight? |
string |
フォントの太さ。 |
PdfSettings
Ƭ PdfSettings: Object
PDFのエクスポート設定を定義します。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
autoPrint? |
boolean |
ファイルを開くときに文書を印刷します。 |
fonts? |
PdfFontDescriptor[] |
使用可能なttfフォントファイル。 |
info? |
PdfSettingsInfo |
ドキュメントメタデータ。 |
pdfVersion? |
PdfVersion |
PDFバージョン。 |
security? |
DocumentSecurity |
文書のセキュリティ設定。 |
PdfSettingsInfo
Ƭ PdfSettingsInfo: Object
PDFのメタデータを定義します。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
author? |
string |
作成者。 |
keywords? |
string |
キーワード。 |
subject? |
string |
件名。 |
title? |
string |
タイトル。 |
PdfVersion
Ƭ PdfVersion: "1.3" | "1.4" | "1.5" | "1.6" | "1.7" | "1.7ext3" | "PDF/A-2b" | "PDF/A-3b"
PDF仕様のバージョン。
Permissions
Ƭ Permissions: Object
PDFのアクセス許可を定義します。
型宣言
| 名前 | 型 | 説明 |
|---|---|---|
annotating? |
boolean |
注釈を許可します。 |
contentAccessibility? |
boolean |
コンテンツアクセシビリティを有効にします。 |
copying? |
boolean |
コピーを許可します。 |
documentAssembly? |
boolean |
ドキュメントのアセンブリを許可します。 |
modifying? |
boolean |
変更を許可します。 |
printing? |
"lowResolution" | "highResolution" | "none" |
印刷を許可します。 |
関数
exportDocument
▸ exportDocument(source, settings?, onProgress?, checkCancel?): Promise<PdfExportResult>
指定されたPageDocumentをPDF形式にエクスポートし、データURI または BLOB として返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
source |
PageDocument | VDomRenderer |
クスポートするPageDocument。 |
settings? |
PdfSettings |
エクスポート設定。 |
onProgress? |
OnProgressCallback |
各シートが描画された後に呼び出されるコールバック。 |
checkCancel? |
CheckCancelCallback |
各シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合、描画処理がキャンセルされます。 |
戻り値
Promise<PdfExportResult>