Interface IDataProvider

Hierarchy

default
- IDataProvider

Implemented by

DataProvider

Properties

Readonly columnTypes

columnTypes: {}

Type declaration

[columnType: string]: IColumnConstructor

Methods

aggregateAllOf

aggregateAllOf(ranking: Ranking, aggregateAll: number | boolean | EAggregationState, groups?: IGroup[]): void

- Defined in src/provider/interfaces.ts:108
Parameters
- ranking: Ranking
- aggregateAll: number | boolean | EAggregationState
- Optional groups: IGroup[]
Returns void

clearFilters

clearFilters(): void

- Defined in src/provider/interfaces.ts:119
Returns void

clone

clone(col: Column): Column

- Defined in src/provider/interfaces.ts:81
Parameters
- col: Column
Returns Column

create

create(desc: IColumnDesc): Column

- Defined in src/provider/interfaces.ts:83
Parameters
- desc: IColumnDesc
Returns Column

Protected createEventList

createEventList(): string[]

Inherited from AEventDispatcher.createEventList
- Defined in src/internal/AEventDispatcher.ts:97
return the list of events to be able to dispatch

Returns string[]
by default no events

ensureOneRanking

ensureOneRanking(): void

- Defined in src/provider/interfaces.ts:77
Returns void

find

find(id: string): Column

- Defined in src/provider/interfaces.ts:79
Parameters
- id: string
Returns Column

Protected fire

fire(type: string | string[], ...args: any[]): void

Inherited from AEventDispatcher.fire
- Defined in src/internal/AEventDispatcher.ts:101
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void

Protected forward

forward(from: IEventHandler, ...types: string[]): void

Inherited from AEventDispatcher.forward
- Defined in src/internal/AEventDispatcher.ts:137
forwards one or more events from a given dispatcher to the current one i.e. when one of the given events is fired in 'from' it will be forwarded to all my listeners

Parameters
- from: IEventHandler
  
  the event dispatcher to forward from
- Rest ...types: string[]
  
  the event types to forward
Returns void

fromDescRef

fromDescRef(ref: any): IColumnDesc

- Defined in src/provider/interfaces.ts:87
Parameters
- ref: any
Returns IColumnDesc

getAggregationState

getAggregationState(ranking: Ranking, group: IGroup): EAggregationState

- Defined in src/provider/interfaces.ts:106
Parameters
- ranking: Ranking
- group: IGroup
Returns EAggregationState

getAggregationStrategy

getAggregationStrategy(): IAggregationStrategy

- Defined in src/provider/interfaces.ts:100
Returns IAggregationStrategy

getColumns

getColumns(): IColumnDesc[]

- Defined in src/provider/interfaces.ts:98
Returns IColumnDesc[]

getFirstRanking

getFirstRanking(): Ranking

- Defined in src/provider/interfaces.ts:95
Returns Ranking

getLastRanking

getLastRanking(): Ranking

- Defined in src/provider/interfaces.ts:96
Returns Ranking

getRankings

getRankings(): Ranking[]

- Defined in src/provider/interfaces.ts:93
Returns Ranking[]

getRow

getRow(dataIndex: number): IDataRow | Promise<IDataRow>

- Defined in src/provider/interfaces.ts:117
Parameters
- dataIndex: number
Returns IDataRow | Promise<IDataRow>

getSelection

getSelection(): number[]

- Defined in src/provider/interfaces.ts:67
Returns number[]

getShowTopN

getShowTopN(): number

- Defined in src/provider/interfaces.ts:115
Returns number

getTaskExecutor

getTaskExecutor(): IRenderTasks

- Defined in src/provider/interfaces.ts:59
Returns IRenderTasks

getTopNAggregated

getTopNAggregated(ranking: Ranking, group: IGroup): number

- Defined in src/provider/interfaces.ts:110
Parameters
- ranking: Ranking
- group: IGroup
Returns number

getTotalNumberOfRows

getTotalNumberOfRows(): number

- Defined in src/provider/interfaces.ts:57
Returns number

getTypeFactory

getTypeFactory(): ITypeFactory

- Defined in src/provider/interfaces.ts:61
Returns ITypeFactory

isAggregated

isAggregated(ranking: Ranking, group: IGroup): boolean

- Defined in src/provider/interfaces.ts:102
Parameters
- ranking: Ranking
- group: IGroup
Returns boolean

isSelected

isSelected(i: number): boolean

- Defined in src/provider/interfaces.ts:73
Parameters
- i: number
Returns boolean

Protected listenersChanged

listenersChanged(_type: string, _active: boolean): void

Inherited from AEventDispatcher.listenersChanged
- Defined in src/internal/AEventDispatcher.ts:89
helper function that will be called upon a listener has changed

Parameters
- _type: string
  
  event type
- _active: boolean
  
  registered or de registered
Returns void

mappingSample

mappingSample(col: Column): ISequence<number> | Promise<ISequence<number>>

- Defined in src/provider/interfaces.ts:89
Parameters
- col: Column
Returns ISequence<number> | Promise<ISequence<number>>

on

on(type: string | string[], listener: IEventListener): IDataProvider

Inherited from AEventDispatcher.on
- Defined in src/internal/AEventDispatcher.ts:65
Parameters
- type: string | string[]
- listener: IEventListener
Returns IDataProvider

removeRanking

removeRanking(ranking: Ranking): void

- Defined in src/provider/interfaces.ts:75
Parameters
- ranking: Ranking
Returns void

searchAndJump

searchAndJump(search: string | RegExp, col: Column): void

- Defined in src/provider/interfaces.ts:91
Parameters
- search: string | RegExp
- col: Column
Returns void

selectAllOf

selectAllOf(ranking: Ranking): void

- Defined in src/provider/interfaces.ts:65
Parameters
- ranking: Ranking
Returns void

setAggregationState

setAggregationState(ranking: Ranking, group: IGroup, state: EAggregationState): void

- Defined in src/provider/interfaces.ts:104
Parameters
- ranking: Ranking
- group: IGroup
- state: EAggregationState
Returns void

setSelection

setSelection(dataIndices: IndicesArray): void

- Defined in src/provider/interfaces.ts:69
Parameters
- dataIndices: IndicesArray
Returns void

setShowTopN

setShowTopN(value: number): void

- Defined in src/provider/interfaces.ts:114
Parameters
- value: number
Returns void

setTopNAggregated

setTopNAggregated(ranking: Ranking, group: IGroup, value: number): void

- Defined in src/provider/interfaces.ts:112
Parameters
- ranking: Ranking
- group: IGroup
- value: number
Returns void

takeSnapshot

takeSnapshot(col: Column): void

- Defined in src/provider/interfaces.ts:63
Parameters
- col: Column
Returns void

toDescRef

toDescRef(desc: IColumnDesc): any

- Defined in src/provider/interfaces.ts:85
Parameters
- desc: IColumnDesc
Returns any

toggleSelection

toggleSelection(i: number, additional?: boolean): boolean

- Defined in src/provider/interfaces.ts:71
Parameters
- i: number
- Optional additional: boolean
Returns boolean

Protected unforward

unforward(from: IEventHandler, ...types: string[]): void

Inherited from AEventDispatcher.unforward
- Defined in src/internal/AEventDispatcher.ts:146
removes the forwarding declarations

Parameters
- from: IEventHandler
  
  the originated dispatcher
- Rest ...types: string[]
  
  event types to forward
Returns void