V2J
Exports Module HTML ActiveReportsJS API モジュール

HTML モジュール

型の別名

CheckCancelCallback

CheckCancelCallback: (): boolean

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

型宣言

    • (): boolean
    • 戻り値 boolean

HtmlExportResult

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

エクスポート結果。

型宣言

  • data: Blob | string

    エクスポート結果のコンテンツ。 「multiPage = true」の場合、コンテンツは「string」です。それ以外の場合、コンテンツは「zip blob」です。

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

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

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

        • オプション filename: undefined | string

        戻り値 void

HtmlSettings

HtmlSettings: { autoPrint?: undefined | false | true; embedImages?: "none" | "embed" | "external"; multiPage?: undefined | false | true; outputType?: "html" | "zip" | "auto"; title?: undefined | string }

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

型宣言

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

    ページがロードされた後にページを印刷する用のスクリプトを追加するには、trueに設定します。

  • オプション embedImages?: "none" | "embed" | "external"

    画像をHTMLに埋め込みます。

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

    ページを含むZIPアーカイブとしてエクスポートするには、「true」 に設定し、すべてのレポートページを単一のHTMLページとしてエクスポートするには、「false」に設定します。

  • オプション outputType?: "html" | "zip" | "auto"

    HTMLファイルを使用してZIPアーカイブとしてエクスポートします。

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

    HTMLページのタイトル。

OnProgressCallback

OnProgressCallback: (pageNumber: number): void

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

型宣言

    • (pageNumber: number): void
    • 引数

      • pageNumber: number

      戻り値 void

メソッド

exportDocument

  • 指定されたPageDocumentをHTML形式にエクスポートし、文字列またはBLOBとして返します。

    引数

    • source: PageDocument | VDomRenderer

      エクスポートするPageDocument。

    • オプション settings: HtmlSettings

      エクスポート設定。

    • オプション onProgress: OnProgressCallback

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

    • オプション checkCancel: CheckCancelCallback

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

    戻り値 Promise < HtmlExportResult >