- 4 minutes to read
The grouping feature combines rows with identical column values into the same data groups.
Data grouping is enabled in the Data Grid by default. To group data by a column, drag a column header into the group panel. Another option is to right-click a column header and select “Group By This Column”. Both approaches work in Visual Studio and at runtime.
By default, when you group data by columns, these columns automatically hide from the View, and all groups collapse.
Related API * GridOptionsCustomization.AllowGroup - disables grouping by Grid Columns.
- OptionsColumn.AllowGroup - disables grouping by this specific column.
- OptionsColumn.AllowMove - prevents end-users from dragging a column header, including dragging it inside the group panel.
- GridOptionsView.ShowGroupPanel - manages the group panel visibility. Hiding this panel does not disable grouping.
- GridOptionsView.ShowGroupedColumns - specifies whether or not columns by which data is grouped should still be visible within the View.
- GridOptionsBehavior.AutoExpandAllGroups - if this setting is enabled, all groups will automatically expand after grouping.
To ungroup data, drag a column header from the group panel to the column header panel, or right-click a column header and select “Ungroup” from the context menu. To remove all grouping, right-click the group panel and select “Clear Grouping”.
Related API * OptionsColumn.AllowMove - prevents end-users from dragging a column header, including dragging it away from the group panel.
- OptionsColumn.AllowGroup - disables the “Ungroup” option in the column context menu.
ColumnView.StartGrouping, ColumnView.EndGrouping - allow you to re-apply initial column grouping when end-users select “Clear Grouping” in the group panel context menu. The sample below restores grouping by the “Order ID” column when end-users clear grouping.
When data is grouped by multiple columns, you can drag a column header to another position within the group panel to change the group order.
Related API * GridColumn.GroupIndex - accepts unique integer values that specify the group level for this column. Setting this property to -1 removes grouping by this column.
GridOptionsView.ShowGroupPanelColumnsAsSingleRow - if this setting is enabled, all column headers within a group panel are arranged in a line. In the figure below, data is grouped against “Country”, “Region” and “Contact Title” columns. All three column headers are arranged in a line within the group panel.
Merged Column Grouping
Hold the Ctrl key when dragging column headers into the group panel to group data by multiple columns at once.
You can combine this merged grouping with regular multi-column grouping.
To re-arrange column headers within merged filter blocks, drag a column header with the same Ctrl key pressed.
Related API GridOptionsCustomization.AllowMergedGrouping - disables the merged grouping feature.
Column headers within a group panel provide the same features as regular View columns: end-users can click a grouped column header to sort data ascending or descending, and invoke the filter menu to apply filtering.
Group Value Ranges
For DateTime columns, end-users can right-click a column header within the group panel and change the “Group Interval” setting.
Using the GridColumn.GroupInterval property, you can set the group interval for DateTime columns in code. For string columns, the “Alphabetic” and “Value” intervals are available. The figure below illustrates the “Alphabetical” group interval set for the “Ship Country” column.
Fixed Group Rows
Enable the GridOptionsBehavior.AllowFixedGroups to allow group rows to anchor to the View’s top. This behavior allows end-users to identify what group they currently browse when scrolling through grouped data.
Hide Single-Record Groups
Disable the GridOptionsBehavior.AllowPartialGroups to disable groups that contain only one data row. These data rows remain visible, but are displayed without parent groups and are separated from other data rows with blue lines.
When this option is enabled, column headers become visible in the Column Header Panel. Furthermore, group summaries are forcibly moved to group rows, and group footers then become hidden.