GitHubで見る

Table Export

Bootstrap Table のデータエクスポート拡張機能。複数の形式でのエクスポートをサポートします。

このページ

データエクスポート拡張機能は、テーブルデータを Excel、PDF、CSV などの複数の形式でエクスポートできます。

依存プラグイン

この拡張機能は tableExport.jquery.plugin に依存しています。

注意:一部のエクスポート形式では追加の設定や依存ライブラリが必要な場合があります。上記のドキュメントを参照して設定してください。

使用法

<script src="extensions/export/bootstrap-table-export.js"></script>

Export

オプション

showExport

  • 属性: data-show-export

  • タイプ: Boolean

  • 詳細:

    ツールバーにエクスポートボタンを表示するかどうか。true に設定すると、ユーザーはエクスポートボタンをクリックしてテーブルデータをダウンロードできます。

  • デフォルト値: false

exportDataType

  • 属性: data-export-data-type

  • タイプ: String

  • 詳細:

    エクスポートデータの範囲を設定します:

    • 'basic':現在のページのデータのみをエクスポート
    • 'all':すべてのデータをエクスポート
    • 'selected':選択された行のみをエクスポート
  • デフォルト値: basic

exportFooter

  • 属性: data-export-footer

  • タイプ: Boolean

  • 詳細:

    テーブルフッターも同時にエクスポートするかどうか。true に設定すると、テーブルのフッター行もエクスポートされたファイルに含まれます。

  • デフォルト値: false

exportOptions

  • 属性: data-export-options

  • タイプ: Object

  • 詳細:

    tableExport.jquery.plugin に渡されるエクスポート設定オプション

    その中で exportOptions.fileName は文字列または関数にすることができ、エクスポートファイルの名前を設定するために使用されます:

    exportOptions: {
      fileName: function () {
        return 'exportName'
      }
    }

exportTypes

  • 属性: data-export-types

  • タイプ: Array

  • 詳細:

    使用可能なエクスポート形式のリストを設定します。サポートされている形式には以下が含まれます: jsonxmlpngcsvtxtsqldocexcelxlsxpdf など。

  • デフォルト値: ['json', 'xml', 'csv', 'txt', 'sql', 'excel']

アイコン設定

  • export: 'glyphicon-export icon-share'(エクスポートボタンのアイコン)

列オプション

forceExport

  • 属性: data-force-export

  • タイプ: Boolean

  • 詳細:

    true に設定すると、その列を強制的にエクスポートします(例:非表示列)。

  • デフォルト値: false

forceHide

  • 属性: data-force-hide

  • タイプ: Boolean

  • 詳細:

    true に設定すると、エクスポート時にその列を強制的に非表示にします(例:アイコン列)。

  • デフォルト値: false

イベント

onExportSaved

  • jQuery イベント: export-saved.bs.table

  • パラメータ: exportedRows

  • 詳細:

    データのエクスポートが完了したときにトリガーされます。パラメータには以下が含まれます:

    • exportedRows:エクスポートされた行(exportDataType に依存)。

onExportStarted

  • jQuery イベント: export-started.bs.table

  • パラメータ: undefined

  • 詳細:

    データが収集され、エクスポートされる前にトリガーされます。

メソッド

exportTable

  • パラメータ: options

  • 詳細:

    カスタムオプションを使用してテーブルをエクスポートします。

ローカライゼーション

formatExport

  • パラメータ: undefined

  • デフォルト値: function () { return "Export data" }