Class DataView<T>

Dataview allow different views of the DataStore. You can sort the columns & filter data You can have multiple views for a single DataStore

Type Parameters

T extends Record = Record

Hierarchy

BaseComponent<DataViewProps<T>, DataViewEventMap>
- DataView

Index

Constructors

Properties

#m_timers m_filter m_index m_props m_sort m_store

Accessors

Constructors

constructor

new DataView<T>(props): DataView<T>
Type Parameters
- T extends Record<T> = Record
Parameters
- props: DataViewProps<T>
Returns DataView<T>
Overrides BaseComponent.constructor
- Defined in src/datastore.ts:1148

Properties

`Private` #m_timers

#m_timers: Map<string, Function>

`Protected` m_filter

m_filter: FilterInfo

`Protected` m_index

m_index: Uint32Array

`Protected` m_props

m_props: DataViewProps<T>

`Protected` m_sort

m_sort: SortProp[]

`Protected` m_store

m_store: DataStore<T>

Accessors

count

get count(): number
Returns number
- Defined in src/datastore.ts:1243

store

get store(): DataStore<T>
Returns DataStore<T>
- Defined in src/datastore.ts:1235

Methods

_emit

_emit(eventName, e): void
Parameters
- eventName: string
- e: BasicEvent
Returns void
Inherited from BaseComponent._emit
- Defined in src/x4events.ts:291

`Private` _filter

_filter(filter, notify): number
Parameters
- filter: FilterInfo
- notify: boolean
Returns number
- Defined in src/datastore.ts:1195

_off

_off(eventName, callback): void
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns void
Inherited from BaseComponent._off
- Defined in src/x4events.ts:550

_on

_on(eventName, callback, capturing?): EventDisposer
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
- capturing: boolean = false
Returns EventDisposer
Inherited from BaseComponent._on
- Defined in src/x4events.ts:513

_once

_once(eventName, callback): Promise<unknown>
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns Promise<unknown>
Inherited from BaseComponent._once
- Defined in src/x4events.ts:412

_signal

_signal(eventName, e, delay?): void
Parameters
- eventName: string
- e: BasicEvent
- delay: number = -1
Returns void
Inherited from BaseComponent._signal
- Defined in src/x4events.ts:348

`Private` _sort

_sort(props, notify): void
Parameters
- props: SortProp[]
- notify: boolean
Returns void
- Defined in src/datastore.ts:1222

`Private` _storeChange

_storeChange(ev): void
Parameters
- ev: EvDataChange
Returns void
- Defined in src/datastore.ts:1176

changed

changed(): void
Returns void
- Defined in src/datastore.ts:1281

defaults

defaults(events): void
define a set of default handlers in one call
Parameters
- events: MapEvents<DataViewEventMap>
Returns void
Inherited from BaseComponent.defaults
- Defined in src/x4events.ts:495

disposeTimers

disposeTimers(): void
stop all timers

Returns void
Inherited from BaseComponent.disposeTimers
- Defined in src/base_component.ts:122

emit

emit<K>(type, event?): void
emit an event you can stop propagation of event or prevent default
Type Parameters
- K extends keyof DataViewEventMap
Parameters
- type: K
- Optional event: DataViewEventMap[K]
  
  event data
Returns void
Inherited from BaseComponent.emit
- Defined in src/x4events.ts:287

filter

filter(filter?): number
Parameters
- Optional filter: FilterInfo
Returns number
- Defined in src/datastore.ts:1189

forEach

forEach(cb): void
Parameters
- cb: ((rec, index) => any)
  - - (rec, index): any
    - Parameters
      
      rec: T
      
      index: number
      
      Returns any
Returns void
- Defined in src/datastore.ts:1289

getById

getById(id): T
Parameters
- id: any
Returns T
- Defined in src/datastore.ts:1277

getByIndex

getByIndex(index): T
Parameters
- index: number
Returns T
- Defined in src/datastore.ts:1262

indexOfId

indexOfId(id): number
Parameters
- id: any
Returns number
- Defined in src/datastore.ts:1252

listen

listen(events): void
define a set of listeners in one call
Parameters
- events: MapEvents<DataViewEventMap>
Returns void
Inherited from BaseComponent.listen
- Defined in src/x4events.ts:484

mapPropEvents

mapPropEvents<N>(props, ...elements): void
Type Parameters
- N extends keyof DataViewEventMap
Parameters
- props: DataViewProps<T>
- Rest ...elements: N[]
Returns void
Inherited from BaseComponent.mapPropEvents
- Defined in src/base_component.ts:143

off

off<K>(type, callback): void
stop listening to an event
Type Parameters
- K extends keyof DataViewEventMap
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to remove (must be the same as in on )
  - - (ev): any
    - Parameters
      
      ev: DataViewEventMap[K]
      
      Returns any
Returns void
Inherited from BaseComponent.off
- Defined in src/x4events.ts:545

on

on<K>(type, callback): EventDisposer
listen for an event
Type Parameters
- K extends keyof DataViewEventMap
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to call
  - - (ev): any
    - Parameters
      
      ev: DataViewEventMap[K]
      
      Returns any
Returns EventDisposer
Inherited from BaseComponent.on
- Defined in src/x4events.ts:508

once

once<K>(type, callback): void
handle an event one time
Type Parameters
- K extends keyof DataViewEventMap
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to call when event is signaled
  - - (ev): any
    - Parameters
      
      ev: DataViewEventMap[K]
      
      Returns any
Returns void
Promise if callback is null

take care with that because if the event is never fired and you await it, the system may overflow
Inherited from BaseComponent.once
- Defined in src/x4events.ts:407

removeAllListeners

removeAllListeners(eventName): void
remove all listeners for an event
Parameters
- eventName: string
  
  event name
Returns void
Inherited from BaseComponent.removeAllListeners
- Defined in src/x4events.ts:571

removeDefaultHandler

removeDefaultHandler(eventName, callback): void
remove the previous default handler installed for an event
Parameters
- eventName: string
  
  event name
- callback: EventCallback<BasicEvent>
  
  callback handler to remove (must be the same as in setDefaultHandler)
Returns void
Inherited from BaseComponent.removeDefaultHandler
- Defined in src/x4events.ts:464

setDefaultHandler

setDefaultHandler(eventName, callback): void
set the event default handler
Parameters
- eventName: string
  
  name of the event
- callback: EventCallback<BasicEvent>
  
  callback to call when the event is not handled (and preventDeault has not been called)
Returns void
Inherited from BaseComponent.setDefaultHandler
- Defined in src/x4events.ts:434

signal

signal<K>(type, event, delay?): void
signal en event signaled event are notification : no way to prevent default not stop propagation
Type Parameters
- K extends keyof DataViewEventMap
Parameters
- type: K
- event: DataViewEventMap[K]
  
  event data
- delay: number = -1
Returns void
Inherited from BaseComponent.signal
- Defined in src/x4events.ts:344

singleShot

singleShot(callback, timeout?): void
Parameters
- callback: TimerCallback
- timeout: number = 0
Returns void
Inherited from BaseComponent.singleShot
- Defined in src/base_component.ts:133

sort

sort(props): void
Parameters
- props: SortProp[]
Returns void
- Defined in src/datastore.ts:1218

startTimer

startTimer(name, timeout, repeat?, callback?): void
start a new timer
Parameters
- name: string
  
  timer name
- timeout: number
  
  time out in ms
- repeat: boolean = true
  
  if true this is an auto repeat timer
- callback: TimerCallback = null
  
  if !null, the callback to call else a EvTimer is fired
Returns void
Inherited from BaseComponent.startTimer
- Defined in src/base_component.ts:88

stopTimer

stopTimer(name): void
stop the given timer
Parameters
- name: string
Returns void
Inherited from BaseComponent.stopTimer
- Defined in src/base_component.ts:113

Generated using TypeDoc