Row Selection can be configured with groups to select all of a rows descendants.
Selecting Descendants Copy Link
When using Multiple Row Selection with row grouping, the grid can be configured to impact descendant and ancestor rows when a row is selected.
To enable hierarchical selection, set the selection.groupSelects option to one of the following values:
'self': Selecting a group row has no additional side effects.'descendants': Selecting a group row will select all of its descendants.'filteredDescendants': Selecting a group row will select all of its descendants that pass the filter.
import {
ClientSideRowModelModule,
GridApi,
GridOptions,
GroupSelectionMode,
ModuleRegistry,
QuickFilterModule,
RowSelectionModule,
createGrid,
enableDevValidations,
} from "ag-grid-community";
import {
ColumnMenuModule,
ColumnsToolPanelModule,
ContextMenuModule,
RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";
// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
enableDevValidations();
}
ModuleRegistry.registerModules([
QuickFilterModule,
ClientSideRowModelModule,
ColumnsToolPanelModule,
ColumnMenuModule,
ContextMenuModule,
RowGroupingModule,
RowSelectionModule,
]);
let gridApi: GridApi<IOlympicData>;
const gridOptions: GridOptions<IOlympicData> = {
columnDefs: [
{ field: "country", rowGroup: true, hide: true },
{ field: "sport", rowGroup: true, hide: true },
{ field: "gold", aggFunc: "sum" },
{ field: "silver", aggFunc: "sum" },
{ field: "bronze", aggFunc: "sum" },
],
defaultColDef: {
flex: 1,
minWidth: 100,
},
autoGroupColumnDef: {
headerName: "Athlete",
field: "athlete",
minWidth: 250,
cellRenderer: "agGroupCellRenderer",
},
rowSelection: {
mode: "multiRow",
groupSelects: "self",
},
suppressAggFuncInHeader: true,
};
const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);
fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
.then((response) => response.json())
.then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
function getGroupSelectsValue(): GroupSelectionMode {
return (
(document.querySelector<HTMLSelectElement>("#input-group-selection-mode")
?.value as any) ?? "self"
);
}
function onSelectionModeChange() {
gridApi.setGridOption("rowSelection", {
mode: "multiRow",
groupSelects: getGroupSelectsValue(),
});
}
function onQuickFilterChanged() {
gridApi.setGridOption(
"quickFilterText",
document.querySelector<HTMLInputElement>("#input-quick-filter")?.value,
);
}
if (typeof window !== "undefined") {
// Attach external event handlers to window so they can be called from index.html
(<any>window).onSelectionModeChange = onSelectionModeChange;
(<any>window).onQuickFilterChanged = onQuickFilterChanged;
}
.example-wrapper {
display: flex;
flex-direction: column;
height: 100%;
}
#myGrid {
flex: 1 1 0px;
width: 100%;
}
.example-header {
margin-bottom: 5px;
}
<div class="example-wrapper">
<div class="example-header">
<label>
<span>Group selects:</span>
<select id="input-group-selection-mode" onchange="onSelectionModeChange()">
<option value="self">self</option>
<option value="descendants">descendants</option>
<option value="filteredDescendants">filteredDescendants</option>
</select>
</label>
<label>
<span>Quick Filter:</span>
<input type="text" id="input-quick-filter" oninput="onQuickFilterChanged()" />
</label>
</div>
<div id="myGrid" style="height: 100%"></div>
</div>
export interface IOlympicData {
athlete: string,
age: number,
country: string,
year: number,
date: string,
sport: string,
gold: number,
silver: number,
bronze: number,
total: number
}The example above demonstrates the following configuration:
const gridOptions = {
rowSelection: {
mode: 'multiRow',
groupSelects: 'descendants',
},
// other grid options ...
}When using groupSelects: 'descendants' or groupSelects: 'filteredDescendants', group nodes will not be returned as part of api.getSelectedNodes() or api.getSelectedRows().
Checkboxes in Group Cells Copy Link
When using Row Selection with grouping, the grid can be configured to render checkboxes in the group cell, to the right of the expand/collapse chevron.
This can be configured on by setting the rowSelection.checkboxLocation option to 'autoGroupColumn'.
import {
ClientSideRowModelModule,
GridApi,
GridOptions,
ModuleRegistry,
RowSelectionModule,
createGrid,
enableDevValidations,
} from "ag-grid-community";
import {
ColumnMenuModule,
ColumnsToolPanelModule,
ContextMenuModule,
RowGroupingModule,
} from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";
// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
enableDevValidations();
}
ModuleRegistry.registerModules([
RowSelectionModule,
ClientSideRowModelModule,
ColumnsToolPanelModule,
ColumnMenuModule,
ContextMenuModule,
RowGroupingModule,
]);
let gridApi: GridApi<IOlympicData>;
const gridOptions: GridOptions<IOlympicData> = {
columnDefs: [
{ field: "country", rowGroup: true, hide: true },
{ field: "sport", rowGroup: true, hide: true },
{ field: "gold", aggFunc: "sum" },
{ field: "silver", aggFunc: "sum" },
{ field: "bronze", aggFunc: "sum" },
],
defaultColDef: {
flex: 1,
minWidth: 100,
},
autoGroupColumnDef: {
headerName: "Athlete",
field: "athlete",
minWidth: 250,
cellRenderer: "agGroupCellRenderer",
},
rowSelection: {
mode: "multiRow",
groupSelects: "self",
checkboxLocation: "autoGroupColumn",
},
suppressAggFuncInHeader: true,
};
const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);
fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
.then((response) => response.json())
.then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
<div id="myGrid" style="height: 100%"></div>
export interface IOlympicData {
athlete: string,
age: number,
country: string,
year: number,
date: string,
sport: string,
gold: number,
silver: number,
bronze: number,
total: number
}The example above demonstrates the following configuration to render checkboxes in the group cell:
const gridOptions = {
rowSelection: {
mode: 'multiRow',
checkboxLocation: 'autoGroupColumn',
},
// other grid options ...
}