React Data GridAccessing Client-Side Data
react logo

This section covers the ways data can be accessed once it has been supplied to the grid.

Each time you pass data to the grid, the grid wraps each data item with a Row Node object. For example, if your data has 20 rows, the grid creates 20 Row Node objects, each Row Node wrapping one item of your data.

It is sometimes handy to access these Row Nodes. One example where it is handy is if you want to select a row, you can call rowNode.setSelected(true) to select it. This section details the different ways a Row Node can be accessed.

The following methods are provided for accessing the individual Row Nodes. A deeper explanation of these methods, along with examples, is provided further down.

Accessing Row Node API Methods

See: Application Assigned IDs
See: Iterating Rows
See: Iterating Rows
See: Iterating Rows
See: Iterating Rows

Accessing Rows by Row ID

The easiest way to get a Row Node is by its Row ID. The ID is either provided by you using the grid callback getRowId(), or generated by the grid using an internal sequence.

// callback tells the grid to use the 'id' attribute for IDs, IDs should always be strings
const getRowId = params => params.data.id;

<AgGridReact getRowId={getRowId} />

To lookup a Row Node use getRowNode() on the Grid API as follows:

// get the row node with ID 55
const rowNode = gridApi.getRowNode('55'); 

// do something with the row, e.g. select it
rowNode.setSelected(true);

Iterating Rows

Sometimes you may want to iterate through all the Row Nodes in the grid. This can be done using the grid's iteration APIs. The iteration APIs go through every Row Node, regardless of whether the Row Node is displayed or not. For example, if grouping and the group is closed, the group's children are not displayed by the grid, however the children are included in the iteration 'for-each' methods.

// iterate through every node in the grid
gridApi.forEachNode((rowNode, index) => {
     console.log('node ' + rowNode.data.athlete + ' is in the grid');
 });

// iterate only nodes that pass the filter
gridApi.forEachNodeAfterFilter((rowNode, index) => {
     console.log('node ' + rowNode.data.athlete + ' passes the filter');
 });

// iterate only nodes that pass the filter and ordered by the sort order
gridApi.forEachNodeAfterFilterAndSort((rowNode, index) => {
     console.log('node ' + rowNode.data.athlete + ' passes the filter and is in this order');
 });

// iterate through every leaf node in the grid
gridApi.forEachLeafNode((rowNode, index) => {
     console.log('node ' + rowNode.data.athlete + ' is not a group!');
 });

All the methods above work with the Client-Side Row Model, i.e. the default Row Model. For all the other row models (i.e. Viewport, Infinite and Server-Side) the only method that is supported is api.forEachNode() and that will return back Row Nodes that are loaded into browser memory only (as each of these row models use a data source to lazy load rows).

Example Using For-Each Methods

The example below shows the different For-Each API methods as follows:

  • For-Each Node: Prints out every row in the grid. It ignores filtering and sorting.
  • For-Each Node After Filter: Prints out every row in the grid, except those filtered out.
  • For-Each Node After Filter and Sort: Prints out every row in the grid, except those filtered, and in the same order they appear on the screen if sorting is applied.
  • For-Each Leaf Node: Prints out every row in the grid except group rows.

In the example, try applying some sorts and filters, and see how this impacts the different operations.