API Docs for: 3.13.0
Show:

DataTable.Paginator Class

Defined in: datatable/js/paginator.js:423
Module: datatable-paginator
Parent Module: datatable

Available since 3.11.0

Methods

_afterDataChangeWithPaginator

() protected

Defined in datatable/js/paginator.js:600

Available since 3.11.0

After the data changes, we ensure we are on the first page and the data is augmented

_afterDataUpdatesWithPaginator

(
  • e
)
protected

Defined in datatable/js/paginator.js:625

Available since 3.13.0

After data has changed due to a model being added, removed, or changed, update paginator model totalItems to reflect the changes.

Parameters:

_afterPaginatorModelChange

(
  • [e]
)
protected

Defined in datatable/js/paginator.js:789

Available since 3.11.0

Augments the model list with a paged structure, or updates the paged data. Then fires reset on the model list.

Parameters:

_afterRowsPerPageChange

(
  • e
)
protected

Defined in datatable/js/paginator.js:640

Available since 3.11.0

After the rowsPerPage changes, update the UI to reflect the new number of rows to be displayed. If the new value is null, destroy all instances of the paginators.

Parameters:

_augmentData

() protected

Defined in datatable/js/paginator.js:814

Available since 3.11.0

Augments the model list data structure with paged implementations.

The model list will contain a method for getPage that will return the given number of items listed within the range.

each will also loop over the items in the page

_defPageSizeVal

() protected

Defined in datatable/js/paginator.js:953

Available since 3.13.0

Returns an Array with default values for the Rows Per Page select option. We had to use a valueFn to enable language string replacement.

_getConstructor

(
  • type
)
protected

Defined in datatable/js/paginator.js:925

Available since 3.11.0

Returns a pointer to an object to be instantiated if the provided type is a string

Parameters:

  • type Object | String

    Type of Object to contruct. If type is a String, we assume it is a namespace off the Y object

Returns:

_initPaginatorStrings

() protected

Defined in datatable/js/paginator.js:941

Available since 3.13.0

Initializes paginatorStrings used for internationalization

_paginatorRender

() protected

Defined in datatable/js/paginator.js:580

Available since 3.11.0

Renders the paginator into locations and attaches events.

_paginatorRenderUI

() protected

Defined in datatable/js/paginator.js:680

Available since 3.11.0

Parse each location and render a new view into each area.

_setPageSizesFn

(
  • val
)
protected

Defined in datatable/js/paginator.js:866

Available since 3.11.0

Ensures pageSizes value is an array of objects to be used in the paginator view.

Parameters:

Returns:

Array

_setPaginatorModel

(
  • model
)
protected

Defined in datatable/js/paginator.js:906

Available since 3.11.0

Ensures the object provided is an instance of a Y.Model. If it is not, it assumes it is the configuration of a model, and gets the new model type from paginatorModelType.

Parameters:

Returns:

Y.Model instance

_uiPgHandler

(
  • e
)
protected

Defined in datatable/js/paginator.js:755

Available since 3.11.0

Handles the paginator's UI event into a single location. Updates the paginatorModel according to what type is provided.

Parameters:

firstPage

() chainable

Defined in datatable/js/paginator.js:517

Available since 3.11.0

Sets the paginatorModel to the first page.

initializer

() protected

Defined in datatable/js/paginator.js:564

Available since 3.11.0

Constructor logic

lastPage

() chainable

Defined in datatable/js/paginator.js:528

Available since 3.11.0

Sets the paginatorModel to the last page.

nextPage

() chainable

Defined in datatable/js/paginator.js:551

Available since 3.11.0

Sets the paginatorModel to the next page.

previousPage

() chainable

Defined in datatable/js/paginator.js:540

Available since 3.11.0

Sets the paginatorModel to the previous page.

Attributes

pageSizes

Array

Defined in datatable/js/paginator.js:476

Available since 3.11.0

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:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

paginatorLocation

String | Array | Y.Node

Defined in datatable/js/paginator.js:503

Available since 3.11.0

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:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

paginatorModel

Y.Model | Object

Defined in datatable/js/paginator.js:430

Available since 3.11.0

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:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

paginatorModelType

Y.Model | String

Defined in datatable/js/paginator.js:443

Available since 3.11.0

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:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

paginatorView

Y.View | String

Defined in datatable/js/paginator.js:460

Available since 3.11.0

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:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

rowsPerPage

Number | null

Defined in datatable/js/paginator.js:491

Available since 3.11.0

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:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.