このオプションは 2017.2 バージョン以降サポートされません。
グループ化された行に、折り畳みインジケーター ツールチップを指定します。locale.collapseTooltip オプションを使用します。

 
				//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(val1, val2, recordsData) {
  												return val1 > val2 ? 1 : val1 < val2 ? -1 : 0;
  											}
  										}
  								]
  								}
  							]
  						});
  					 

• dir

  タイプ:

  enumeration

  デフォルト:

  asc

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

  コード サンプル

   
  						//Initialize
  						$(".selector").igGrid({
  							features: [
  								{
  									name: "GroupBy",
  									columnSettings: [
  										{ columnKey: "Name", isGroupBy: true, 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;
  					 

• groupSummaries

  タイプ:

  enumeration

  デフォルト:

  []

  グループのデータ アイランドごとにデフォルト集計を有効/無効にするか、グループに関係なく特定の列に適用する集計を指定します。

  コード サンプル

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

  • format

    タイプ:

    string

    デフォルト:

    null

    集計値の書式設定を適用します。
    Tこの format オプションはデフォルトで null 値で使用されません。列書式設定が指定される場合、それが使用されます。
    このオプションと列書式設定が指定されていない場合、autoFormat オプションに基づいて地域設定を使用するかどうかを決定します。

    コード サンプル

     
    								//Initialize
    								$(".selector").igGrid({
    									features: [{
    										name: "GroupBy",
    										columnSettings: [{
    											columnKey: "ListPrice",
    											groupSummaries: [{
    												summaryFunction: "Sum",
    												format: "currency"
    											}]
    										}]
    									}]
    								});
    							 

  • label

    タイプ:

    string

    デフォルト:

    ""

    集計結果のラベル。

    コード サンプル

     
    								//Initialize
    								$(".selector").igGrid({
    									features: [{
    										name: "GroupBy",
    										columnSettings: [{
    											columnKey: "ListPrice",
    											groupSummaries: [{
    												summaryFunction: "Avg",
    												label: "Average = "
    											}]
    										}]
    									}]
    								});
    							 

  • summaryFunction

    タイプ:

    enumeration

    デフォルト:

    null

    適用される集計名または関数を指定します。名前が $.ig.util.defaultSummaryMethods で見つからなく、同じ名前がある関数がウィンドウ内に定義される場合、それを使用します。

    メンバー

    • string
    • タイプ:string
    • 使用される集計の名前。すべての集計が $.ig.util.defaultSummaryMethods で定義されます。
    • function
    • タイプ:function
    • 集計として使用されるカスタム関数。

    コード サンプル

     
    								//Initialize
    								$(".selector").igGrid({
    									features: [
    										{
    											name: "GroupBy",
    											columnSettings: [
    												{
    													columnKey: "Color",
    													isGroupBy: true
    												},
    												{
    													columnKey: "ListPrice",
    													isGroupBy: true,
    													groupSummaries: [
    														{
    															summaryFunction: "avg", label: "Average = "
    														},
    														{
    															//	Set a custom function to calculate the difference between
    															//	the minimum and the maximum values in the group
    															//	The fullData contains the data for all records inside the group
    															summaryFunction: function(data, dataType, fullData) {
    																var valuesList = data.array, min = valuesList[0], max = valuesList[0];
    																for(i = 1; i < valuesList.length; i++) {
    																	if(valuesList[i] < min)	min = valuesList[i];
    																	if(valuesList[i] > max)	max = valuesList[i];
    																}
    																return (max - min);
    															},
    															label: "Delta = "
    														}
    													]
    												}
    											]
    										}
    									]
    								});
    							 

  • summaryTemplate

    タイプ:

    string

    デフォルト:

    "{label}{result}"

    ラベルおよび集計の結果が表示される方法を指定するテンプレート。

    コード サンプル

     
    								//Initialize
    								$(".selector").igGrid({
    									features: [{
    										name: "GroupBy",
    										columnSettings: [{
    											columnKey: "ListPrice",
    											groupSummaries: [{
    												summaryFunction: "Count",
    												label: " in stock",
    												summaryTemplate: "{result}{label}"
    											}]
    										}]
    									}]
    								});
    							 

• 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 ListPrice column and the average, the minimum and the maximum
  										//	must be calculated and displayed for each group.
  										{
  											columnKey: "ListPrice",
  											isGroupBy: true,
  					summaries: [
  						{
  													summaryFunction: "avg", text: " Average:"
  												},
  												{
  													summaryFunction: "min", text: " Minimum:"
  												},
  												{
  													summaryFunction: "max", text: " Maximum:"
  												}
  											]
  										}
  									]
  								}
  							]
  						});
  					 

  • 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",
    													isGroupBy: true,
    													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(data) {
    																//	Initialize minmum and maximum values with the first element
    																var valuesList = data.array, min = valuesList[0], max = valuesList[0];
    																//	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: "ListPrice",
    											summaries: [{
    												summaryFunction: "avg"
    											}]
    										}]
    									}]
    								});
    							 

  • text

    タイプ:

    string

    デフォルト:

    null

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

    コード サンプル

     
    								//Initialize
    								$(".selector").igGrid({
    									features: [{
    										name: "GroupBy",
    										columnSettings: [{
    											columnKey: "ListPrice",
    											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");
			 

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログを開くボタンのキャプションを指定します。locale.emptyGroupByAreaContentSelectColumnsCaption オプションを使用します。

 
				//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");
			 

このオプションは 2017.2 バージョン以降サポートされません。
グループ化された行に対する拡張インジケーター ツールチップを指定します。locale.expandTooltip オプションを使用します。

 
				//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})");
			 

列によってグループ化するときに各グループの下部に行として表示されるデフォルト集計を指定します。 このオプションは、各列の columnSettings で定義される groupSummaries より優先度が低くなります。
すべてのデフォルト集計が $.ig.util.defaultSummaryMethods で定義されます。

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

• format

  タイプ:

  string

  デフォルト:

  null

  集計値の書式設定を適用します。
  この format オプションはデフォルトで null 値で使用されません。列書式設定が指定される場合、それが使用されます。
  このオプションと列書式設定が指定されていない場合、autoFormat オプションに基づいて地域設定を使用するかどうかを決定します。

  コード サンプル

   
  						//Initialize
  						$(".selector").igGrid({
  							features: [{
  								name: "GroupBy",
  								groupSummaries: [{
  									summaryFunction: "Sum",
  									format: "currency"
  								}]
  							}]
  						});
  					 

• label

  タイプ:

  string

  デフォルト:

  ""

  集計結果のラベル。

  コード サンプル

   
  						//Initialize
  						$(".selector").igGrid({
  							features: [{
  								name: "GroupBy",
  								groupSummaries: [{
  									summaryFunction: "Avg",
  									label: "Average = "
  								}]
  							}]
  						});
  					 

• summaryFunction

  タイプ:

  enumeration

  デフォルト:

  ""

  適切な列に適用される集計名を指定します。

  メンバー

  • function
  • タイプ:function
  • 集計として使用されるカスタム関数。

  コード サンプル

   
  						//Initialize
  						$(".selector").igGrid({
  							features: [{
  								name: "GroupBy",
  								groupSummaries: [
  									{
  										summaryFunction: "Sum",	label: "Sum = "
  									},
  									{
  										summaryFunction: "Count", label: "Count = "
  									}
  								]
  							}]
  						});
  					 

• summaryTemplate

  タイプ:

  string

  デフォルト:

  "{label}{value}"

  ラベルおよび集計の結果が表示される方法を指定するテンプレート。

  コード サンプル

   
  						//Initialize
  						$(".selector").igGrid({
  							features: [{
  								name: "GroupBy",
  								groupSummaries: [{
  									summaryFunction: "Count",
  									label: " in stock",
  									summaryTemplate: "{result}{label}"
  								}]
  							}]
  						});
  					 

各グループで groupSummaries の位置を指定します。

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

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

 
				//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").igGridGroupBy({
					language: "ja"
				});

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

				// Set
				$(".selector").igGridGroupBy("option", "language", "ja");
			 

• collapseTooltip

  タイプ:

  string

  デフォルト:

  ""

  [グループ化された行を縮小する] ボタンのツールチップを指定します。

  コード サンプル

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

• emptyGroupByAreaContent

  タイプ:

  string

  デフォルト:

  ""

  グループ領域のテキストを指定します。

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							emptyGroupByAreaContent: "Group By"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").emptyGroupByAreaContent;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { emptyGroupByAreaContent: "Group By" });
  				 

• emptyGroupByAreaContentSelectColumns

  タイプ:

  string

  デフォルト:

  ""

  グループ化ダイアログを開くハイパーリンクのテキストを指定します。

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							emptyGroupByAreaContentSelectColumns: "Select Columns to Group By"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").emptyGroupByAreaContentSelectColumns;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { emptyGroupByAreaContentSelectColumns: "Select Columns to Group By" });
  				 

• emptyGroupByAreaContentSelectColumnsCaption

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							emptyGroupByAreaContentSelectColumnsCaption: "Select Columns to Group By"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").emptyGroupByAreaContentSelectColumnsCaption;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { emptyGroupByAreaContentSelectColumnsCaption: "Select Columns to Group By" });
  				 

• expandTooltip

  タイプ:

  string

  デフォルト:

  ""

  [グループ化された行を展開する] ボタンのツールチップを指定します。

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							expandTooltip: "Expand"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").expandTooltip;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { expandTooltip: "Expand" });
  				 

• modalDialogButtonApplyText

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogButtonApplyText: "Apply"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogButtonApplyText;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogButtonApplyText: "Apply" });
  				 

• modalDialogButtonCancelText

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogButtonCancelText: "Cancel"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogButtonCancelText;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogButtonCancelText: "Cancel" });
  				 

• modalDialogCaptionButtonAsc

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogCaptionButtonAsc: "Ascending"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogCaptionButtonAsc;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogCaptionButtonAsc: "Ascending" });
  				 

• modalDialogCaptionButtonDesc

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogCaptionButtonDesc: "Descending"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogCaptionButtonDesc;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogCaptionButtonDesc: "Descending" });
  				 

• modalDialogCaptionButtonUngroup

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogCaptionButtonUngroup: "Ascending"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogCaptionButtonUngroup;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogCaptionButtonUngroup: "Ascending" });
  				 

• modalDialogCaptionText

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogCaptionText: "Dialog Caption"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogCaptionText;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogCaptionText: "Dialog Caption" });
  				 

• modalDialogClearAllButtonLabel

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogClearAllButtonLabel: "Clear All"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogClearAllButtonLabel;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogClearAllButtonLabel: "Clear All" });
  				 

• modalDialogDropDownButtonCaption

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogDropDownButtonCaption: "Clear All"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogDropDownButtonCaption;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogDropDownButtonCaption: "Clear All" });
  				 

• modalDialogDropDownLabel

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogDropDownLabel: "Layouts"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogDropDownLabel;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogDropDownLabel: "Layouts" });
  				 

• modalDialogGroupByButtonText

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogGroupByButtonText: "Ascending"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogGroupByButtonText;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogGroupByButtonText: "Ascending" });
  				 

• modalDialogRootLevelHierarchicalGrid

  タイプ:

  string

  デフォルト:

  ""

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

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							modalDialogRootLevelHierarchicalGrid: "Clear All"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").modalDialogRootLevelHierarchicalGrid;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { modalDialogRootLevelHierarchicalGrid: "Clear All" });
  				 

• removeButtonTooltip

  タイプ:

  string

  デフォルト:

  ""

  [グループ化解除] ボタンのツールチップを指定します。

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							removeButtonTooltip: "Remove"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").removeButtonTooltip;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { removeButtonTooltip: "Remove" });
  				 

• summaryIconTitle

  タイプ:

  string

  デフォルト:

  ""

  集計アイコンのタイトルを指定します。

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							summaryIconTitle: "Summary for {0}: {1}"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").summaryIconTitle;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { summaryIconTitle: "Summary for {0}: {1}" });
  				 

• summaryRowTitle

  タイプ:

  string

  デフォルト:

  ""

  集計行のタイトルを指定します。

  コード サンプル

   
  				//Initialize
  				$(".selector").igGrid({
  					features: [{
  						name: "GroupBy",
  						locale: {
  							summaryRowTitle: "Grouping summary row"
  						}
  					}]
  				});
  
  				//	Get
  				var text = $(".selector").igGridGroupBy("option", "locale").summaryRowTitle;
  
  				//	Set
  				$(".selector").igGridGroupBy("option", "locale", { summaryRowTitle: "Grouping summary row" });
  				 

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

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
モーダル ダイアログで変更を適用するボタンのテキストを指定します。locale.modalDialogButtonApplyText オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
モーダル ダイアログで変更をキャンセルするボタンのテキストを指定します。locale.modalDialogButtonCancelText オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログで昇順に並べ替えられた各列のキャプションを指定します。locale.modalDialogCaptionButtonAsc オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログで降順に並べ替えられた各列のキャプションを指定します。 locale.modalDialogCaptionButtonDesc オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログでキャプション ボタン グループ化解除を指定します。locale.modalDialogCaptionButtonUngroup オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログでキャプション テキストを指定します。locale.modalDialogCaptionText オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログですべてをクリア ボタンのラベルを指定します。locale.modalDialogClearAllButtonLabel オプションを使用します。

 
				//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);
			 

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログでレイアウト ドロップダウン ボタンのキャプションを指定します。locale.modalDialogDropDownButtonCaption オプションを使用します。

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

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

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

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログでレイアウト ドロップダウンのラベルを指定します。locale.modalDialogDropDownLabel オプションを使用します。

 
				//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);
			 

このオプションは 2017.2 バージョン以降サポートされません。
グループ化ダイアログでグループ化ボタンのテキストを指定します。locale.modalDialogGroupByButtonText オプションを使用します。

 
				//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);
			 

このオプションは 2017.2 バージョン以降サポートされません。
レイアウト ツリー ダイアログに表示されるルート レイアウトの名前を指定します。locale.modalDialogRootLevelHierarchicalGrid オプションを使用します。

 
				//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);
			 

ページングが適用され、グループ化された列が 1 つ以上ある場合、ページの処理に含まれるレコードを指定します。

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

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

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

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

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

ウィジェットの領域設定を取得または設定します。

 
				//Initialize
				$(".selector").igGridGroupBy({
					regional: "ja"
				});
				// Get
				var regional = $(".selector").igGridGroupBy("option", "regional");
				// Set
				$(".selector").igGridGroupBy("option", "regional", "ja");
			 

このオプションは 2017.2 バージョン以降サポートされません。
削除ボタンのツールチップを指定します。locale.removeButtonTooltip オプションを使用します。

 
				//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);