Class DataStore<T>

Type Parameters

T = any

Hierarchy (View Summary)

EventSource<DataStoreEventMap>
- DataStore

Index

Constructors

Properties

m_fields m_model m_proxy m_rec_index m_records

Accessors

Constructors

constructor

new DataStore<T = any>(props: DataStoreProps): DataStore<T>
Type Parameters
- T = any
Parameters
- props: DataStoreProps
Returns DataStore<T>
Overrides EventSource.constructor
- Defined in src/core/core_data.ts:575

Properties

`Protected`m_fields

m_fields: FieldInfo[]

`Protected`m_model

m_model: DataModel<T>

`Protected`m_proxy

m_proxy: DataProxy

`Protected`m_rec_index

m_rec_index: DataIndex

`Protected`m_records

m_records: DataRecord<T>[]

Accessors

count

get count(): number
return the number of records

Returns number
- Defined in src/core/core_data.ts:728

fields

get fields(): FieldInfo[]
return the fields

Returns FieldInfo[]
- Defined in src/core/core_data.ts:736

Methods

addListener

addListener<K extends "data_change">(
    name: K,
    callback: (ev: DataStoreEventMap[K]) => void,
    capturing?: boolean,
): () => void
Registers an event listener for a specific event name.
Type Parameters
- K extends "data_change"
Parameters
- name: K
  The name of the event to listen for (must be a key in E).
- callback: (ev: DataStoreEventMap[K]) => void
  The function to be called when the event is fired.
- capturing: boolean = false
  If true, the listener will be added to the beginning of the listener list (capturing phase).
Returns () => void
Inherited from EventSource.addListener
- Defined in src/core/core_events.ts:108

append

append(rec: DataRecord): void
Parameters
- rec: DataRecord
Returns void
- Defined in src/core/core_data.ts:675

appendRaw

appendRaw(rec: T): void
Parameters
- rec: T
Returns void
- Defined in src/core/core_data.ts:671

changed

changed(): void
Returns void
- Defined in src/core/core_data.ts:1078

createIndex

createIndex(filter: FilterInfo): DataIndex
Parameters
- filter: FilterInfo
Returns DataIndex
- Defined in src/core/core_data.ts:819

createView

createView(opts?: DataViewProps): DataView
create a new view on the DataStore
Parameters
- Optionalopts: DataViewProps
Returns DataView
- Defined in src/core/core_data.ts:810

delete

delete(id: any): boolean
Parameters
- id: any
Returns boolean
- Defined in src/core/core_data.ts:708

export

export(): DataRecord<T>[]
Returns DataRecord<T>[]
- Defined in src/core/core_data.ts:1074

find

find(cb: (rec: DataRecord) => boolean): DataRecord<T>
Parameters
- cb: (rec: DataRecord) => boolean
Returns DataRecord<T>
- Defined in src/core/core_data.ts:1051

fire

fire<K extends "data_change">(name: K, evx: DataStoreEventMap[K]): void
Dispatches an event with a given name and payload to all registered listeners.
Type Parameters
- K extends "data_change"
Parameters
- name: K
  The name of the event to fire (must be a key in E).
- evx: DataStoreEventMap[K]
  The event payload (event object) to pass to the listeners.
Returns void
Inherited from EventSource.fire
- Defined in src/core/core_events.ts:165

forEach

forEach(cb: (rec: DataRecord, index: number) => any): void
Parameters
- cb: (rec: DataRecord, index: number) => any
Returns void
- Defined in src/core/core_data.ts:1031

getById

getById(id: any): DataRecord<T>
return the record by it's id
Parameters
- id: any
Returns DataRecord<T>
record or null
- Defined in src/core/core_data.ts:777

getByIndex

getByIndex(index: number): DataRecord<T>
return a record by it's index
Parameters
- index: number
Returns DataRecord<T>
record or null
- Defined in src/core/core_data.ts:792

getMaxId

getMaxId(): number
Returns number
- Defined in src/core/core_data.ts:689

getModel

getModel(): DataModel<T>
Returns DataModel<T>
- Defined in src/core/core_data.ts:1082

indexOfId

indexOfId(id: any): number
find the index of the element with the given id
Parameters
- id: any
Returns number
- Defined in src/core/core_data.ts:744

load

load(url?: string): Promise<void>
Parameters
- Optionalurl: string
Returns Promise<void>
- Defined in src/core/core_data.ts:607

moveTo

moveTo(other: DataStore): void
Parameters
- other: DataStore
Returns void
- Defined in src/core/core_data.ts:801

reload

reload(): Promise<void>
Returns Promise<void>
- Defined in src/core/core_data.ts:611

removeListener

removeListener<K extends "data_change">(
name: K,
callback: (ev: DataStoreEventMap[K]) => any,
): void
Removes a previously registered event listener.
Type Parameters
- K extends "data_change"
Parameters
- name: K
  The name of the event from which to remove the listener.
- callback: (ev: DataStoreEventMap[K]) => any
  The specific callback function to remove. It must be the same function instance that was originally registered.
Returns void
Inherited from EventSource.removeListener
- Defined in src/core/core_events.ts:142

setData

setData(records: any[]): void
convert raw objects to real records from model
Parameters
- records: any[]
Returns void
- Defined in src/core/core_data.ts:620

setRawData

setRawData(records: DataRecord<any>[]): void
just set the records
Parameters
- records: DataRecord<any>[]
  must be of the same type as model
Returns void
- Defined in src/core/core_data.ts:636

sortIndex

sortIndex(index: DataIndex, sort: SortProp[]): DataIndex
Parameters
- index: DataIndex
- sort: SortProp[]
Returns DataIndex
- Defined in src/core/core_data.ts:942

update

update(rec: DataRecord): boolean
Parameters
- rec: DataRecord
Returns boolean
- Defined in src/core/core_data.ts:653