Framework:
Select a row by clicking on it. Selecting a row will remove any previous selection unless you hold down Ctrl while clicking. Selecting a row and holding down Shift while clicking a second row will select the range.
Remember Row Selection works with all frameworks as well as plain JavaScript.
Configure row selection with the following properties:
rowSelection: Type of row selection, set to either 'single' or 'multiple' to enable selection. 'single' will use single row selection, such that when you select a row, any previously selected row gets unselected. 'multiple' allows multiple rows to be selected.rowMultiSelectWithClick: Set to true to allow multiple rows to be selected with clicks. For example, if you click to select one row and then click to select another row, the first row will stay selected as well. Clicking a selected row in this mode will deselect the row. This is useful for touch devices where Ctrl and Shift clicking is not an option.suppressRowDeselection: Set to true to prevent rows from being deselected if you hold down Ctrl and click the row (i.e. once a row is selected, it remains selected until another row is selected in its place). By default the grid allows deselection of rows.suppressRowClickSelection: If true, rows won't be selected when clicked. Use, for example, when you want checkbox selection, and don't want to also select the row when the row is clicked.When you pass data to the grid, it wraps each data item in a node object. This is explained in the section Client-Side Row Model. When you query for the selected rows, there are two method types: ones that return nodes, and ones that return data items. To get the selected nodes / rows from the grid, use the following API methods:
| Returns a list of selected nodes. Getting the underlying node (rather than the data) is useful when working with tree / aggregated data, as the node can be traversed. | |
| Returns a list of selected rows (i.e. row data that you provided). |
Working with AG Grid nodes is preferred over the row data as it provides you with more information and maps better to the internal representation of AG Grid.
The example below shows single row selection.
rowSelection='single' is set to enable single row selection. It is not possible to select multiple rows.The example below shows multi-row selection.
rowSelection='multiple' is set to enable multiple row selection. Selecting multiple rows can be achieved by holding down Ctrl and mouse clicking the rows. A range of rows can be selected by using Shift.The example below shows multi-select with click. Clicking multiple rows will select a range of rows without the need for Ctrl or Shift keys. Clicking a selected row will deselect it. This is useful for touch devices where Ctrl and Shift clicks are not available.
rowMultiSelectWithClick=true is set to enable multiple row selection with clicks.Checkbox selection can be used in two places: row selection and group selection.
| boolean or Function. Set to true (or return true from function) to render a selection checkbox in the column.Default: false |
To include checkbox selection for a column, set the attribute 'checkboxSelection' to true on the column definition.
You can set this attribute on as many columns as you like, however it doesn't make sense to have it in more than one
column in a table.
To enable checkbox selection for groups, set the attribute 'checkbox' to true for the group renderer. See the
grouping section for details on the group renderer.
checkboxSelection can also be specified as a function. This allows dynamically setting whether a cell
has a checkbox or not. The callback is called when the Cell is drawn, and called again if there are any changes
to the row's data or the column positions (e.g. the callback could be showing the checkbox depending on what
value is displayed, or if the column in question is the first column to show a checkbox for the first column only).
If the function returns false, a selection checkbox will still be created and in the DOM,
however it will not be visible using CSS visibility: hidden. This is to ensure the following UX properties:
To be clear, there is a slight difference between a callback returning false, and false value provided explicitly. When a callback is used and returns false, the grid assumes a checkbox is sometimes used and as such creates one that is not visible.
// do not create checkbox
colDef.checkboxSelection = false;
// create checkbox, make checkbox not visible
colDef.checkboxSelection = () => false;When doing grouping, you control what selecting a group means. This is controlled with the two grid properties groupSelectsChildren and groupSelectsFiltered.
groupSelectsChildren: When true, selecting a group will have the impact of selecting all its children. The group will then display 'selected' when all children are selected, 'unselected' when none are selected and 'intermediate' when children have a mix of selected and unselected. When the node is selecting children, it will never appear in the selected set when calling api.getSelectedNodes().false, the group is selectable independently of the child nodes. When selecting the group node independently of the children, it will appear in the set when calling api.getSelectedNodes().groupSelectsFiltered: Used when groupSelectsChildren=true. When true only filtered children of the group will be selected / unselected. This means you can apply a filter, then try to select a group, and the group will end up in the intermediate state as only as subset of the children will be selected.The example below shows checkbox selection with groups. Selecting the group has the effect of selecting the children. Likewise selecting all the children automatically selects the group. In this scenario the group itself will never appear in the selectedRows list.
The example also shows a checkbox for selection on the age column. In practice, it is not normal to have more than one column for selection, the below is just for demonstration. Having a checkbox within a non-group row is best for grids that are not using grouping.
The example below is similar to the previous example except it does not put checkboxes on the leaf level nodes, allowing only entire groups to be selected. This is achieved by providing functions for colDef.checkboxSelection and autoGroupColumnDef.cellRendererParams.checkbox.
Lastly we show an example using groupSelectsFiltered=true. Here, when you filter the grid and select a group, only the filtered children get selected.
To demonstrate, try this in the example:
It is possible to have a checkbox in the header for selection. To configure the column to have a checkbox, set colDef.headerCheckboxSelection=true. headerCheckboxSelection can also be a function, if you want the checkbox to appear sometimes (e.g. if the column is ordered first in the grid).
| If true or the callback returns true, a 'select all' checkbox will be put into the header. |
const gridOptions = {
columnDefs: [
// the name column header always has a checkbox in the header
{
field: 'name',
headerCheckboxSelection: true
},
// the country column header only has checkbox if it is the first column
{
field: 'country',
headerCheckboxSelection: params => {
const displayedColumns = params.columnApi.getAllDisplayedColumns();
return displayedColumns[0] === params.column;
}
},
],
// other grid options ...
}If headerCheckboxSelection is a function, the function will be called every time there is a change to the displayed columns, to check for changes.
The header checkbox has two modes of operation, 'normal' and 'filtered only'.
The examples below demonstrate both of these options.
This example has the following characteristics:
The next example is similar to the one above with the following changes:
It is possible to specify which rows can be selected via the gridOptions.isRowSelectable(rowNode) callback function.
| Callback to be used to determine which rows are selectable. By default rows are selectable, so return false to make a row un-selectable. |
For instance if we only wanted to allow rows where the 'year' property is less than 2007, we could implement the following:
const gridOptions = {
isRowSelectable: rowNode => rowNode.data ? rowNode.data.year < 2007 : false,
// other grid options ...
}This example demonstrates the following:
isRowSelectable(node) callback only allows selections on rows where the year < 2007.headerCheckboxSelection: true and checkboxSelection: true, but only rows which are selectable will obtain a selectable checkbox. Similarly, the header checkbox will only select selectable rows.This example demonstrates the following:
isRowSelectable(node) callback allows rows with a year of 2004 or 2008 to be selectable.gridOptions.groupSelectsChildren = true selecting groups will also select 'selectable' children.gridOptions.groupSelectsFiltered = true selecting groups will only select 'selectable' children that pass the filter.To demonstrate, follow these steps:
There are two events with regards to selection:
| Row is selected or deselected. The event contains the node in question, so call the node's isSelected() method to see if it was just selected or deselected. | |
| Row selection is changed. Use the grid API getSelectedNodes() to get the new list of selected nodes. |
To select rows programmatically, use the node.setSelected(params) method.
setSelectednewValue - true for selection, false for deselection.clearSelection - If selecting, then passing true will select the node exclusively (i.e. NOT do multi select). If doing deselection, clearSelection has no impact.suppressFinishActions - Pass true to prevent the selectionChanged from being fired. Note that the rowSelected event will still be fired. setSelected = (
newValue: boolean,
clearSelection: boolean = false,
suppressFinishActions: boolean = false
) => void;isSelectedtrue if node is selected, false if the node isn't selected undefined if it's partially selected (group where not all children are selected). isSelected = () => boolean | undefined;// set selected, keep any other selections
node.setSelected(true);
// set selected, exclusively, remove any other selections
node.setSelected(true, true);
// un-select
node.setSelected(false);
// check status of node selection
const selected = node.isSelected();The isSelected() method returns true if the node is selected, or false if it is not selected. If the node is a group node and the group selection is set to 'children', this will return true if all child (and grandchild) nodes are selected, false if all unselected, or undefined if a mixture.
The grid API has the following methods for selection:
| Select all rows, regardless of filtering and rows that are not visible due to grouping being enabled and their groups not expanded. | |
| Clear all row selections, regardless of filtering. | |
| Select all filtered rows. | |
| Clear all filtered selections. | |
| Returns a list of selected nodes. Getting the underlying node (rather than the data) is useful when working with tree / aggregated data, as the node can be traversed. |
If you want to select only filtered-out row nodes, you could do this using the following:
// loop through each node when it is filtered out
gridOptions.api.forEachNodeAfterFilter(node => {
// select the node
node.setSelected(true);
});There is an API function forEachNode. This is useful for doing group selections on a business key. The example below shows selecting all rows with country = 'United States'. This method is also useful when you load data and need to know the node equivalent of the data for selection purposes.
By default, you can select a row on mouse click, and navigate up and down the rows using your keyboard keys. However, the selection state does not correlate with the navigation keys, but we can add this behaviour using our own Custom Navigation.
We need to provide a callback to the navigateToNextCell grid option to override the default arrow key navigation:
| Allows overriding the default behaviour for when user hits navigation (arrow) key when a cell is focused. Return the next Cell position to navigate to or null to stay on current cell. |
const gridOptions = {
navigateToNextCell: params => {
const suggestedNextCell = params.nextCellPosition;
// this is some code
const KEY_UP = 'ArrowUp';
const KEY_DOWN = 'ArrowDown';
const noUpOrDownKeyPressed = params.key!==KEY_DOWN && params.key!==KEY_UP;
if (noUpOrDownKeyPressed) {
return suggestedNextCell;
}
params.api.forEachNode(node => {
if (node.rowIndex === suggestedNextCell.rowIndex) {
node.setSelected(true);
}
});
return suggestedNextCell;
},
// other grid options ...
}From the code above you can see that we iterate over each node and call the setSelected() method if it matches the current rowIndex.