Interface IDataProvider

base class for event dispatching using d3 event mechanism, thus .suffix is supported for multiple registrations

Hierarchy

AEventDispatcher
- IDataProvider

Implemented by

DataProvider

Properties

`Readonly` columnTypes

columnTypes: { [columnType: string]: IColumnConstructor }

Type declaration

[columnType: string]: IColumnConstructor

Methods

aggregateAllOf

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

clearFilters

clearFilters(): void
Returns void
- Defined in provider/interfaces.ts:119

clone

clone(col: Column): Column
Parameters
- col: Column
Returns Column
- Defined in provider/interfaces.ts:81

create

create(desc: IColumnDesc): Column
Parameters
- desc: IColumnDesc
Returns Column
- Defined in provider/interfaces.ts:83

`Protected` createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns
by default no events

Returns string[]
Inherited from AEventDispatcher.createEventList
- Defined in internal/AEventDispatcher.ts:97

ensureOneRanking

ensureOneRanking(): void
Returns void
- Defined in provider/interfaces.ts:77

find

find(id: string): Column
Parameters
- id: string
Returns Column
- Defined in provider/interfaces.ts:79

`Protected` fire

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

`Protected` forward

forward(from: IEventHandler, ...types: string[]): void
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
Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

fromDescRef

fromDescRef(ref: any): IColumnDesc
Parameters
- ref: any
Returns IColumnDesc
- Defined in provider/interfaces.ts:87

getAggregationState

getAggregationState(ranking: Ranking, group: IGroup): EAggregationState
Parameters
- ranking: Ranking
- group: IGroup
Returns EAggregationState
- Defined in provider/interfaces.ts:106

getAggregationStrategy

getAggregationStrategy(): IAggregationStrategy
Returns IAggregationStrategy
- Defined in provider/interfaces.ts:100

getColumns

getColumns(): IColumnDesc[]
Returns IColumnDesc[]
- Defined in provider/interfaces.ts:98

getFirstRanking

getFirstRanking(): Ranking
Returns Ranking
- Defined in provider/interfaces.ts:95

getLastRanking

getLastRanking(): Ranking
Returns Ranking
- Defined in provider/interfaces.ts:96

getRankings

getRankings(): Ranking[]
Returns Ranking[]
- Defined in provider/interfaces.ts:93

getRow

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

getSelection

getSelection(): number[]
Returns number[]
- Defined in provider/interfaces.ts:67

getShowTopN

getShowTopN(): number
Returns number
- Defined in provider/interfaces.ts:115

getTaskExecutor

getTaskExecutor(): IRenderTasks
Returns IRenderTasks
- Defined in provider/interfaces.ts:59

getTopNAggregated

getTopNAggregated(ranking: Ranking, group: IGroup): number
Parameters
- ranking: Ranking
- group: IGroup
Returns number
- Defined in provider/interfaces.ts:110

getTotalNumberOfRows

getTotalNumberOfRows(): number
Returns number
- Defined in provider/interfaces.ts:57

getTypeFactory

getTypeFactory(): ITypeFactory
Returns ITypeFactory
- Defined in provider/interfaces.ts:61

isAggregated

isAggregated(ranking: Ranking, group: IGroup): boolean
Parameters
- ranking: Ranking
- group: IGroup
Returns boolean
- Defined in provider/interfaces.ts:102

isSelected

isSelected(i: number): boolean
Parameters
- i: number
Returns boolean
- Defined in provider/interfaces.ts:73

`Protected` listenersChanged

listenersChanged(_type: string, _active: boolean): void
helper function that will be called upon a listener has changed
Parameters
- _type: string
  
  event type
- _active: boolean
  
  registered or de registered
Returns void
Inherited from AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

mappingSample

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

on

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

removeRanking

removeRanking(ranking: Ranking): void
Parameters
- ranking: Ranking
Returns void
- Defined in provider/interfaces.ts:75

searchAndJump

searchAndJump(search: string | RegExp, col: Column): void
Parameters
- search: string | RegExp
- col: Column
Returns void
- Defined in provider/interfaces.ts:91

selectAllOf

selectAllOf(ranking: Ranking): void
Parameters
- ranking: Ranking
Returns void
- Defined in provider/interfaces.ts:65

setAggregationState

setAggregationState(ranking: Ranking, group: IGroup, state: EAggregationState): void
Parameters
- ranking: Ranking
- group: IGroup
- state: EAggregationState
Returns void
- Defined in provider/interfaces.ts:104

setSelection

setSelection(dataIndices: IndicesArray): void
Parameters
- dataIndices: IndicesArray
Returns void
- Defined in provider/interfaces.ts:69

setShowTopN

setShowTopN(value: number): void
Parameters
- value: number
Returns void
- Defined in provider/interfaces.ts:114

setTopNAggregated

setTopNAggregated(ranking: Ranking, group: IGroup, value: number): void
Parameters
- ranking: Ranking
- group: IGroup
- value: number
Returns void
- Defined in provider/interfaces.ts:112

takeSnapshot

takeSnapshot(col: Column): void
Parameters
- col: Column
Returns void
- Defined in provider/interfaces.ts:63

toDescRef

toDescRef(desc: IColumnDesc): any
Parameters
- desc: IColumnDesc
Returns any
- Defined in provider/interfaces.ts:85

toggleSelection

toggleSelection(i: number, additional?: boolean): boolean
Parameters
- i: number
- Optional additional: boolean
Returns boolean
- Defined in provider/interfaces.ts:71

`Protected` unforward

unforward(from: IEventHandler, ...types: string[]): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  
  the originated dispatcher
- Rest ...types: string[]
  
  event types to forward
Returns void
Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146