PageSettings API in React TreeGrid API component

Configures the paging behavior of the TreeGrid.

Properties

currentPage

number

Defines the current page number of the pager in TreeGrid.

Defaults to 1

enableQueryString

boolean

If enableQueryString set to true, then it pass current page information as a query string along with the URL while navigating to other page in TreeGrid.

Defaults to false

pageCount

number

Defines the number of pages to be displayed in the TreeGrid pager container.

Defaults to 8

pageSize

number

Defines the number of records to be displayed in TreeGrid per page.

Defaults to 12

pageSizeMode

PageSizeMode

Specifies the mode of record count in a page. The options are,

• All: Count all the records.
• Root: Count only zeroth level parent records.

Defaults to All

pageSizes

boolean | []

If pageSizes set to true or Array of values, It renders DropDownList in the pager of TreeGrid which allow us to select pageSize from DropDownList.

Defaults to false

template

string

Defines the template which renders customized elements in pager of TreeGrid instead of default elements. It accepts either template string or HTML element ID.

Defaults to null