Enabling Column Grouping (igGrid)

Topic Overview


This topic demonstrates how to enable the grouping functionality in an igGrid™ in both jQuery and MVC.

In this topic

This topic contains the following sections:


The GroupBy feature of the igGrid control is not enabled by default, so you need to enable it explicitly. You need to also explicitly set the columns that you want to be grouped when the grid is created together with any additional properties you might want configured, like the sorting direction inside the group.

The example below configures a grid with the grouping feature enabled and the content grouped by default by one of the grid’s columns – Safety Level.


Following is a preview of the final result.


General Requirements

  • jQuery-specific requirements

    • An HTML web page with a grid connected to a data source
    • A table tag in the body of the HTML page to serve as a container for the grid

      In HTML:

      <table id="t1">
  • MVC-specific requirements

    • An MVC 4 or above project in MS Visual Studio® with a grid connected to a data source
    • A reference to the Ignite UI for MVC dll - Infragistics.Web.Mvc.dll.

Script Requirements

The required scripts for both Ignite UI for jQuery and Ignite UI for MVC samples are the same because the Ignite UI for MVC render jQuery widgets.

The following scripts are required to run the grid and its grouping functionality:

  • The jQuery library script
  • The jQuery User Interface (UI) library script
  • The Ignite UI for jQuery library scripts

The following code sample demonstrates the scripts added to the header section of a HTML file.


<script type="text/javascript"src="jquery.min.js"></script>
<script type="text/javascript" src="jquery-ui.min.js"></script>
<script type="text/javascript" src="infragistics.core.js"></script>
<script type="text/javascript" src="infragistics.lob.js"></script>

Database Requirements

For the purpose of this example only:

  • jQuery – Adventure Works in JSON format.
  • MVC – Adventure Works database.

Enabling grouping in jQuery

Inside the $(document).ready() event handler create an igGrid with grouping feature configuration to allow grouping by column. In the example below the grid is sorted by default by one of its columns (SafetyStockLevel).

In Javascript:

     features: [
            name: 'GroupBy',
            columnSettings: [
                    columnKey: "SafetyStockLevel",
                    isGroupBy: true,
                    dir: "asc"
    dataSource: adventureWorks,
    responseDataKey: 'Records',
    autoGenerateColumns: true

To verify the result, open the HTML file in your browser. You will see the grid grouped by the default grouped column and you can group by other columns or undo the current grouping.

Enabling grouping in MVC

  1. Create a LINQ to the SQL model.

  2. Create an MVC Controller method.

    Create MVC Controller method to get the data from the SQL Model and to call the View.

    In MVC:

     public ActionResult Default()
         var ctx = new AdventureWorksDataContext("ConnString");
         var ds = ctx.Products;
         return View("Events", ds);
  3. Create the grid.

    Define the grid itself along with the Group By feature and all his configurations:

    In Razor:

         .Features(feature => {
             feature.GroupBy().ColumnSettings(groupedGolumn =>
  4. Save the project.

  5. (Optional) Verify the result.

    To verify the result, run your application. You will see the grid grouped by the default grouped column and you can also group by other columns or undo the current grouping.

Custom Grouping Implementations

The grouping functionality allows using a custom function to group the data using some criteria that differs from the default ones. For example, you may want to group a column based on the parity (the oddness or the evenness) of certain numbers.

Related Content


The following topics provide additional information related to this topic.


The following samples provide additional information related to this topic.

View on GitHub