Interface GridPaginationApi

The pagination API interface that is available in the grid apiRef.

interface GridPaginationApi {
    setPage: ((page: number) => void);
    setPageSize: ((pageSize: number) => void);
    setPaginationMeta: ((paginationMeta: GridPaginationMeta) => void);
    setPaginationModel: ((model: GridPaginationModel) => void);
    setRowCount: ((rowCount: number) => void);
}

Hierarchy (view full)

Properties

setPage setPageSize setPaginationMeta setPaginationModel setRowCount

Properties

setPage

setPage: ((page: number) => void)

Sets the displayed page to the value given by page.

Type declaration

    • (page): void

    • Parameters

      • page: number

        The new page number.

      Returns void

setPageSize

setPageSize: ((pageSize: number) => void)

Sets the number of displayed rows to the value given by pageSize.

Type declaration

    • (pageSize): void

    • Parameters

      • pageSize: number

        The new number of displayed rows.

      Returns void

setPaginationMeta

setPaginationMeta: ((paginationMeta: GridPaginationMeta) => void)

Sets the paginationMeta to a new value.

Type declaration

    • (paginationMeta): void

    • Parameters

      Returns void

setPaginationModel

setPaginationModel: ((model: GridPaginationModel) => void)

Sets the paginationModel to a new value.

Type declaration

setRowCount

setRowCount: ((rowCount: number) => void)

Sets the rowCount to a new value.

Type declaration

    • (rowCount): void

    • Parameters

      • rowCount: number

        The new row count value.

      Returns void

Settings

Member Visibility

On This Page

Properties