A list of column settings that specifies hiding options on a per column basis.

 
				//Initialize
				$(".selector").({
					features : [
						{
							name : "CellMerging",
							columnSettings: [
								{ columnKey: "ProductID", mergeOn: "always" }
							]
						}
					]
				});
				//Get
				var columnSettings = $(".selector").igGridCellMerging("option", "columnSettings");
			 

• columnIndex

  Type:

  number

  Default:

  -1

  Column index. This is a required property in every column setting if columnKey is not set.

  Code Sample

   
  						//Initialize
  						$(".selector").({
  							features: [
  								{
  									name: "CellMerging",
  									columnSettings: [
  										{ columnIndex: 0, mergeOn: "always" }
  									]
  								}
  							]
  						});
  					 

• columnKey

  Type:

  string

  Default:

  null

  Column key. This is a required property in every column setting if columnIndex is not set.

  Code Sample

   
  						//Initialize
  						$(".selector").({
  							features: [
  								{
  									name: "CellMerging",
  									columnSettings: [
  										{ columnKey: "ProductID", mergeOn: "always" }
  									]
  								}
  							]
  						});
  					 

• mergeOn

  Type:

  enumeration

  Default:

  sorting

  Defines when merging should be applied.

  Members

  • sorting
  • Type:string
  • The column will only be merged when sorted.
  • always
  • Type:string
  • The column will always be merged.
  • never
  • Type:string
  • No merging will be applied.

  Code Sample

   
  							//Initialize
  							$(".selector").({
  								features : [
  									{
  										name : "CellMerging",
  										columnSettings: [
  											{ columnKey: "ProductID", mergeOn: "always" }
  										]
  									}
  								]
  							});
  						 

• mergeStrategy

  Type:

  enumeration

  Default:

  duplicate

  Defines the rules merging is based on.

  Members

  • duplicate
  • Type:string
  • Duplicate values in the column will be merged together.
  • null
  • Type:string
  • Merging will be applied for each subsequent null value after a non-null value.

  • function
  • type="function|string" Merging will be applied based on the provided function (either by reference or by name in which case it should be available as property of window). The function takes arguments 'prevRecord' (the previous record in the chain), 'curRecord' (the current record in the chain) and 'columnKey' which is the key of the column the merging is currently being executed for.

  Code Sample

   
  							//Initialize
  							$(".selector").({
  								features : [
  									{
  										name : "CellMerging",
  										mergeOn: "always"
  									}
  								]
  							});;
  						 

Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid.

Set/Get the locale language setting for the widget.

 
					//Initialize
				$(".selector").igGridCellMerging({
					language: "ja"
				});

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

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

Set/Get the locale setting for the widget.

 
					//Initialize
				$(".selector").igGridCellMerging({
					locale: {}
				});

				// Get
				var locale = $(".selector").igGridCellMerging("option", "locale");

				// Set
				$(".selector").igGridCellMerging("option", "locale", {});
			 

Defines when merging should be applied.

 
					//Initialize
					$(".selector").({
						features : [
							{
								name : "CellMerging",
								mergeOn: "always"
							}
						]
					});
					//Get
					var mergeOn = $(".selector").igGridCellMerging("option", "mergeOn");
					//Set
					$(".selector").igGridCellMerging("option", "mergeOn", "always");
				 

Defines the rules merging is based on.

 
					//Initialize
					$(".selector").({
						features : [
							{
								name : "CellMerging",
								mergeOn: "null"
							}
						]
					});
					//Get
					var mergeStrategy = $(".selector").igGridCellMerging("option", "mergeStrategy");
					//Set
					$(".selector").igGridCellMerging("option", "mergeStrategy", "null");
				 

Defines the type of merging.

 
				//Initialize
				$(".selector").({
					features : [
						{
							name : "CellMerging",
							mergeType: "physical"
						}
					]
				});
				//Get
				var mergeType = $(".selector").igGridCellMerging("option", "mergeType");
			 

Set/Get the regional setting for the widget.

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