How to get filtered rows in ag-grid?

Question

I have an ag-Grid with filtering option.

How to get the filtered rows (not the selected) in ag-Grid?

score 15 · Accepted Answer · edited Sep 08 '21 at 14:45

15

You can use the forEachNodeAfterFilter(callback) api method for this.

See https://www.ag-grid.com/javascript-grid-api for all available API calls, including the various forEachXXX methods.

edited Sep 08 '21 at 14:45

Mikhail Tatarkov

7
4

answered Apr 21 '17 at 11:59

Sean Landsman

7,033
2
29
33

1

Isn't there any method for this? I must use a foreach to get this nodes? – Gábor Csikós Apr 21 '17 at 12:03
Hi, yes, you have to iterate over the nodes I'm afraid. You'll need to build up a collection while iterating if you want to do something with the filtered nodes as a whole – Sean Landsman Apr 21 '17 at 12:59
4

anything changed since April? do we still need foreach to get updated dataset? – Angela P Jun 26 '17 at 18:29

score 8 · Answer 2 · edited Mar 20 '21 at 06:31

8

Building off @sean-landsman's answer, here's an example of how to use the forEachNodeAfterFilter(callback) method:

    let rowData = [];
    gridApi.forEachNodeAfterFilter(node => {
      rowData.push(node.data);
    });

edited Mar 20 '21 at 06:31

Whit Waldo

4,806
4
48
70

answered Mar 19 '21 at 11:49

Atanu Mallick

266
4
7

score 5 · Answer 3 · answered Jan 09 '20 at 06:51

5

This took me forever so I'm posting here. Use onFilterChanged() to access the filtered rows, or the filtered + selected rows. The event passed to onFilterChanged() can be used like so (example in Typescript React)

onFilterChanged = ev => {
  if (ev?.api?.rowModel?.rowsToDisplay) {
    this.setState({ selectedRows: ev?.api?.rowModel?.rowsToDisplay.filter(node => node.isSelected()) });
  }
};

answered Jan 09 '20 at 06:51

Andrew

1,406
1
15
23

1

Just fyi, `rowModel` is private, so this may change in future versions. – tim-phillips Jun 25 '21 at 21:15

score 0 · Answer 4 · answered Oct 19 '22 at 05:14

0

You can use getSelectedNodes() and filter() them for filtering hidden rows.

this.gridApi.getSelectedNodes().filter(node => node.displayed).map(node => node.data)

answered Oct 19 '22 at 05:14

t.saagar

1
1

What is gridAPI. What type of data does getSelectedNodes return? NodeList? HTMLCollection? Array? JSON? – Daniel Tate Oct 24 '22 at 20:13

score 0 · Answer 5 · answered Oct 26 '22 at 15:42

0

There is selectAllFiltered() function now:

https://www.ag-grid.com/angular-data-grid/grid-api/?#reference-selection-selectAllFiltered

answered Oct 26 '22 at 15:42

erien

1

How to get filtered rows in ag-grid?

5 Answers5

Linked