TartJS

Class: Pager

Pager

new tart.base.plugin.Pager(model, pagination)

base/plugin/Pager.js, line 32
Name Type Description
model tart.base.Model

tart.base.Model instance to set pager params.
pagination tart.Pagination optional

optional tart.Pagination instance to handle pagination.

Extends

Members

key

Plugin's parameter key which is inherited from BasePlugin and should be defined

protectedmap

protectedmodel

Methods

inherited clear()

base/plugin/BasePlugin.js, line 48

clear map for plugin

getCurrentPage(){number}

base/plugin/Pager.js, line 131
Returns:
Type Description
number current page number.

getLimit(){number}

base/plugin/Pager.js, line 87
Returns:
Type Description
number current limit.

inherited getModel()

base/plugin/BasePlugin.js, line 55

Getter for model

getTotalPage(){number}

base/plugin/Pager.js, line 124
Returns:
Type Description
number number of pages.

hasNext(){boolean}

base/plugin/Pager.js, line 147
Returns:
Type Description
boolean Whether there is a next page available.

hasPrev(){boolean}

base/plugin/Pager.js, line 139
Returns:
Type Description
boolean Whether there is a previous page available.

next()

base/plugin/Pager.js, line 102

Next wrapper for paginator.

prev()

base/plugin/Pager.js, line 109

Prev wrapper for paginator.

setCurrentPage(currentPageNum)

base/plugin/Pager.js, line 117

setCurrentPage wrapper for paginator.

Name Type Description
currentPageNum number

current page number.

setLimit(limit)

base/plugin/Pager.js, line 78
Name Type Description
limit number

item count to fetch.

setOffset(offset)

base/plugin/Pager.js, line 69
Name Type Description
offset number

cursor start point for paging.

setTotalItems(totalItemCount)

base/plugin/Pager.js, line 95
Name Type Description
totalItemCount number

set total item count for paginator.

setTotalPageCount(pageCount)

base/plugin/Pager.js, line 62
Name Type Description
pageCount number

number of pages.