Framework:Javascript Data GridAngular Data GridReact Data GridVue Data Grid

Angular Data Grid: Row Grouping - Complex Objects

This section covers how to group rows when the row data contains complex objects.

Creating group keys from complex objects

When grouping by columns that contain complex objects in the supplied row data, the values will be converted to "[object object]" by default. This will not produce the desired grouping results.

One way to get around this is to add a toString() method to the complex objects, however this may not be possible if you are working with JSON data.

A more flexible solution is to use the colDef.keyCreator() callback function to return a meaningful key for the supplied object, as shown in the following code snippets:

// row item has complex object for country
rowItem = {
    athlete: 'Michael Phelps',
    country: {
      name: 'United States',
      code: 'US'
    },
    ...
}
<ag-grid-angular
    [columnDefs]="columnDefs"
    /* other grid options ... */>
</ag-grid-angular>

this.columnDefs = [
  // the column definition for country uses a keyCreator
  {
      field: "country",
      keyCreator: params => params.value.name
  }
];

Note in the snippet above that the colDef.keyCreator() returns the country name to be used as the group key from country complex object supplied in the row data.

The example below shows grouping on the country column that contains complex object values:

Next Up

Continue to the next section to learn about Unbalanced Groups.