DataTable.Paginator Class
Item Index
Methods
Methods
firstPage
()
chainable
Sets the paginatorModel to the first page.
lastPage
()
chainable
Sets the paginatorModel to the last page.
nextPage
()
chainable
Sets the paginatorModel to the next page.
previousPage
()
chainable
Sets the paginatorModel to the previous page.
Attributes
pageSizes
Array
Array of values used to populate the values in the Paginator UI allowing the end user to select the number of items to display per page.
Default: [10, 50, 100, { label: 'Show All', value: -1 }]
Fires event pageSizesChange
Fires when the value for the configuration attribute pageSizes is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorLocation
String | Array | Node
String of footer or header, a Y.Node, or an Array or any combination
of those values.
Default: footer
Fires event paginatorLocationChange
Fires when the value for the configuration attribute paginatorLocation is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorModel
Model | Object
A model instance or a configuration object for the Model.
Default: null
Fires event paginatorModelChange
Fires when the value for the configuration attribute paginatorModel is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorModelType
Model | String
A pointer to a Model object to be instantiated, or a String off of the
Y namespace.
This is only used if the paginatorModel is a configuration object or
is null.
Default: 'DataTable.Paginator.Model'
Fires event paginatorModelTypeChange
Fires when the value for the configuration attribute paginatorModelType is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
paginatorView
View | String
A pointer to a Y.View object to be instantiated. A new view will be
created for each location provided. Each view created will be given the
same model instance.
Default: 'DataTable.Paginator.View'
Fires event paginatorViewChange
Fires when the value for the configuration attribute paginatorView is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
rowsPerPage
Number | null
Number of rows to display per page. As the UI changes the number of pages to display, this will update to reflect the value selected in the UI
Default: null
Fires event rowsPerPageChange
Fires when the value for the configuration attribute rowsPerPage is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added: