========
paginate
========

.. js:attribute:: paginate

**domain**: client 

**language**: javascript

**class** :doc:`Item class </refs/client/item_api>`

Description
===========

The ``paginate`` attribute determines the behavior of a table created by the
:doc:`create_table <m_create_table>`
method

When ``paginate`` is set to ``true``, a paginator is created, and the table 
calculates the number of the rows displayed, based on its height. The table will 
internally manipulate the
``limit`` and ``offset``  parameters of the 
:doc:`open <m_open>` 
method, depending on its height and current page, reopening the dataset when
page changes.

If ``paginate`` value is ``false``, the table will displays all available
records of the dataset.

See also
========

:doc:`create_table <m_create_table>`

:doc:`open <m_open>`