PageSettings API in React TreeGrid API component

Configures the paging behavior of the TreeGrid, enabling you to manage and display data efficiently across multiple pages.

Properties

currentPage

number

Sets the current page number in the TreeGrid, defining which page of data is initially displayed to users.

Defaults to 1

enableQueryString

boolean

When set to true, appends the current page information as a query string to the remote service URL during page navigation within the TreeGrid.

Defaults to false

pageCount

number

Determines the number of page numbers displayed in the TreeGrid pager container. This setting helps users navigate between different parts of the dataset.

Defaults to 8

pageSize

number

Specifies the number of records to display per page in the TreeGrid. Adjust this setting to control the volume of data presented on each page.

Defaults to 12

pageSizeMode

PageSizeMode

Specifies the mode for counting records on a page, determining whether all records are counted or only zeroth level parent records. The available options are:

• All: Includes all records in the count.
• Root: Includes only zeroth level parent records.

Defaults to All

pageSizes

boolean | []

Enables a DropDownList in the TreeGrid pager, allowing users to select the page size. Accepts either a boolean to toggle this feature or an array of page size options.

Defaults to false

template

string | Function

Provides a custom template for rendering pager elements in the TreeGrid, offering enhanced flexibility and control over the pager’s appearance and functionality. Accepts a template string or the ID of an HTML element.

Defaults to null