Interface IFinitePaginationStore

Public

interface IFinitePaginationStore {
    currentPage: number;
    pageSize: number;
    get limit(): number;
    get offset(): number;
    get phantomLimit(): number;
    get phantomOffset(): number;
    get phantomPages(): number;
    get phantomRecordsCount(): number;
    get totalPages(): number;
    get totalRecords(): number;
    getList(): void;
    setPage(page: number, cancelAutoReload?: boolean): void;
    setPageSize(pageSize: number): void;
    setPhantomRecordsCount(phantomRecordsCount: number): void;
    setRecordsCount(totalRecords: number): void;
}

Hierarchy (view full)

Properties

currentPage pageSize

Accessors

limit offset phantomLimit phantomOffset phantomPages phantomRecordsCount totalPages totalRecords

Methods

getList setPage setPageSize setPhantomRecordsCount setRecordsCount

Properties

currentPage

currentPage: number

pageSize

pageSize: number

Accessors

limit

  • get limit(): number

  • Returns a number of non-phantom records on a page

    Returns number

offset

  • get offset(): number

  • Returns number

phantomLimit

  • get phantomLimit(): number

  • Returns a number of phantom records on a page

    Returns number

phantomOffset

  • get phantomOffset(): number

  • Returns an offset with phantom pages

    Returns number

phantomPages

  • get phantomPages(): number

  • Returns the number of COMPLETE pages (size = paginationSize) that contain ONLY phantom records

    Returns number

phantomRecordsCount

  • get phantomRecordsCount(): number

  • Returns number

totalPages

  • get totalPages(): number

  • Returns number

totalRecords

  • get totalRecords(): number

  • Returns number

Methods

getList

setPage

  • setPage(page, cancelAutoReload?): void

  • Parameters

    • page: number
    • OptionalcancelAutoReload: boolean

    Returns void

setPageSize

setPhantomRecordsCount

  • setPhantomRecordsCount(phantomRecordsCount): void

  • Parameters

    • phantomRecordsCount: number

    Returns void

setRecordsCount

  • setRecordsCount(totalRecords): void

  • Parameters

    • totalRecords: number

    Returns void

On This Page

Properties
Accessors
Methods