Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageModel

A pagation model class.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _config

_config: PageModelConfig

Protected _data

_data: JsonObject[] = []

Protected _eventBus

_eventBus: EventBus = new EventBus(this)

Methods

Protected _check

  • _check(): void

Protected _fire

  • _fire(type: string, args?: any[]): void

  • Parameters

    • type: string
    • Optional args: any[]

    Returns void

Protected _initConfig

add

addSorter

  • addSorter(field: string, dir?: "asc" | "desc"): void

  • Parameters

    • field: string
    • Optional dir: "asc" | "desc"

    Returns void

clear

  • clear(silent?: boolean): this

  • Parameters

    • Optional silent: boolean

    Returns this

clearSorters

  • clearSorters(): void

clone

  • clone(): this

destroy

  • destroy(): void

getCurrentPage

  • getCurrentPage(): number

  • Returns number

getData

getFirstPage

  • getFirstPage(): number

  • Returns number

getLastPage

  • getLastPage(): number

  • Returns number

getModels

  • getModels<T>(klass?: Klass<T>): T[]

getNextPage

  • getNextPage(): number

  • Returns number

getPrevPage

  • getPrevPage(): number

  • Returns number

getRow

getRowById

getRowModel

  • getRowModel<T>(index: number, klass?: Klass<T>): T

getSorterBy

  • getSorterBy(fieldName: string): Sorter

indexOfId

  • indexOfId(id: number | string): number

iniData

  • iniData(): any
  • iniData(data: any): this

insert

  • Insert new data into the index.

    Parameters

    Returns this

isDestroyed

  • isDestroyed(): boolean

isEmpty

  • isEmpty(): boolean

load

loadFirstPage

loadLastPage

loadNextPage

loadPage

  • Parameters

    • Optional page: number
    • Optional isForce: boolean

    Returns Promise<ResultSet<{}[]>>

loadPrevPage

modelKlass

off

  • off(type?: string): this

  • Parameters

    • Optional type: string

    Returns this

on

  • on<H>(type: string, fn: H, once?: boolean): this

  • Type parameters

    • H

    Parameters

    • type: string
    • fn: H
    • Optional once: boolean

    Returns this

pageSize

  • pageSize(): number
  • pageSize(size?: number): this

  • Returns number

  • Parameters

    • Optional size: number

    Returns this

reload

removeAt

  • removeAt(index: number, silent?: boolean): this

  • Parameters

    • index: number
    • Optional silent: boolean

    Returns this

removeSorter

  • removeSorter(field: string): void

reset

  • reset(): this

setData

  • setData(data: JsonObject[], silent?: boolean): this

  • Read data into model.

    Parameters

    • data: JsonObject[]
    • Optional silent: boolean

      ignore events

    Returns this

size

  • size(): number

sort

  • sort(field: string, dir?: "desc" | "asc"): Promise<any>

  • Parameters

    • field: string
    • Optional dir: "desc" | "asc"

    Returns Promise<any>

total

  • total(): number
  • total(total?: number): this

  • Returns number

  • Parameters

    • Optional total: number

    Returns this

validate

  • validate(): string | boolean

validateRow

  • validateRow(index: number): string | boolean