React Grid: Client-Side Data
By default the grid expects you to provide all the data up front. In other words, your application loads the full set of data into the client and then passes it in its entirety to the grid. This is in contrast to Server-Side Data where the data is mostly kept on the server and loaded into the grid in parts.
The grid has different Row Models depending on whether you want to use client-side or server-side data. There is only one client-side row model, aptly named the "Client-Side Row Model". You don't need to configure the grid to use the Client-Side Row Model as it's used by default. Check Server-Side Data to see what other row models are available and how to use them.
Once the grid has all of the data, it can perform many operations on it for you, such as filtering, sorting and grouping.
You do not need to know how the Client-Side Row Model works, however it can be helpful for those who are interested.
The Client-Side Row Model is responsible for working out how to display the rows inside the grid. It has a complex data structure, representing the data in different states. The states are as follows:
The data as provided by the application. The grid never modifies this array. It just takes the
rowData items from it. This example is of three data items.
API: There is no API to get this data. However it was provided by the application so you should already have it.
allRows is similar to
rowData except a new array is created which contains row nodes, with each row node pointing to exactly one data item. The length of the
allRows array is the same as the
API: There is no API to get this data. However there is no benefit over the
allRows, and if grouping, groups the data. If no grouping is done, then
rowsAfterGroup will be identical to
allRows. This example shows grouping on the colour field, creating two groups.
api.forEachNode() to access this structure.
rowsAfterFilter goes through
rowsAfterGroup and filters the data. This example shows filtering on the colour black (thus removing the second group).
api.forEachNodeAfterFilter() to access this structure.
rowsAfterSort goes through
rowsAfterFilter and sorts the data. This example shows sorting on car make.
api.forEachNodeAfterFilterAndSort() to access this structure.
rowsAfterMap maps the data to what should be drawn inside the grid, taking into account what groups are open and closed. This list is what is iterated through when the grid draws the rows. Two examples are provided below, the first when open (so three rows in the grid, the group row plus two children), the second when closed (so one row in the grid, the closed group).
api.getModel() and then
getVirtualRow() to get the nodes.
If you do want to refresh the Client-Side Row Model, call
startingStage can be one of the stages above, i.e.:
Because each stage depends on the stage before, refreshing any particular stage means that stage executes and then all the stages after it will also execute again. For example if you call
api.refreshClientSideRowModel('filter') it will execute the stages Filter, Pivot, Aggregate, Sort and Map.