Class DataSource<T>

grid data source

Classdesc

cheetahGrid.data.DataSource

Memberof

cheetahGrid.data

Type Parameters

T

Hierarchy (View Summary)

EventTarget
- DataSource
  - CachedDataSource
  - FilterDataSource

Implements

DataSourceAPI<T>

Index

Constructors

Properties

Accessors

dataSource length source EVENT_TYPE

Methods

addEventListener dispose fireListeners get getField hasField hasListeners listen removeEventListener setField sort unlisten ofArray

Constructors

constructor

new DataSource<T>(obj?: DataSource<T> | DataSourceParam<T>): DataSource<T>
Type Parameters
- T
Parameters
- Optionalobj: DataSource<T> | DataSourceParam<T>
Returns DataSource<T>
Overrides EventTarget.constructor

Properties

`Static`EMPTY

EMPTY: DataSource<any> = ...

Accessors

dataSource

get dataSource(): DataSource<T>
Returns DataSource<T>
Implementation of DataSourceAPI.dataSource

length

get length(): number
Returns number
Implementation of DataSourceAPI.length
set length(length: number): void
Parameters
- length: number
Returns void
Implementation of DataSourceAPI.length

source

get source(): any
Returns any

`Static`EVENT_TYPE

get EVENT_TYPE(): {
    UPDATE_LENGTH: "update_length";
    UPDATED_LENGTH: "updated_length";
    UPDATED_ORDER: "updated_order";
}
Returns {
    UPDATE_LENGTH: "update_length";
    UPDATED_LENGTH: "updated_length";
    UPDATED_ORDER: "updated_order";
}

Methods

addEventListener

addEventListener(type: string, listener: AnyFunction): void
Parameters
- type: string
- listener: AnyFunction
Returns void
Inherited from EventTarget.addEventListener

dispose

dispose(): void
Returns void
Overrides EventTarget.dispose

fireListeners

fireListeners(type: string, ...args: any[]): any
Fires all registered listeners
Parameters
- type: string
  The type of the listeners to fire.
- ...args: any[]
  fire arguments
Returns any
the result of the last listener

Inherited from EventTarget.fireListeners

get

get(index: number): MaybePromiseOrUndef<T>
Parameters
- index: number
Returns MaybePromiseOrUndef<T>
Implementation of DataSourceAPI.get

getField

getField<F extends string | number | symbol | FieldGetter<T> | FieldAssessor<T>>(
index: number,
field: F,
): any
Type Parameters
- F extends string | number | symbol | FieldGetter<T> | FieldAssessor<T>
Parameters
- index: number
- field: F
Returns any
Implementation of DataSourceAPI.getField

hasField

hasField(index: number, field: FieldDef<T>): boolean
Parameters
- index: number
- field: FieldDef<T>
Returns boolean
Implementation of DataSourceAPI.hasField

hasListeners

hasListeners(type: string): boolean
Parameters
- type: string
Returns boolean
Inherited from EventTarget.hasListeners

listen

listen(type: string, listener: AnyFunction): number
Adds an event listener.
Parameters
- type: string
  The event type id.
- listener: AnyFunction
  Callback method.
Returns number
unique id for the listener.

Inherited from EventTarget.listen

removeEventListener

removeEventListener(type: string, listener: AnyFunction): void
Parameters
- type: string
- listener: AnyFunction
Returns void
Inherited from EventTarget.removeEventListener

setField

setField<F extends string | number | symbol | FieldGetter<T> | FieldAssessor<T>>(
    index: number,
    field: F,
    value: any,
): MaybePromise<boolean>
Type Parameters
- F extends string | number | symbol | FieldGetter<T> | FieldAssessor<T>
Parameters
- index: number
- field: F
- value: any
Returns MaybePromise<boolean>
Implementation of DataSourceAPI.setField

sort

sort(field: FieldDef<T>, order: "desc" | "asc"): MaybePromise<void>
Parameters
- field: FieldDef<T>
- order: "desc" | "asc"
Returns MaybePromise<void>
Implementation of DataSourceAPI.sort

unlisten

unlisten(id: number | `${number}`): void
Removes an event listener which was added with listen() by the id returned by listen().
Parameters
- id: number | `${number}`
  the id returned by listen().
Returns void
Inherited from EventTarget.unlisten

`Static`ofArray

ofArray<T>(array: T[]): DataSource<T>
Type Parameters
- T
Parameters
- array: T[]
Returns DataSource<T>