Pagination

Methods

destroy

Source code

pagination.destroy()

Destroys the plugin instance.

disablePlugin

Source code

pagination.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

enablePlugin

Source code

pagination.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

firstPage

Source code

pagination.firstPage()

Switches the page to the first one.

getCurrentPage

Source code

pagination.getCurrentPage() ⇒ number

Returns the current 1-based page index from internal pagination state.

Returns: number - Current page (at least 1).

getCurrentPageData

Source code

pagination.getCurrentPageData() ⇒ Array<Array>

Gets the visual data for the current page. The returned data may be longer than the defined page size as the data may contain hidden rows (rows that are not rendered in the table).

Returns: Array<Array> - Returns the data for the current page.

getCurrentPageSize

Source code

pagination.getCurrentPageSize() ⇒ number | ‘auto’

Returns the current page size from internal pagination state. May be 'auto'.

Returns: number | 'auto' - Current page size or 'auto'.

getPaginationData

Source code

pagination.getPaginationData() ⇒ Object

Gets the pagination current state. Returns an object with the following properties:

currentPage: The current page number.
totalPages: The total number of pages.
pageSize: The page size.
pageSizeList: The list of page sizes.
autoPageSize: Whether the page size is calculated automatically.
numberOfRenderedRows: The number of rendered rows.
firstVisibleRowIndex: The index of the first visible row.
lastVisibleRowIndex: The index of the last visible row.

hasNextPage

Source code

pagination.hasNextPage() ⇒ boolean

Checks, based on the current internal state, if there is a next page.

hasPreviousPage

Source code

pagination.hasPreviousPage() ⇒ boolean

Checks, based on the current internal state, if there is a previous page.

hidePageCounterSection

Source code

pagination.hidePageCounterSection()

Hides the page counter section in the pagination UI.

Emits: Hooks#event:afterPageCounterVisibilityChange

hidePageNavigationSection

Source code

pagination.hidePageNavigationSection()

Hides the page navigation section in the pagination UI.

Emits: Hooks#event:afterPageNavigationVisibilityChange

hidePageSizeSection

Source code

pagination.hidePageSizeSection()

Hides the page size section in the pagination UI.

Emits: Hooks#event:afterPageSizeVisibilityChange

isEnabled

Source code

pagination.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit hook and if it returns true than the Pagination#enablePlugin method is called.

lastPage

Source code

pagination.lastPage()

Switches the page to the last one.

Source code

pagination.nextPage()

Switches the page to the next one.

Source code

pagination.prevPage()

Switches the page to the previous one.

resetPage

Source code

pagination.resetPage()

Resets the current page to the initial page (initialValue) defined in the settings.

resetPageSize

Source code

pagination.resetPageSize()

Resets the page size to the initial value (pageSize) defined in the settings.

resetPagination

Source code

pagination.resetPagination()

Resets the pagination state to the initial values defined in the settings.

revertPageSizeTo

Source code

pagination.revertPageSizeTo(previousPageSize)

Restores the page size after a failed external load.

Category: Pagination

Param	Type	Description
previousPageSize	`number` `'auto'`	Previous page size.

revertPageTo

Source code

pagination.revertPageTo(previousPage)

Restores the page after a failed external load.

Category: Pagination

Param	Type	Description
previousPage	`number`	Page to restore (1-based).

setPage

Source code

pagination.setPage(pageNumber)

Allows changing the page for specified page number.

Emits: Hooks#event:beforePageChange, Hooks#event:afterPageChange

Param	Type	Description
pageNumber	`number`	The page number to set (from 1 to N). If `0` is passed, it will be transformed to `1`.

setPageSize

Source code

pagination.setPageSize(pageSize)

Changes the page size for the pagination. The method recalculates the state based on the new page size and re-renders the table. If 'auto' is passed, the plugin will calculate the page size based on the viewport size and row heights to make sure that there will be no vertical scrollbar in the table.

Emits: Hooks#event:beforePageSizeChange, Hooks#event:afterPageSizeChange