\Kendo\UI\GridPageable
A PHP class representing the pageable setting of Grid.
Methods
alwaysVisible
By default the grid will show the pager even when total amount of items in the DataSource is less than the pageSize.If set to false the grid will toggle the pager visibility as follows: when the total amount of items initially set in the DataSource is less than the pageSize number the pager will be hidden.; when the total amount of items initially set in the DataSource is greater than or equal to the pageSize number the pager will be shown.; when the total amount of items in the DataSource becomes less than the pageSize number (after delete, filter operation or pageSize change) the pager will be hidden. or when the total amount of items in the DataSource becomes greater than or equal to the pageSize number (after an insert, filter operation or pageSize change) the pager will be shown.. Introduced in the Kendo UI 2017 R3 release.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->alwaysVisible(true);
?>
buttonCount
The maximum number of buttons displayed in the numeric pager. The pager will display ellipsis (...) if there are more pages than the specified number.
Returns
\Kendo\UI\GridPageable
Parameters
$value float
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->buttonCount(1);
?>
info
If set to true the pager will display information about the current page and total number of data items. By default the paging information is displayed.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->info(true);
?>
input
If set to true the pager will display an input element which allows the user to type a specific page number. By default the page input is not displayed.Using pageable.input and pageable.numeric at the same time is not recommended.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->input(true);
?>
messages
The text messages displayed in pager. Use this option to customize or localize the pager messages.
Returns
\Kendo\UI\GridPageable
Parameters
$value \Kendo\UI\GridPageableMessages|array
Example - using \Kendo\UI\GridPageableMessages
<?php
$pageable = new \Kendo\UI\GridPageable();
$messages = new \Kendo\UI\GridPageableMessages();
$display = 'value';
$messages->display($display);
$pageable->messages($messages);
?>
Example - using array
<?php
$pageable = new \Kendo\UI\GridPageable();
$display = 'value';
$pageable->messages(array('display' => $display));
?>
numeric
If set to true the pager will display buttons for navigating to specific pages. By default those buttons are displayed.Using pageable.numeric and pageable.input at the same time is not recommended.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->numeric(true);
?>
pageSize
The number of data items which will be displayed in the grid. This setting will not work if the Grid is assigned an already existing Kendo UI DataSource instance.
Returns
\Kendo\UI\GridPageable
Parameters
$value float
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->pageSize(1);
?>
pageSizes
If set to true the pager will display a drop-down which allows the user to pick a page size. By default the page size drop-down is not displayed.Can be set to an array of predefined page sizes to override the default list. A special all value is supported. It sets the page size to the total number of records.If a pageSize setting is provided for the data source then this value will be selected initially.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean|array
Example - using boolean
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->pageSizes(true);
?>
Example - using array
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->pageSizes(array());
?>
position
Specifies the position in which the grid pager will be rendered. Valid values are "top" and "bottom" (default).
Returns
\Kendo\UI\GridPageable
Parameters
$value string
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->position('value');
?>
previousNext
If set to true the pager will display buttons for going to the first, previous, next and last pages. By default those buttons are displayed.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->previousNext(true);
?>
refresh
If set to true the pager will display the refresh button. Clicking the refresh button will refresh the grid. By default the refresh button is not displayed.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->refresh(true);
?>
responsive
If set to false the pager will not be responsive. By default the pager is responsive.
Returns
\Kendo\UI\GridPageable
Parameters
$value boolean
Example
<?php
$pageable = new \Kendo\UI\GridPageable();
$pageable->responsive(true);
?>