Select a row by clicking on it. Selecting a row will remove previous selection unless you
ctrl while clicking. Selecting a row and then holding down
while clicking a second row will select the range.
Configure row selection with the following properties:
rowSelection: Type of row selection, set to either
'multiple'to enable selection. Single sets to single row selection, such that when you select a row, the previously selected row gets unselected. Multiple allows multiple row selection.
rowMultiSelectWithClick: Set to
trueto all multiple rows to be selected with a single click. E.g. if you click select one row, then click select another row, the first row will keep it's selection. Clicking a selected row in this mode will deselect the row. This is useful for touch devices where
shiftclicking is not an option.
rowDeselection: Set to
false. If true, then rows will be deselected if you hold down ctrl + click the row. Normal behaviour with the grid disallows deselection of nodes (ie once a node is selected, it remains selected until another row is selected in its place).
true, rows won't be selected when clicked. Use, for example, when you want checkbox selection, and don't want to also select when the row is clicked.
When you pass data to the grid, it wraps each data item in an node. 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:
api.getSelectedNodes(): Returns an array of the selected nodes.
api.getSelectedRows(): Returns a array of selected rows data.
Working with the ag-Grid nodes is preferred over the row data as it provide you with more information and maps better to the internal representation of ag-grid.
Example - Single Row Selection
The example below shows single row selection.
rowSelection='single'is set to enable single row selection. It is not possible to select multiple rows.
Example - Multiple Row Selection
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
controland mouse clicking the rows. A range of rows can be selected by using
Example - Multi Select Single Click
The example below shows multi select with single click. Clicking multiple rows will
select a range of rows without the need for
keys. Clicking a selected row will deselect it. This is useful for touch devices where
Control and Shift clicks are not available.
rowMultiSelectWithClick=trueis set to enable multiple row selection with single clicks.
Checkbox selection can be used in two places: a) row selection and b) group selection.
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 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.
colDef.checkboxSelection can also be a function that returns true/false - use this if
you want only checkboxes on some rows but not others. gridOptions.checkboxSelection can
also be specified as a function - use this if you want, for example, the first column
to have checkbox selection regardless of which column it is (you would do this by looping the columns using the
column API, and check if the first column is the current one (in checkboxSelection).
When doing grouping, you control what selecting a group means. This is controlled with
the two properties
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
false, then 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
groupSelectsFiltered: Gets used when
trueonly filtered children of the group will be selected / unselected. This means you can apply a filter, then try to select a group, the group will end up in the intermediate state as only as subset of the children will be selected.
Groups & Checkbox Selection Example 1
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
The example also shows a checkbox for selection on the age column. In practice, it is not normal to have more than two columns 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.
Groups & Checkbox Selection Example 2 - No Select Leaf Nodes
The example below is similar to the previous example except it does not put checkboxes
on the leaf level nodes, only allowing entire groups to be selected. This is achieved
by providing functions for
Groups & Checkbox Selection Example 3 - Only Filtered
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:
- Filter on swimming
- Select a country
- Notice that all filtered records get selected. If you remove the filter, the non filtered are not selected.
- Notice that the group becomes intermediate while all its filtered children get selected. This is because the selected state of the group node is independent to the filter - so it becomes intermediate as not all of its children are selected.
Header Checkbox Selection
It is possible to have a checkbox in the header for selection. To configure the
column to have checkbox, set
headerCheckboxSelection can also be a function, if you want the checkbox
to appear sometimes (eg if the columns is ordered first in the grid).
headerCheckboxSelection is a function, the function will be called every
time there is a change to the displayed columns, to check for changes.
Select Everything or just Filtered
The header checkbox has two modes of operation, 'normal' and 'filtered only'.
- colDef.headerCheckboxSelectionFilteredOnly=false: The checkbox will select all rows when checked, and un-select all rows when unchecked. The checkbox will update its state based on all rows.
- colDef.headerCheckboxSelectionFilteredOnly=true: The checkbox will select only filtered rows when checked and un-select only filtered rows when unchecked. The checkbox will update its state base on only filtered rows.
The examples below demonstrate both of these options.
Header Checkbox Example 1 - Filtered Only = true
This example has the following characteristics:
- The checkbox works on filtered only. That means if you filter first, then hit the checkbox to select or un-select, then only the filtered results get impacted.
- The checkbox is always on the athlete column, even if the athlete column is moved.
Header Checkbox Example 2 - Filtered Only = false
The next example is similar to the one above with the following changes:
- The select selects everything, not just filtered.
- The column that the selection checkbox goes on is always the first column. This can be observed by dragging the columns to reorder them.
Specify Selectable Rows
It is possible to specify which rows can be selected via the
For instance if we only wanted to allow rows where the 'year' property is less than 2007, we could implement the following:
Selectable Rows with Header Checkbox
This example demonstrates the following:
isRowSelectable()callback only allows selections on rows where the year < 2007.
- The country column has
checkboxSelection:true, however only rows which are selectable will obtain a selectable checkbox. Similarly, the header checkbox will only select selectable rows.
Specifying Selectable Rows with Groups
This example demonstrates the following:
isRowSelectable()callback allows rows with year 2004 and 2008 to be selectable.
gridOptions.groupSelectsChildren = trueselecting groups will also select 'selectable' children.
gridOptions.groupSelectsFiltered = trueselecting groups will only select 'selectable' children that pass the filter.
- To demonstrate, follow these steps:
- Click 'Filter by Year 2008 & 2012'.
- Select checkbox beside 'United States'.
- Click 'Clear Filter'.
- Notice that only 'United States' for 2008 is selected.
There are two events with regards selection:
- rowSelected: Gets called when a row is selected or deselected. The event contains the node in question, so call the nodes 'isSelected()' method to see if it was just selected or deselected.
- selectionChanged: Gets called when one or more rows are selected or deselected. Use the grid API get a list of selected nodes if you want them.
Node Selection API
To select rows programmatically, use the node.setSelected() method. This method takes two parameters:
- selected: set to true to select, false to un-select.
- clearSelection (optional): for selection only. If true, other nodes selection will be cleared. Use this if you do not want multi selection and want this node to be exclusively selected.
Grid Selection API
The grid API has the following methods for selection:
api.selectAll(): Select all rows in the grid. This is independent to filtering, it will always select everything regardless of filtering.
api.deselectAll(): Un-select all rows, again regardless of filtering.
api.selectAllFiltered(): Select all filtered rows in the grid.
api.deselectAllFiltered(): Un-select all filtered rows.
api.getSelectedNodes(): Returns a list of all the selected row nodes. This again is regardless of what filters are set.
If you want to select only filtered out rows nodes, then you do this following:
Deep Dive Example - Using
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.
Example: Selection with Keyboard Arrow Keys
By default, you can select a row on mouse click. And you can navigate up and down the rows using your keyboard keys. But the selection state does not correlate with the navigation keys. However, we can add this behaviour using your own Custom Navigation.
First we need to provide a callback to the navigateToNextCell property in gridOptions to override the default arrow key navigation:
From the code below you can see that we iterate over each node and call the
method if matches the current rowIndex.