V2J
Exports Module PDF ActiveReportsJS API モジュール

PDF モジュール

型の別名

CheckCancelCallback

CheckCancelCallback: (): boolean

キャンセルする必要があるかどうかを確認するために呼び出されるコールバックの種類を定義します。

型宣言

    • (): boolean
    • 戻り値 boolean

DocumentSecurity

DocumentSecurity: { ownerPassword?: undefined | string; permissions?: Permissions; userPassword?: undefined | string }

文書のセキュリティ設定を定義します。

型宣言

  • オプション ownerPassword?: undefined | string

    ドキュメントを印刷または変更から保護します。Permissionsを参照してください。

  • オプション permissions?: Permissions

    文書のアクセス許可。

  • オプション userPassword?: undefined | string

    パスワードで文書を暗号化します。

OnProgressCallback

OnProgressCallback: (pageNumber: number): void

各ページが描画された後に呼び出されるコールバックの種類を定義します。

型宣言

    • (pageNumber: number): void
    • 引数

      • pageNumber: number

      戻り値 void

PdfExportResult

PdfExportResult: { data: Blob; download: (filename?: undefined | string): void }

エクスポート結果。

型宣言

  • data: Blob

    エクスポート結果のコンテンツ。

  • download: (filename?: undefined | string): void

    ブラウザをエクスポートの結果を含むファイルをダウンロードするためにトリガーします。

      • (filename?: undefined | string): void
      • 引数

        • オプション filename: undefined | string

        戻り値 void

PdfFontDescriptor

PdfFontDescriptor: { name: string; postscriptName?: undefined | string; source: string | string[]; style?: undefined | string; useAsDefault?: undefined | false | true; weight?: undefined | string }

フォントの記述子を定義します。

型宣言

  • name: string

    フォント名。

  • オプション postscriptName?: undefined | string

    フォントのポストスクリプト名。

  • source: string | string[]

    フォントのソース。

  • オプション style?: undefined | string

    フォントスタイル。

  • オプション useAsDefault?: undefined | false | true

    フォントをデフォルトフォントとして使用する場合は、「True」です。

  • オプション weight?: undefined | string

    フォントの太さ。

PdfSettings

PdfSettings: { autoPrint?: undefined | false | true; fonts?: PdfFontDescriptor[]; info?: PdfSettingsInfo; pdfVersion?: PdfVersion; security?: DocumentSecurity }

PDFのエクスポート設定を定義します。

型宣言

  • オプション autoPrint?: undefined | false | true

    ファイルを開くときに文書を印刷します。

  • オプション fonts?: PdfFontDescriptor[]

    使用可能な*.ttfフォントファイル。

  • オプション info?: PdfSettingsInfo

    ドキュメントメタデータ。

  • オプション pdfVersion?: PdfVersion

    PDFのバージョン。

  • オプション security?: DocumentSecurity

    文書のセキュリティ設定。

PdfSettingsInfo

PdfSettingsInfo: { author?: undefined | string; keywords?: undefined | string; subject?: undefined | string; title?: undefined | string }

PDFのメタデータを定義します。

型宣言

  • オプション author?: undefined | string

    作成者。

  • オプション keywords?: undefined | string

    キーワード。

  • オプション subject?: undefined | string

    件名。

  • オプション title?: undefined | string

    タイトル。

PdfVersion

PdfVersion: "1.3" | "1.4" | "1.5" | "1.6" | "1.7" | "1.7ext3"

PDF仕様のバージョン。

Permissions

Permissions: { annotating?: undefined | false | true; contentAccessibility?: undefined | false | true; copying?: undefined | false | true; documentAssembly?: undefined | false | true; modifying?: undefined | false | true; printing?: "lowResolution" | "highResolution" | "none" }

PDFのアクセス許可を定義します。

型宣言

  • オプション annotating?: undefined | false | true

    注釈を許可します。

  • オプション contentAccessibility?: undefined | false | true

    コンテンツアクセシビリティを有効にします。

  • オプション copying?: undefined | false | true

    コピーを許可します。

  • オプション documentAssembly?: undefined | false | true

    ドキュメントのアセンブリを許可します。

  • オプション modifying?: undefined | false | true

    変更を許可します。

  • オプション printing?: "lowResolution" | "highResolution" | "none"

    印刷を許可します。

メソッド

exportDocument

  • 指定されたPageDocumentをPDF形式にエクスポートし、データURI または BLOB として返します。

    引数

    • source: PageDocument | VDomRenderer

      エクスポートするPageDocument。

    • オプション settings: PdfSettings

      エクスポート設定。

    • オプション onProgress: OnProgressCallback

      各シートが描画された後に呼び出されるコールバック。

    • オプション checkCancel: CheckCancelCallback

      各シートが描画される前に呼び出されるコールバック。関数は「true」 を返す場合は、描画処理がキャンセルされます。

    戻り値 Promise < PdfExportResult >

registerPdfFont

  • 非推奨

    FontStore.registerFontsを使用します。

    PDFで使用される.*ttfフォントを登録します。

    引数

    戻り値 void