Common Grid Panel Configuration Options
This page describes configuration options available for all client grid panels.
These include:
Name | Type | Cardinality | Default | i18n Resource | Description |
---|---|---|---|---|---|
toolbar | grid actions | 0..n |
| A collection of tools to add to the panel | |
emptyMsg | string | 0..1 | "No data to display" | grid.data.emptyMsg | Text to display if there are no results |
displayMsg | string | 0..1 | "Displaying {0} - {1} of {2}" | grid.page.displayMsg | Paging toolbar text showing which rows are being displayed and how many rows are available in total. If set then this text will be displayed at the end of the grid status bar. Requires at least version 2.16.x of |
beforePageText | string | 0..1 | "Page" | grid.page.beforePage | Label before the page number |
afterPageText | string | 0..1 | "of {0}" | grid.page.afterPage | Text after the page number |
firstText | string | 0..1 | "First Page" | grid.page.first | Tooltip for the first page button |
prevText | string | 0..1 | "Previous Page" | grid.page.prev | Tooltip for previous page button |
nextText | string | 0..1 | "Next Page" | grid.page.next | Tooltip for next page button |
lastText | string | 0..1 | "Last Page" | grid.page.last | Tooltip for last page button |
refreshText | string | 0..1 | "Refresh" | grid.page.refresh | Tooltip for the refresh button |
itemsText | string | 0..1 | "Items per page" | grid.page.items | Text for items per page |
pageSize | integer | 0..1 | 20 |
| The number of results to display per page |
showPageSize | boolean | 0..1 | true |
| Should the page size selector be shown? Requires at least version 2.16.x of |
textSelect | boolean | 0..1 | false |
| Can the user select the text? |