Class ListModel

A model for list data.

Hierarchy

ListModel
- PageModel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ListModel(cfg?: ListModelConfig): ListModel

Parameters
- Optional cfg: ListModelConfig
Returns ListModel

Properties

Protected _config

_config: ListModelConfig

Protected _data

_data: JsonObject[] = []

Protected _eventBus

_eventBus: EventBus = new EventBus(this)

Methods

Protected _check

_check(): void

Returns void

Protected _fire

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

Parameters
- type: string
- Optional args: any[]
Returns void

Protected _initConfig

_initConfig(cfg?: ListModelConfig): {}

Parameters
- Optional cfg: ListModelConfig
Returns {}
- [key: string]: T

add

add(records: JsonObject | JsonObject[], silent?: boolean): this

Add new data into the tail.

Parameters
- records: JsonObject | JsonObject[]
- Optional silent: boolean
  
  ignore events
Returns this

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

Returns void

clone

clone(): this

Returns this

destroy

destroy(): void

Returns void

getData

getData(): JsonObject[]

Returns JsonObject[]

getModels

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

Type parameters
- T: Model
Parameters
- Optional klass: Klass<T>
Returns T[]

getRow

getRow(index: number): JsonObject

Parameters
- index: number
Returns JsonObject

getRowById

getRowById(id: number | string): JsonObject

Parameters
- id: number | string
Returns JsonObject

getRowModel

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

Type parameters
- T: Model
Parameters
- index: number
- Optional klass: Klass<T>
Returns T

getSorterBy

getSorterBy(fieldName: string): Sorter

Parameters
- fieldName: string
Returns Sorter

indexOfId

indexOfId(id: number | string): number

Parameters
- id: number | string
Returns number

iniData

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

Returns any
Parameters
- data: any
Returns this

insert

insert(index: number, records: JsonObject | JsonObject[], silent?: boolean): this

Insert new data into the index.

Parameters
- index: number
- records: JsonObject | JsonObject[]
- Optional silent: boolean
  
  ignore events
Returns this

isDestroyed

isDestroyed(): boolean

Returns boolean

isEmpty

isEmpty(): boolean

Returns boolean

load

load<R>(quy: string | HttpRequest, silent?: boolean): Promise<ResultSet<R>>

load using its configured query.

Type parameters
- R
Parameters
- quy: string | HttpRequest
- Optional silent: boolean
Returns Promise<ResultSet<R>>

modelKlass

modelKlass(): Klass<Model>
modelKlass(klass: Klass<Model>): this

Returns Klass<Model>
Parameters
- klass: Klass<Model>
Returns this

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

reload

reload(): Promise<ResultSet<{}[]>>

Returns Promise<ResultSet<{}[]>>

removeAt

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

Parameters
- index: number
- Optional silent: boolean
Returns this

removeSorter

removeSorter(field: string): void

Parameters
- field: string
Returns void

reset

reset(): this

Returns 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

Returns number

sort

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

Parameters
- field: string
- Optional dir: "desc" | "asc"
Returns Promise<any>

validate

validate(): string | boolean

Returns string | boolean

validateRow

validateRow(index: number): string | boolean

Parameters
- index: number
Returns string | boolean