Row Pagination

To enable pagination in, set the grid property pagination=true. The following simple example shows this, the only difference to this and previous examples is the pagination=true property.

Remember Pagination works with all frameworks eg Angular and React as well as plain JavaScript.

Supported Row Models

Pagination in ag-Grid is supported in all the different row models. The Client-side Row Model (the default row model) is used for the examples on this page.

To see the specifics of pagination on the other row models check the relevant documentation for Infinite Row Model, Viewport Row Model and Server-side Row Model.

Features While Using Pagination

Pagination does not reduce the feature set of the grid, as long as the underlying row model supports it. In other words, if you are paging over the Client-side Row Model, all features of the Client-side Row Model (grouping, filtering etc) are still available. Likewise for the other row models, if the row model supports it, it's available through pagination and that row model.

Example: Auto Page Size

If you set paginationAutoPageSize=true the grid will automatically show as many rows in each page as it can fit. This is demonstrated below. Note if you resize the display area of the grid, the page size automatically changes. To view this, open the example up in a new tab and resize your browser.

Each pagination page must have the same number of rows. If you use paginationAutoPageSize with getRowHeight() callback (to have different rows with different heights) then the page height will be calculated using the default row height and not the actual row heights. Therefore the rows will not fit perfectly into the page if these features are mixed.

Example: Customising Pagination

In this example the default pagination settings are changed. Note the following:

  • paginationPageSize is set to 10
  • api.paginationGoToPage(4) is called to go to page 4 (0 based, so the 5th page)
  • A dropdown to change the page size dynamically is available. This makes a call to paginationSetPageSize(newPageSize)
  • The numbers in the pagination panel are formatted differently using the grid callback paginationNumberFormatter and putting the numbers into square brackets i.e. [x].

Example: Custom Pagination Controls

If you set suppressPaginationPanel=true, the grid will not show the standard navigation controls for pagination. This is useful is you want to provide your own navigation controls.

In the example below you can see how this works. Note that we are listening to onPaginationChanged to update the information about the current pagination status. We also call methods on the pagination API to change the pagination state.

A summary of the API methods and events can be found at the top of this documentation page.

The example also sets property suppressScrollOnNewData=true, which tells the grid to NOT scroll to the top when the page changes.

Pagination & Child Rows

Both Row Grouping and Master Detail have rows that expand. When this happens, consideration needs to be given as to how this impacts the number of rows on the page. There are two modes of operation that can be used depending on what your application requirements.

Mode 1: Paginate Only Top Level Rows

The first mode is the default. The rows are split according to the top level rows. For example if row grouping with a page size of 10, then each page will contain 10 top level groups. When expanding a group with this mode, all children for that group, along with the 10 original groups for that page, will get display in one page. This will result in a page size greater than the initial page size of 10 rows.

This mode is typically best suited for Row Grouping as children are always displayed alongside the parent group. It is also typically best for Master Detail, as detail rows (that typically contain detail tables) will always appear below their master rows.

In the example below, note the following:

  • Each page will always contain exactly 10 groups.
  • Expanding a group will not push rows to the next page.

Mode 2: Paginate All Rows, Including Children

The second mode paginates all rows, including child rows when Row Grouping and detail rows with Master Detail. For example if row grouping with a page size of 10, then each page will always contain exactly 10 rows, even if it means having children appear on a page after the page containing the parent. This can be particularly confusing if the last row of a page is expanded, as the children will appear on the next page (not visible to the user unless they navigate to the next page).

This modes is typically best if the application never wants to exceed the maximum number of rows in a page past the page size. This can be helpful if designing for touch devices (eg tablets) where UX requirements state no scrolls should be visible in the application - paging to a strict page size can guarantee no vertical scrolls will appear.

To enable pagination on all rows, including children, set grid property paginateChildRows=true.

In the example below, note the following:

  • Each page will always contain exactly 10 rows (not groups).
  • Expanding a group will push rows to the next page to limit the total number of rows to 10.

Fallback to Mode 2

If using either of the following features, the grid will be forced to use the second mode:

This is because both of these features remove top level rows (group rows and master rows) from the displayed rows, making it impossible to paginate based on the top level rows only.

Pagination Properties

pagination True - Pagination is enabled.
False (Default) - Pagination is disabled.
paginationPageSize Number. How many rows to load per page. Default value = 100. If paginationAutoPageSize is specified, this property is ignored.
paginationAutoPageSize True - The number of rows to load per page is automatically adjusted by ag-Grid so each page shows enough rows to just fill the area designated for the grid.
False (Default) - paginationPageSize is used.
suppressPaginationPanel True - The out of the box ag-Grid controls for navigation are hidden. This is useful if pagination=true and you want to provide your own pagination controls.
False (Default) - when pagination=true It automatically shows at the bottom the necessary controls so that the user can navigate through the different pages.
paginateChildRows Set to true to have pages split children of groups when Row Grouping or detail rows with Master Detail. Pagination & Child Rows

The following methods compose the pagination API are all available from gridOptions.api

Pagination API

paginationIsLastPageFound()

Returns true when last page known. This will always be true if you are using the Client-side Row Model for pagination.

Returns false when last page now known. This only happens when using Infinite Scrolling Row Model.

paginationGetPageSize()

How many rows ag-Grid is showing per page.

paginationSetPageSize(newPageSize)

Sets the paginationPageSize to newPageSize Then it repaginates the grid so the changes are applied immediately on the screen.

paginationGetCurrentPage()

Returns the 0 index based page which ag-Grid is showing right now.

paginationGetTotalPages()

Returns the total number of pages. If paginationIsLastPageFound() == false returns null.

paginationGetRowCount()

The total number of rows. If paginationIsLastPageFound() == false returns null.

paginationGoToPage(pageNumber)

Goes to the specified page. If the page requested doesn't exist, it will go to the last page.

paginationGoToNextPage()
paginationGoToPreviousPage()
paginationGoToFirstPage()
paginationGoToLastPage()

Shorthands for goToPage(relevantPageNumber).

Pagination Callbacks

paginationNumberFormatter(params) Allows user to format the numbers in the pagination panel, ie 'row count' and 'page number' labels. This is for pagination panel only, to format numbers inside the grid's cells (ie your data), then use valueFormatter in the column definitions.

Pagination Events

Event Description
paginationChanged

This event is triggered every time the paging state changes, Some of the most common scenarios for this event to be triggered are:

  • The page size changes
  • The current shown page is changed
  • New data is loaded onto the grid