V2J
Exports Module Xlsx ActiveReportsJS API モジュール

Xlsx モジュール

型の別名

CheckCancelCallback

CheckCancelCallback: (): boolean

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

型宣言

    • (): boolean
    • 戻り値 boolean

OnProgressCallback

OnProgressCallback: (pageNumber: number): void

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

型宣言

    • (pageNumber: number): void
    • 引数

      • pageNumber: number

      戻り値 void

PageSettings

PageSettings: { orientation?: "portrait" | "landscape"; size?: PageSize }

ページの設定。

型宣言

  • オプション orientation?: "portrait" | "landscape"

    ページの向き。

  • オプション size?: PageSize

    ページのサイズ。

PageSize

PageSize: "Letter" | "Legal" | "Executive" | "A4" | "A5" | "B5" | "Envelope_10" | "Envelope_DL" | "Envelope_C5" | "Envelope_B5" | "Envelope_Monarch" | "Double_Japan_Postcard_Rotated" | "K16_197x273_mm"

ページのサイズ。

XlsxExportResult

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

エクスポート結果。

型宣言

  • data: Blob

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

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

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

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

        • オプション filename: undefined | string

        戻り値 void

XlsxSettings

XlsxSettings: { info?: XlsxSettingsInfo; pageSettings?: PageSettings; password?: undefined | string; sheetName?: undefined | string }

Xlsxのエクスポート設定。

型宣言

  • オプション info?: XlsxSettingsInfo

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

  • オプション pageSettings?: PageSettings

    ページ設定。

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

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

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

    シート名の接頭辞(例:”Sheet_”)。

XlsxSettingsInfo

XlsxSettingsInfo: { creator?: undefined | string }

Xlsxの情報。

型宣言

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

    作成者。

メソッド

exportDocument

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

    引数

    • source: PageDocument | VDomRenderer

      エクスポートする文書。

    • オプション settings: XlsxSettings

      エクスポート設定。

    • オプション onProgress: OnProgressCallback

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

    • オプション checkCancel: CheckCancelCallback

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

    戻り値 Promise < XlsxExportResult >