Common rules

Header grouping is a way to add additional columns above the header grid rows, so that they are grouped in a way you need them.
Typical implementation can look like the picture below.


We support two types of grouping - with colSpan enabled and colSpan disabled.
If the colSpan is disabled (the default) the headers that do not have grouping have a additional cell above it.
If the colSpan is enabled there is no additional cell above the non-grouped column and it is considered as one column.

Below we will provide the settings and a way how to do this.

Currently the header grouping has the following:

Limitations

  • Sortable columns is not compatible with grouping. That is you should use only one of these feature, but not booth together
  • Column Chooser is not compatible with the header grouping

Using Header Grouping

Grouping of the header should be used after the grid is created. For this purpose we have created a method which is called setGroupHeaders.

One typical implementation can look like this

...
jQuery("#grid").jqGrid({
...
   colNames: ['Date', 'Client', 'Amount', 'Tax', 'Total', 'Closed', 'Shipped via', 'Notes'],
   colModel: [
         {name: 'invdate', index: 'invdate', width: 80, align: 'center', sorttype: 'date',
            formatter: 'date', formatoptions: {newformat: 'd-M-Y'}, datefmt: 'd-M-Y'},
         {name: 'name', index: 'name', width: 70 },
         {name: 'amount', index: 'amount', width: 75, formatter: 'number', sorttype: 'number', align: 'right'},
         {name: 'tax', index: 'tax', width: 75, formatter: 'number', sorttype: 'number', align: 'right'},
         {name: 'total', index: 'total', width: 75, formatter: 'number', sorttype: 'number', align: 'right'},
         {name: 'closed', index: 'closed', width: 75, align: 'center', formatter: 'checkbox',
            edittype: 'checkbox', editoptions: {value: 'Yes:No', defaultValue: 'Yes'}},
         {name: 'ship_via', index: 'ship_via', width: 100, align: 'center', formatter: 'select',
            edittype: 'select', editoptions: {value: 'FE:FedEx;TN:TNT;IN:Intim', defaultValue: 'Intime'}},
         {name: 'note', index: 'note', width: 70, sortable: false}
    ],
    rowNum: 10,
    rowList: [5, 10, 20],
 ...
});
jQuery("#grid").jqGrid('setGroupHeaders', {
  useColSpanStyle: false, 
  groupHeaders:[
	{startColumnName: 'amount', numberOfColumns: 3, titleText: '<em>Price</em>'},
	{startColumnName: 'closed', numberOfColumns: 2, titleText: 'Shiping'}
  ]
});
...

setGroupHeaders options

The method creates the group of headers in the grid. If the method is called, after the creation of the grouping header we store the group headers options as grid parameter. This grid parameters is called groupHeader and can be requested with getGridParam method after it is run and there is no call of destroyGroupHeader method (see below).

The setGroupHeader method has the following options

PropertyTypeDescriptionDefault
useColSpanStyleboolean Determine if the non grouping header cell should be have cell above it - value of false, or the column should be treated as one combining boot - true false
groupHeadersarray A set of object(s) which describes the header grouping texts and rules. Bellow is the list of the options of every element of this array empty
groupHeaders element options:
PropertyTypeDescription
startColumnName string The name from colModel from which the grouping header begin, including the same field
numberOfColumnsinteger The number of columns which are included for this group. Note that the number start from the startColumnName. If the column is hidden it is skipped and as result the group does not contain the field, but the method count it.
titleText string The text for this group. The text can contain html tags

Using the previous example if we change the useColSpanStyle to true we will obtain the following picture:

...
jQuery("#grid").jqGrid('setGroupHeaders', {
  useColSpanStyle: true, 
  groupHeaders:[
	{startColumnName: 'amount', numberOfColumns: 3, titleText: '<em>Price</em>'},
	{startColumnName: 'closed', numberOfColumns: 2, titleText: 'Shiping'}
  ]
});
...

Destroying group header

To destroy group header call the destroyGroupHeader method. This method returns back the grid headers to its initial state.

The method can be called like this:

...
jQuery("#grid").jqGrid('destroyGroupHeader');
...

The method has optional one parameter. The parameter is boolean and its default state is true. If the parameter is set to false like :

...
jQuery("#grid").jqGrid('destroyGroupHeader', false);
...

it restores the initial grid header, but does not destroy the grouping header options from which the group header is created. With other words the last group header parameters can be used later instead that the group header is destroyed


Personal Tools
;
;