Box
Map
API
Row
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery TreeList - pager

Configures the pager.

Type:

Object

The pager is an element that allows users to navigate through pages and change their size at runtime. The pager consists of the page navigator and several optional elements: the page size selector, navigation buttons, and page information.

DevExtreme HTML5 JavaScript jQuery Angular Knockout UI component TreeList Pager

DataGrid Demo TreeList Demo

See Also

allowedPageSizes

Specifies the available page sizes in the page size selector.

Type:

Array<Number | String>

|

String

Default Value: 'auto'
Accepted Values: 'all' | 'auto'

Set this property to an array of numbers that specify available page sizes. If you want to allow users to display all records on a single page, add the "all" value to this array. When the property is set to "auto" (the default value), the component automatically calculates the available page sizes based on the current page size.

DataGrid Demo TreeList Demo

displayMode

Specifies the pager's display mode.

Type:

String

Default Value: 'adaptive'
Accepted Values: 'adaptive' | 'compact' | 'full'

The following table illustrates "full" and "compact" display modes:

displayMode Pager appearance
"full"
"compact"

The "adaptive" display mode switches between these two modes based on the component width.

infoText

Specifies the page information text.

Type:

String

Default Value: 'Page {0} of {1} ({2} items)'

You can use the following position markers in this text:

  • {0} - shows the current page number.
  • {1} - shows the total page count.
  • {2} - shows the total row count.
See Also

label

Specifies an aria-label attribute for the pager.

Type:

String

Default Value: 'Page Navigation'

showInfo

Specifies whether to show the page information.

Type:

Boolean

Default Value: false

showNavigationButtons

Specifies whether to show navigation buttons.

Type:

Boolean

Default Value: false

showPageSizeSelector

Specifies whether to show the page size selector.

Type:

Boolean

Default Value: false

visible

Specifies whether the pager is visible.

Type:

Boolean

|

String

Default Value: 'auto'
Accepted Values: 'auto'

The pager is only visible if paging is enabled and the total row count is greater than the pageSize property. If you choose a large page size (for example "All" supported in allowedPageSizes) and the data does not increase (for example, with state storing enabled), the pager is hidden permanently.

DataGrid Demo TreeList Demo