グループ化集計の機能概要 (igGrid)

トピックの概要

目的

このトピックでは、igGrid™ のグループ集計機能を紹介します。

このトピックの内容

このトピックは、以下のセクションで構成されます。

• グループ化集計の機能概要
• グループ化集計機能の有効化
  • 基本設定
  • 詳細設定
  • カスタム集計
• 関連コンテンツ

グループ化集計の機能概要

グループ化集計機能は、そのアイランドにあるデータ列の集計情報を表示するグループ データ アイランドの下、上、または上下の両方に追加の集計行を表示します。集計行は、関連するグループが展開された場合のみ表示されます。以下の画像は、グループ化された列を持つグリッドで各グループの下に「Price」列の合計数が集計行に表示されます。

この機能は、データ グループの意味のある集計を提供するためにデフォルトの集計関数 (合計、最小値、最大値、平均値など) の結果、またはカスタム集計の結果を表示できます。

この機能は igGrid 集計機能と組み合わせることが可能でグリッド フッターに全データの集計情報を表示できます。

グループ化集計機能の有効化

基本設定

グループ集計機能を有効にするには、groupSummaries オプションを有効にします。

$("#grid1").igGrid({
     features: [
       {
           name: 'GroupBy',
           groupSummaries: true
       }
    ],
    dataSource: data
});

有効な場合、グリッドは関連の列タイプにデフォルト集計を描画します。 以下は列タイプに基づいたデフォルト列集計です。

以下にデフォルト設定の結果の例を示します。

適用可能な列タイプおよびデフォルト集計に関連するその他のオプションを $.ig.util.defaultSummaryMethods 配列で変更できます。

以下は $.ig.util.defaultSummaryMethods 配列の集計メソッド オブジェクトのオプションです。

詳細設定

以下のリストはメイン集計に関連するオプションについての情報を含みます。

groupSummaries オプションは、true/false に設定して集計を有効/無効にできます。また、その集計タイプを許可するすべての列で適用されるデフォルトの集計メソッドを配列で指定できます。以下の例は「合計」の単一のデフォルト集計の設定を指定することを紹介します。

$("#grid1").igGrid({
   features: [
    {
           name: "GroupBy",
        initialExpand: false,
        groupSummaries: [
            {
                summaryFunction: "Sum",
                label: "Total = "
            }
        ]
     ]
    dataSource: data
});

この集計は、データ型の適用が許可されるすべての列に適用されます。 この例で、「合計」は数値列のみに適用可能ため、グリッドの数値列のみは集計行で「合計」集計が表示されます。

columnSettings.groupSummaries オプションは列で集計の指定を許可します。これは groupSummaries メイン レベル オプションより優先されます。特定の列でこのオプションが設定される場合、この列に関連するメイン groupSummaries オプションからの設定は無視されます。

集計オプションの指定のために使用される groupSummariesObject は以下のプロパティを持ちます:

グリッドの集計行に表示される集計の外観をカスタマイズできます。

カスタム集計

カスタム集計は、データ アイランドからのデータの集計に使用するカスタム関数を指定します。 カスタム集計を設定するには、グループの summaries オブジェクトの summaryFunction プロパティに関数を設定します。

以下のコレクションのいずれかにグループ集計オブジェクトを追加し、カスタム集計に適用する列を決定します。

関数はデータ アイランドのデータを受け、そのデータの集計結果を返します。

カスタム集計の例:

$("#grid1").igGrid({
    features: [
         {
            name: "GroupBy",
            initialExpand: false,
            columnSettings: [
                {
                    columnKey: "ExisitingCustomer",
                    groupSummaries: [
                     {
                         summaryFunction: existingCount,
                         label: "Existing Count: "
                      }
                    ]
                }
        }
    ],
    dataSource: data
 });

function existingCount(data) {
    var i, count = 0; 
    for (i = 0; i < data.length; i++) {
        if(data[i] === "Y"){
           count++;
       }
    }
    return count;
}

関連コンテンツ

関連サンプル

以下のサンプルでは、このトピックに関連する情報を提供しています。

• 集計とグループ化

トピック

このトピックに関連する追加情報については、以下のトピックを参照してください。

• 列のグループ化の有効化 (igGrid)

• グリッドのグループ化のプロパティ リファレンス