グループ化された行に、折り畳みインジケーター ツールチップを指定します。

        //Initialize
        $(".selector").igGrid({
            features: [
                {
                    name: "GroupBy",
                    collapseTooltip: "Collapse group"
                }
            ]
        });
        
        //Get
        var opValue = $(".selector").igGridGroupBy("option", "collapseTooltip");
        
        //Set
        $(".selector").igGridGroupBy("option", "collapseTooltip", "Collapse group");
	  

グリッドが列でグループ化されるかどうか、グループ化を列で許可するかなど、各列の設定を取得または設定します。

 
        //Initialize
        $(".selector").igGrid({
            features: [
                {
                    name: "GroupBy",
                    columnSettings: [
                        { columnKey: "Name", isGroupBy: true },
						{ columnKey: "BoxArt", allowGrouping: false }
                    ]
                }
            ]
        });
        
        //Get
        var arrayOfColumnSettings = $(".selector").igGridGroupBy("option", "columnSettings");
      

• allowGrouping

  タイプ:

  bool

  デフォルト:

  true

  グループ化に参加する列を有効/無効にします。デフォルトでは、すべての列をグループ化できます。

  コード サンプル

   
              //Initialize
              $(".selector").igGrid({
                  features: [
                      {
                          name: "GroupBy",
                          columnSettings: [
  						    { columnKey: "Name", allowGrouping: false }
                          ]
                      }
                  ]
              });
              
             	//Get
  			      var groupBySettings = $(".selector").igGridGroupBy("option", "columnSettings");
  			      var allowGroupingFirstColumn = groupBySettings[0].allowGrouping;
            

• compareFunc

  タイプ:

  enumeration

  デフォルト:

  null

  カスタム比較に使用される関数 (文字列または関数) への参照。
  関数は以下の引数を受け取ります:
  val1: 比較する最初の値
  val2: 比較する 2 番目の値
  recordsData - 3 つのプロパティを持つオブジェクト: fieldName - 並べ替えたフィールドの名前; record1 - 比較する最初のレコード; record2 - 比較する 2 番目のレコード
  関数は以下の数値を返します:
  0 - 値が等しい場合
  1 - val1 > val2 の場合
  -1 - val1 < val2 の場合

  メンバー

  • string
  • タイプ:string
  • グローバル ウィンドウ オブジェクトにある文字列としての関数名。
  • function
  • タイプ:function
  • カスタム比較で使用される関数。

  コード サンプル

   
  					//Initialize
              $(".selector").igGrid({
                  features: [
                      {
                          name: "GroupBy",
                          columnSettings: [
  												{
  													columnKey: "ProductID", 
  													isGroupBy: true,
  													compareFunc: function(a, b, recordsData) {
  														return a > b ? 1 : a < b ? -1 : 0;
  													}
  												}
                         ]
                      }
                  ]
              });
  					

• dir

  タイプ:

  enumeration

  デフォルト:

  asc

  並べ替え方向 (昇順または降順) を指定します。

  コード サンプル

    
            //Initialize
            $(".selector").igGrid({
                features: [
                    {
                        name: "GroupBy",
                        columnSettings: [
                            { columnKey: "Name", dir: "desc" }
                        ]
                    }
                ]
            });
            

• groupComparerFunction

  非推奨

  タイプ:

  function

  デフォルト:

  null

  関数ごとにカスタム グループを指定します。これは列設定、比較する最初と 2 番目の値を受け入れ、ブールを返します。このオプションは非推奨です。compareFunc オプションを使用してください。

  コード サンプル

               
            //Initialize
  			    $(".selector").igGrid({
  				    features: [
  					    {
  						    name: "GroupBy",
  						    columnSettings: [{ 
  							    columnKey: "Name", 
  							    groupComparerFunction: function (columnSetting, val1, val2) {
  								    return (val1 === val2);
  							    } 
  						    }]
  					    }
  				    ]
  			    });          
          

• groupLabelFormatter

  タイプ:

  enumeration

  デフォルト:

  null

  セル値を書式設定するために使用される関数への参照。この関数は、グループ化された列値を許可し、行ラベルの新しい書式設定値を返します。

  メンバー

  • string
  • タイプ:string
  • グローバル ウィンドウ オブジェクトにある文字列としての関数名。
  • function
  • タイプ:function
  • セル値を書式設定するために使用される関数。

  コード サンプル

   
            //Initialize
  			    $(".selector").igGrid({
  				    features: [
  					    {
  						    name: "GroupBy",
  						    columnSettings: [{ 
  							    columnKey: "Name", 
  							    groupLabelFormatter: function(val) {return (val === 1)? "Yes" : "No";}
  						    }]
  					    }
  				    ]
  			    });	 
            
            //Get
  			    var groupBySettings = $(".selector").igGridGroupBy("option", "columnSettings");
  			    var labelFormatterFirstColumn = groupBySettings[0].groupLabelFormatter; 
            

• isGroupBy

  タイプ:

  bool

  デフォルト:

  false

  デフォルトで列をグループ化するかどうかを指定します。

  コード サンプル

             
              //Initialize
  			      $(".selector").igGrid({
  				      features: [
  					      {
  						      name: "GroupBy",
  						      columnSettings: [
  							      { columnKey: "Name", isGroupBy: true }
  						      ]
  					      }
  				      ]
  			      });	 
             

• summaries

  タイプ:

  object

  デフォルト:

  []

  各グループの列値で計算するための集計関数のリスト。

  コード サンプル

   
              //Initialize
  			      $(".selector").igGrid({
  				      features: [
  					      {
  						      name: "GroupBy",
  						      columnSettings: [
  							      //	The code in this example specifies that data must be grouped by 
  							      //	the Color column and the average, the minimum and the maximum of 
  							      //	the ListPrice column must be calculated and displayed for each group.
  							      { 
  								      columnKey: "Color", 
  								      isGroupBy: true
  							      },
  							      {
  								      columnKey: "ListPrice",
  								      allowGrouping: false,
  								      summaries: [
  									      {
  										      summaryFunction: "avg", text: " average:"
  									      },
  									      {
  										      summaryFunction: "min", text: " minimal:"
  									      },
  									      {
  										      summaryFunction: "max", text: " maximal:"
  									      }
  								      ]
  							      }
  						      ]
  					      }
  				      ]
  			      });	
            

  • customSummary

    タイプ:

    enumeration

    デフォルト:

    null

    各グループで呼び出されるカスタム集計関数を指定します。カスタム集計結果を返します。次の定義があるオブジェクトを引数として受けます: {dataRecords: [], array: [], key: "", allGroupData: []}
    dataRecords - data view でグループ化されるデータ レコードの配列
    array - 指定した列のセル値の配列
    key - グループ化された列のキー
    allGroupData - グループのデータ レコードの配列 (データ ビューだけでなく、データ ソース全体)。

    メンバー

    • string
    • タイプ:string
    • グローバル ウィンドウ オブジェクトにある文字列としての関数名。
    • function
    • タイプ:function
    • 集計値を計算するために使用される関数。

    コード サンプル

    				//Initialize
    				$(".selector").igGrid({
    					features: [
    						{
    							name: "GroupBy",
    							columnSettings: [
    								{ 
    									columnKey: "Color", 
    									isGroupBy: true
    								},
    								{
    									columnKey: "ListPrice",
    									allowGrouping: false,
    									summaries: [
    										{
    											//	Set average price summary value
    											summaryFunction: "avg", text: " average:"
    										},
    										{
    											//	Set a custom function to calculate the difference between 
    											//	the minimum and the maximum values in the group
    											summaryFunction: "custom",
    											text: " delta:",
    											customSummary: function(valuesList) {
    												//	Initialize minmum and maximum values with the first element
    												var min = valuesList[1], max = valuesList[1];
    												//	Iterate all values in the list and find minimum and maximum
    												for(i = 1; i < valuesList.length; i++) {
    													if(valuesList[i] < min)	min = valuesList[i];
    													if(valuesList[i] > max)	max = valuesList[i];
    												}
    												//	Return difference between minimum and maximum
    												return (max - min);
    											}
    										}
    									]
    								}
    							]
    						}
    					]
    				});	
    			  

  • summaryFunction

    タイプ:

    enumeration

    デフォルト:

    avg

    集計関数

    メンバー

    • avg
    • タイプ:string
    • 平均集計関数。
    • min
    • タイプ:string
    • 最小集計関数。
    • max
    • タイプ:string
    • 最大集計関数。
    • sum
    • タイプ:string
    • 合計集計関数。
    • count
    • タイプ:string
    • カウント集計関数。
    • custom
    • タイプ:string
    • カスタム集計関数。

    コード サンプル

                 
                    //Initialize
                    $(".selector").igGrid({
                        features: [{
                            name: "GroupBy",
                            columnSettings: [{
                                columnKey: "Name",
                                summaries: [{
                                    summaryFunction: "Avg"
                                }]
                            }]
                        }]
                    });
                

  • text

    タイプ:

    string

    デフォルト:

    null

    値の前に表示される Summary テキストを指定します。

    コード サンプル

                 
                  //Initialize
                  $(".selector").igGrid({
                      features: [{
                          name: "GroupBy",
                          columnSettings: [{
                              columnKey: "Name",
                              summaries: [{
                                  summaryFunction: "Avg",
                                  text: "Average:"
                              }]
                          }]
                      }]
                  });
                

デフォルトの並べ替え順序 - 昇順または降順。

        //Initialize
            $(".selector").igGrid({
                features: [
                    {
                        name: "GroupBy",
                        defaultSortingDirection: "desc"
                    }
                ]
            });

            //	Get
            var defaultDireciton = $(".selector").igGridGroupBy("option", "defaultSortingDirection");

            //	Set
            $(".selector").igGridGroupBy("option", "defaultSortingDirection", "desc");
      

使用するダイアログ ウィジェットの名前。 $.ui.igGridModalDialog から継承します。詳細については、igGrid モーダル ダイアログの拡張 トピックを参照してください。

 
        //create dialog widget that inherits from $.ui.igGridModalDialog
          $.widget("ui.CustomDialog", $.ui.igGridModalDialog, {});
           //Initialize
        $(".selector").igGrid({
            features : [
                {
                    name : "GroupBy",
                   dialogWidget: "CustomDialog"
                }
            ]
        });
        
		    //Get
        var dialogWidget = $(".selector").igGridGroupBy("option", "dialogWidget");
          

グループ化された列がない場合に GroupBy 領域に表示されるリンクのテキスト。

 
        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                emptyGroupByAreaContent: "Put here columns to group by"
            }]
        });

        //	Get
        var opValue = $(".selector").igGridGroupBy("option", "emptyGroupByAreaContent");
         

グループ化ダイアログを開くリンク テキスト。

 
        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                emptyGroupByAreaContentSelectColumns: "Select Columns to Group By"
            }]
        });

        //	Get
        var text = $(".selector").igGridGroupBy("option", "emptyGroupByAreaContentSelectColumns");

        //	Set
        $(".selector").igGridGroupBy("option", "emptyGroupByAreaContentSelectColumns", "Select Columns to Group By");
      

グループ化ダイアログを開くボタンのキャプションを指定します。

 
        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                emptyGroupByAreaContentSelectColumnsCaption: "Select Columns to Group By"
            }]
        });

        //	Get
        var text = $(".selector").igGridGroupBy("option", "emptyGroupByAreaContentSelectColumnsCaption");

        //	Set
        $(".selector").igGridGroupBy("option", "emptyGroupByAreaContentSelectColumnsCaption", "Select Columns to Group By");
      

グループ化された行に対する拡張インジケーター ツールチップを指定します。

        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                expandTooltip: "Custom expand tooltip"
            }]
        });

        //	Get
        var opValue = $(".selector").igGridGroupBy("option", "expandTooltip");

        //	Set
        $(".selector").igGridGroupBy("option", "expandTooltip", "Custom expand tooltip");
        

グループ化された行に、エンド ユーザーが展開・折り畳むことができる展開画像が含まれるかどうかを指定します。このオプションは初期化のみに設定できます。

         
        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                expansionIndicatorVisibility: true
            }]
        });

        //	Get
        var opValue = $(".selector").igGridGroupBy("option", "expansionIndicatorVisibility");
        

groupBy 領域が置かれるグリッドの場所を設定します。

         
        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                groupByAreaVisibility: "bottom"
            }]
        });

        //	Get
        var opValue = $(".selector").igGridGroupBy("option", "groupByAreaVisibility");

        //	Set
        $(".selector").igGridGroupBy("option", "groupByAreaVisibility", "hidden");
        

グループ化ダイアログのコンテインメント動作を管理します。
owner - グループ化ダイアログはグリッド領域でのみドラッグ可能です。
window - グループ化ダイアログはウィンドウ領域全体でドラッグ可能です。

 
      //Initialize
        $(".selector").igGrid({
            features: [
                {
                    name : "GroupBy",
                    groupByDialogContainment : "window"
              }
            ]
        });

        //Get
        var groupByDialogContainment = $(".selector").igGridGroupBy("option", "groupByDialogContainment");

      

デフォルトでは、ヘッダーの列幅を使用します。指定される場合、すべてのヘッダーのために使用されます。

        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                groupByLabelWidth: 100
            }]
        });

        //	Get
        var opValue = $(".selector").igGridGroupBy("option", "groupByLabelWidth");

        //	Set
        $(".selector").igGridGroupBy("option", "groupByLabelWidth", 100);
		

GroupBy expression を指定する URL パラメーター名。groupByUrlKey, groupByUrlKeyAscValue および groupByUrlKeyDescValue を設定した場合、要求は次のようになります: ?<groupByUrlKey>(<columnKey>)=<groupByUrlKeyAscValue/groupByUrlKeyDescValue> (例: ?groupby(col1)=asc)。そうでない場合、並べ替えパラメーターのための OData 変換が使用されます。

 
      //Initialize
      $(".selector").igGrid({
          features : [
              {
                  name : "GroupBy",
                  groupByUrlKey: "myCustomGroupBy",
							    groupByUrlKeyAscValue : "myAsc",
							    groupByUrlKeyDescValue : "myDesc"
              }
          ]
      });
 
      //Get
      var groupByUrlKey = $(".selector").igGridGroupBy("option", "groupByUrlKey");
 
      //Set
      $(".selector").igGridGroupBy("option", "groupByUrlKey", "myGroupBy");
      

昇順のグループ化を示す URL パラメーター値です。groupByUrlKey の場合、groupByUrlKey, groupByUrlKeyAscValue および groupByUrlKeyDescValue を設定すると要求は次のようになります: ?<groupByUrlKey>(<columnKey>)=<groupByUrlKeyAscValue/groupByUrlKeyDescValue> (例: ?groupby(col1)=asc)。

 
      //Initialize
      $(".selector").igGrid({
          features : [
              {
                  name : "GroupBy",
                  groupByUrlKey: "myCustomGroupBy",
                  groupByUrlKeyAscValue : "myAsc",
							    groupByUrlKeyDescValue : "myDesc"
              }
          ]
      });
 
      //Get
      var groupByAsc = $(".selector").igGridGroupBy("option", "groupByUrlKeyAscValue");
 
      //Set
      $(".selector").igGridGroupBy("option", "groupByUrlKeyAscValue", "myAsc");
      

降順のグループ化を示す URL パラメーター値です。groupByUrlKey の場合、groupByUrlKeyAscValue および groupByUrlKeyDescValue を設定すると次のようになります: ?<groupByUrlKey>(<columnKey>)=<groupByUrlKeyAscValue/groupByUrlKeyDescValue> (Example: ?groupby(col1)=asc)。

 
       //Initialize
      $(".selector").igGrid({
          features : [
              {
                  name : "GroupBy",
                  groupByUrlKey: "myCustomGroupBy",
                  groupByUrlKeyAscValue : "myAsc",
                  groupByUrlKeyDescValue : "myDesc"
              }
          ]
      });
 
      //Get
      var groupByDesc = $(".selector").igGridGroupBy("option", "groupByUrlKeyDescValue");
 
      //Set
      $(".selector").igGridGroupBy("option", "groupByUrlKeyDescValue", "myDesc");
      

現在のグループ化される列のリストを返します。このオプションは読み取り専用で、初期化またはランタイムに設定できません。

		    //	Get
		    var groupedColumns = $(".selector").igGridGroupBy("option", "groupedColumns");
		
		    //	Enumerates all grouped columns
		    for(i = 0; i < groupedColumns.length; i++) {
			    //	Get column object
			    var col = groupedColumns[i].col;
			
			    //	Get the sort order for this column
			    var dir = groupedColumns[i].dir;
			
			    //	Get the key of the grouped column
			    var key = groupedColumns[i].key;
			
			    //	Get the key of the columnLayour if this is hierarchical view
			    var layout = groupedColumns[i].layout;
		    }
		  

• col

  タイプ:

  object

  デフォルト:

  null

  グループ化された列の column オブジェクト。

  コード サンプル

  			      //	Get
  			      var groupedColumns = $(".selector").igGridGroupBy("option", "groupedColumns");
  			
  			      //	Enumerates all grouped columns
  			      for(i = 0; i < groupedColumns.length; i++) {
  				      //	Get column object
  				      var col = groupedColumns[i].col;			
  			      }
            

• dir

  タイプ:

  enumeration

  デフォルト:

  asc

  並べ替え順 - 昇順または降順。

  コード サンプル

         
  			      //	Get
  			      var groupedColumns = $(".selector").igGridGroupBy("option", "groupedColumns");
  			
  			      //	Enumerates all grouped columns
  			      for(i = 0; i < groupedColumns.length; i++) {
  				      //	Get the sort order for this column
  				      var dir = groupedColumns[i].dir;
  			      }
            

• key

  タイプ:

  string

  デフォルト:

  null

  グループ化された列のキー。

  コード サンプル

  			      //	Get
  			      var groupedColumns = $(".selector").igGridGroupBy("option", "groupedColumns");
  			
  			      //	Enumerates all grouped columns
  			      for(i = 0; i < groupedColumns.length; i++) {
  				      //	Get the key of the grouped column
  				      groupedColumns.key
  			      }
            

• layout

  タイプ:

  string

  デフォルト:

  null

  グリッドが階層型の場合の columnLayout のキー。

  コード サンプル

  			      //	Get
  			      var groupedColumns = $(".selector").igGridGroupBy("option", "groupedColumns");
  			
  			      //	Enumerates all grouped columns
  			      for(i = 0; i < groupedColumns.length; i++) {
  				      //	Get the key of the columnLayour if this is hierarchical view
  				      var layout = groupedColumns[i].layout;
  			      }
            

jQuery のテンプレート 作成ガイドラインに付随する、グループ化された行のテキストのテンプレート。テンプレートの利用可能な変数は ${key}、${val}、および ${count} です。

           
        //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    groupedRowTextTemplate: "Cost $ ${val} (Count: ${count})"
				    }
			    ]
		    });

		    //	Get
		    var opValue = $(".selector").igGridGroupBy("option", "groupedRowTextTemplate");
		
		    //	Set
		    $(".selector").igGridGroupBy("option", "groupedRowTextTemplate", "Cost $ ${val} (Count: ${count})");
      

グループ化された行の字下げを指定します。複数の列がグループ化された場合、全体の字下げは大きくなります。

         
            //Initialize
            $(".selector").igGrid({
                features: [
                    {
                        name: "GroupBy",
                        indentation: 50
                    }
                ]
            });

            //	Get
            var opValue = $(".selector").igGridGroupBy("option", "indentation");

            //	Set
            $(".selector").igGridGroupBy("option", "indentation", 50);
		  

子レイアウトで機能継承を有効または無効にします。注: igHierarchicalGrid のみに適用します。

グループ化の後に、グループ化された行を最初に展開または折り畳むかどうかを指定します。このオプションは初期化のみに設定できます。

         
		    //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    initialExpand: false
				    }
			    ]
		    }); 

		    //	Get
		    var opValue = $(".selector").igGridGroupBy("option", "initialExpand");

		    //	Set
		    $(".selector").igGridGroupBy("option", "initialExpand", false);
     

列ヘッダーがドラッグされている間の、ドラッグ マークアップの不透明性を指定します。値は 0 と 1 の間である必要があります。

         
        //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    labelDragHelperOpacity: 0.75
				    }
			    ]
		    });  

		    //	Get
		    var opValue = $(".selector").igGridGroupBy("option", "labelDragHelperOpacity");

		    //	Set
		    $(".selector").igGridGroupBy("option", "labelDragHelperOpacity", 0.75);
      

モーダル ダイアログを表示または非表示にするアニメーション時間をミリ秒で指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogAnimationDuration: 300
				    }
			    ]
		    });  

		    //	Get
		    var duration = $(".selector").igGridGroupBy("option", "modalDialogAnimationDuration");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogAnimationDuration", 200);
      

モーダル ダイアログで変更を適用するボタンのテキストを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogButtonApplyText: "Apply"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogButtonApplyText");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogButtonApplyText", "Apply");
      

モーダル ダイアログで変更をキャンセルするボタンのテキストを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogButtonCancelText: "Cancel"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogButtonCancelText");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogButtonCancelText", "Cancel");
      

グループ化ダイアログで昇順に並べ替えられた各列のキャプションを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogCaptionButtonAsc: "Acsending"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogCaptionButtonAsc");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogCaptionButtonAsc", "Acsending");
      

グループ化ダイアログで降順に並べ替えられた各列のキャプションを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogCaptionButtonDesc: "Descending"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogCaptionButtonDesc");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogCaptionButtonDesc", "Descending");
      

グループ化ダイアログでキャプション ボタン グループ化解除を指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogCaptionButtonUngroup: "Ungroup"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogCaptionButtonUngroup");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogCaptionButtonUngroup", "Ungroup");
      

グループ化ダイアログでキャプション テキストを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogCaptionText: "Modal Dialog"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogCaptionText");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogCaptionText", "Modal Dialog");
      

グループ化ダイアログですべてをクリア ボタンのラベルを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogClearAllButtonLabel: "Clear All"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogClearAllButtonLabel");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogClearAllButtonLabel", "Clear All");
      

グループ化ダイアログでレイアウト ドロップダウンの幅を指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogDropDownAreaWidth: 300
				    }
			    ]
		    });  

		    //	Get
		    var width = $(".selector").igGridGroupBy("option", "modalDialogDropDownAreaWidth");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogDropDownAreaWidth", 300);
      

グループ化ダイアログでレイアウト ドロップダウン ボタンのキャプションを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogDropDownButtonCaption: "Layouts"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogDropDownButtonCaption");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogDropDownButtonCaption", "Layouts");
      

グループ化ダイアログでレイアウト ドロップダウンのラベルを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogDropDownLabel: "Layouts"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogDropDownLabel");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogDropDownLabel", "Layouts");
      

グループ化ダイアログでレイアウト ドロップダウンの幅を指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogDropDownWidth: 300
				    }
			    ]
		    });  

		    //	Get
		    var width = $(".selector").igGridGroupBy("option", "modalDialogDropDownWidth");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogDropDownWidth", 300);
      

グループ化ダイアログでグループ化ボタンのテキストを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogGroupByButtonText: "Group"
				    }
			    ]
		    });  

		    //	Get
		    var text = $(".selector").igGridGroupBy("option", "modalDialogGroupByButtonText");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogGroupByButtonText", "Group");
            

グループ化ダイアログでクリックして列を直ちにグループ化するか、それともグループ化解除するかを指定します。false の場合、グループ化ダイアログに適用ボタンが表示されます。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogGroupByOnClick: true
				    }
			    ]
		    });  

		    //	Get
		    var onClick = $(".selector").igGridGroupBy("option", "modalDialogGroupByOnClick");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogGroupByOnClick", true); 
            

グループ化ダイアログの高さを指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogHeight: 500
				    }
			    ]
		    });  

		    //	Get
		    var height = $(".selector").igGridGroupBy("option", "modalDialogHeight");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogHeight", 500); 
      

レイアウト ツリー ダイアログに表示されるルート レイアウトの名前を指定します。

             
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogRootLevelHierarchicalGrid: "Root Layout"
				    }
			    ]
		    });  

		    //	Get
		    var rootLabel = $(".selector").igGridGroupBy("option", "modalDialogRootLevelHierarchicalGrid");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogRootLevelHierarchicalGrid", "Root Layout"); 

グループ化ダイアログの幅を指定します。

 
            //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    modalDialogWidth: 300
				    }
			    ]
		    });  

		    //	Get
		    var width = $(".selector").igGridGroupBy("option", "modalDialogWidth");

		    //	Set
		    $(".selector").igGridGroupBy("option", "modalDialogWidth", 300); 
      

状態間でグループ化の永続化を有効/無効にします。詳細については、GroupBy の永続化 を参照できます。

    //Initialize
    $(".selector").igGrid({
        features : [
            {
                name : "GroupBy",
                persist : false
            }
        ]
    });

    //Get
    var persist = $(".selector").igGridGroupBy("option", "persist");

    //Set
    $(".selector").igGridGroupBy("option", "persist", false);
  

削除ボタンのツールチップを指定します。

            //Initialize
            $(".selector").igGrid({
                features: [
                    {
                        name: "GroupBy",
                        removeButtonTooltip: "Do not group by this column"
                    }
                ]
            });  

            //	Get
            var opValue = $(".selector").igGridGroupBy("option", "removeButtonTooltip");

            //	Set
            $(".selector").igGridGroupBy("option", "removeButtonTooltip", "Do not group by this column");
	    

group by データを応答から取得するためのキーを指定します。このオプションは初期化のみに設定できます。

		    //	Get
		    var opValue = $(".selector").igGridGroupBy("option", "resultResponseKey");

		    //	Set
		    $(".selector").igGridGroupBy("option", "resultResponseKey", "Cost");
	    

GroupBy 集計の設定を指定します。

         
        //Initialize
        $(".selector").igGrid({
            features: [{
                name: "GroupBy",
                summarySettings: {
                    multiSummaryDelimiter: " | ",
                    summaryFormat: "#0.00"
                }
            }]
        });

        //	Get
        var opValue = $(".selector").igGridGroupBy("option", "summarySettings");

        //	Set
        $(".selector").igGridGroupBy("option", "summarySettings", {
            multiSummaryDelimiter: " | ",
            summaryFormat: "#0.00"
        });
      

• multiSummaryDelimiter

  タイプ:

  string

  デフォルト:

  ","

  サマリーをグループ化された行内にインラインで描画する場合、複数サマリーに対する区切り文字を指定します。

  コード サンプル

           
              //Initialize
              $(".selector").igGrid({
                  features: [{
                      name: "GroupBy",
                      summarySettings: {
                          multiSummaryDelimiter: " | "
                      }
                  }]
              });
  
              //	Get
              var summarySettings = $(".selector").igGridGroupBy("option", "summarySettings");
              //	Get the value of multiSummaryDelimiter
              summarySettings.multiSummaryDelimiter
  
              //	Set
               //	Get current summary settings and set a new value to multiSummaryDelimiter
              var summarySettings = $(".selector").igGridGroupBy("option", "summarySettings");
              summarySettings.multiSummaryDelimiter = " | ";
              //	Set the new value to the widget
              $(".selector").igGridGroupBy("option", "summarySettings", summarySettings);
            

• summaryFormat

  タイプ:

  string

  デフォルト:

  "#.00"

  集計値の形式。デフォルトでは、小数位以下 2 桁が表示されます。有効な書式指定子については、日付、数値、および文字列の書式設定を参照してください。

  コード サンプル

              //Initialize
              $(".selector").igGrid({
                  features: [{
                      name: "GroupBy",
                      summarySettings: {
                          summaryFormat: "#0.00"
                      }
                  }]
  
                  //	Get
                  var summarySettings = $(".selector").igGridGroupBy("option", "summarySettings");
                  //	Get the value of summaryFormat
                  summarySettings.summaryFormat
  
                  //	Set
                  //	Get current summary settings and set a new value to summaryFormat
                  var summarySettings = $(".selector").igGridGroupBy("option", "summarySettings");
                  summarySettings.summaryFormat = "#0.00";
                  //	Set the new value to the widget
                  $(".selector").igGridGroupBy("option", "summarySettings", summarySettings);
              });
            

groupBy 操作がクライアント側に実行するか、サーバー側に実行するかどうかを指定します。

        //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    type: "local"
				    }
			    ]
		    });

		    //	Get
		    var opValue = $(".selector").igGridGroupBy("option", "type");

		    //	Set
		    $(".selector").igGridGroupBy("option", "type", "local");
      

igGrid.columns.formatter または igGrid.columns.format で設定したフォーマッターを使用したグループ化列の書式設定。

       //Initialize
		    $(".selector").igGrid({
			    features: [
				    {
					    name: "GroupBy",
					    useGridColumnFormatter: false
				    }
			    ]
		    });

		    //	Get
		    var useGridColumnFormatter = $(".selector").igGridGroupBy("option", "useGridColumnFormatter");

		    //	Set
		    $(".selector").igGridGroupBy("option", "useGridColumnFormatter", false);