Class DataProvider`Abstract`

a basic data provider holding the data and rankings

Hierarchy

AEventDispatcher
- DataProvider

Implements

IDataProvider

Index

Constructors

constructor

Methods

aggregateAllOf cleanDesc cleanUpRanking clearFilters clearRankings clearSelection clone cloneRanking create createEventList deriveDefault deselect deselectAll destroy dump dumpColumn ensureOneRanking exportSelection exportTable find findDesc fire fireBusy forward fromDescRef getAggregationState getAggregationStrategy getColumns getFirstRanking getLastRanking getRankings getRow getSelection getShowTopN getTaskExecutor getTopNAggregated getTotalNumberOfRows getTypeFactory insert insertRanking instantiateColumn isAggregated isSelected jumpToNearest listenersChanged mappingSample on patchColumn push pushRanking removeRanking restore restoreColumn restoreRanking searchAndJump select selectAll selectAllOf selectedRows setAggregated setAggregationState setSelection setShowTopN setTopNAggregated sort takeSnapshot toDescRef toggleSelection unforward view

Constructors

constructor

new DataProvider(options?: Partial<IDataProviderOptions>): DataProvider
Parameters
- options: Partial<IDataProviderOptions> = {}
Returns DataProvider
Overrides AEventDispatcher.constructor
- Defined in provider/ADataProvider.ts:286

Properties

`Readonly` colorMappingFunctionTypes

colorMappingFunctionTypes: { [colorMappingFunctionType: string]: IColorMappingFunctionConstructor }

Type declaration

[colorMappingFunctionType: string]: IColorMappingFunctionConstructor

`Readonly` columnTypes

columnTypes: { [columnType: string]: IColumnConstructor }

lookup map of a column type to its column implementation

Type declaration

[columnType: string]: IColumnConstructor

`Readonly` mappingFunctionTypes

mappingFunctionTypes: { [mappingFunctionType: string]: IMappingFunctionConstructor }

Type declaration

[mappingFunctionType: string]: IMappingFunctionConstructor

`Static` `Readonly` EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = Ranking.EVENT_ADD_COLUMN

`Static` `Readonly` EVENT_ADD_DESC

EVENT_ADD_DESC: "addDesc" = 'addDesc'

`Static` `Readonly` EVENT_ADD_RANKING

EVENT_ADD_RANKING: "addRanking" = 'addRanking'

`Static` `Readonly` EVENT_BUSY

EVENT_BUSY: "busy" = 'busy'

`Static` `Readonly` EVENT_CLEAR_DESC

EVENT_CLEAR_DESC: "clearDesc" = 'clearDesc'

`Static` `Readonly` EVENT_DATA_CHANGED

EVENT_DATA_CHANGED: "dataChanged" = 'dataChanged'

`Static` `Readonly` EVENT_DIRTY

EVENT_DIRTY: "dirty" = Ranking.EVENT_DIRTY

`Static` `Readonly` EVENT_DIRTY_CACHES

EVENT_DIRTY_CACHES: "dirtyCaches" = Ranking.EVENT_DIRTY_CACHES

`Static` `Readonly` EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = Ranking.EVENT_DIRTY_HEADER

`Static` `Readonly` EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = Ranking.EVENT_DIRTY_VALUES

`Static` `Readonly` EVENT_GROUP_AGGREGATION_CHANGED

EVENT_GROUP_AGGREGATION_CHANGED: "aggregate" = AggregateGroupColumn.EVENT_AGGREGATE

`Static` `Readonly` EVENT_JUMP_TO_NEAREST

EVENT_JUMP_TO_NEAREST: "jumpToNearest" = 'jumpToNearest'

`Static` `Readonly` EVENT_MOVE_COLUMN

EVENT_MOVE_COLUMN: "moveColumn" = Ranking.EVENT_MOVE_COLUMN

`Static` `Readonly` EVENT_ORDER_CHANGED

EVENT_ORDER_CHANGED: "orderChanged" = Ranking.EVENT_ORDER_CHANGED

`Static` `Readonly` EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = Ranking.EVENT_REMOVE_COLUMN

`Static` `Readonly` EVENT_REMOVE_DESC

EVENT_REMOVE_DESC: "removeDesc" = 'removeDesc'

`Static` `Readonly` EVENT_REMOVE_RANKING

EVENT_REMOVE_RANKING: "removeRanking" = 'removeRanking'

`Static` `Readonly` EVENT_SELECTION_CHANGED

EVENT_SELECTION_CHANGED: "selectionChanged" = 'selectionChanged'

`Static` `Readonly` EVENT_SHOWTOPN_CHANGED

EVENT_SHOWTOPN_CHANGED: "showTopNChanged" = 'showTopNChanged'

Methods

aggregateAllOf

aggregateAllOf(ranking: Ranking, aggregateAll: number | boolean | EAggregationState, groups?: IOrderedGroup[]): void
Parameters
- ranking: Ranking
- aggregateAll: number | boolean | EAggregationState
- groups: IOrderedGroup[] = ...
Returns void
Implementation of IDataProvider.aggregateAllOf
- Defined in provider/ADataProvider.ts:956

`Protected` cleanDesc

cleanDesc(desc: IColumnDesc): IColumnDesc
Parameters
- desc: IColumnDesc
Returns IColumnDesc
- Defined in provider/ADataProvider.ts:647

cleanUpRanking

cleanUpRanking(_ranking: Ranking): void
hook method for cleaning up a ranking
Parameters
- _ranking: Ranking
Returns void
- Defined in provider/ADataProvider.ts:580

clearFilters

clearFilters(): void
Returns void
Implementation of IDataProvider.clearFilters
- Defined in provider/ADataProvider.ts:537

clearRankings

clearRankings(): void
removes all rankings

Returns void
- Defined in provider/ADataProvider.ts:517

clearSelection

clearSelection(): void
clears the selection

Returns void
- Defined in provider/ADataProvider.ts:1159

clone

clone(col: Column): Column
clones a column by dumping and restoring

Returns
Parameters
- col: Column
Returns Column
Implementation of IDataProvider.clone
- Defined in provider/ADataProvider.ts:689

`Abstract` cloneRanking

cloneRanking(existing?: Ranking): Ranking
abstract method for cloning a ranking

Returns
Parameters
- Optional existing: Ranking
Returns Ranking
- Defined in provider/ADataProvider.ts:589

create

create(desc: IColumnDesc): Column
creates an internal column model out of the given column description

Returns
the new column or null if it can't be created
Parameters
- desc: IColumnDesc
Returns Column
Implementation of IDataProvider.create
- Defined in provider/ADataProvider.ts:665

`Protected` createEventList

createEventList(): string[]
events:
- column changes: addColumn, removeColumn
- ranking changes: addRanking, removeRanking
- dirty: dirty, dirtyHeder, dirtyValues
- selectionChanged
Returns
Returns string[]
Implementation of IDataProvider.createEventList

Overrides AEventDispatcher.createEventList
- Defined in provider/ADataProvider.ts:332

deriveDefault

deriveDefault(addSupportType?: boolean): Ranking
generates a default ranking by using all column descriptions ones
Parameters
- addSupportType: boolean = true
Returns Ranking
- Defined in provider/ADataProvider.ts:813

deselect

deselect(index: number): void
deselect the given row
Parameters
- index: number
Returns void
- Defined in provider/ADataProvider.ts:1115

deselectAll

deselectAll(indices: IndicesArray): void
also select all the given rows
Parameters
- indices: IndicesArray
Returns void
- Defined in provider/ADataProvider.ts:1127

destroy

destroy(): void
Returns void
- Defined in provider/ADataProvider.ts:572

dump

dump(): IDataProviderDump
dumps this whole provider including selection and the rankings

Returns

Returns IDataProviderDump
- Defined in provider/ADataProvider.ts:727

dumpColumn

dumpColumn(col: Column): IColumnDump
dumps a specific column
Parameters
- col: Column
Returns IColumnDump
- Defined in provider/ADataProvider.ts:741

ensureOneRanking

ensureOneRanking(): void
Returns void
Implementation of IDataProvider.ensureOneRanking
- Defined in provider/ADataProvider.ts:565

exportSelection

exportSelection(options?: Partial<IExportOptions> & { ranking?: Ranking }): string | Promise<string>
utility to export the selection within the given ranking to a table with the given separator

Returns
Parameters
- options: Partial<IExportOptions> & { ranking?: Ranking } = {}
Returns string | Promise<string>
- Defined in provider/ADataProvider.ts:1186

exportTable

exportTable(ranking: Ranking, options?: Partial<IExportOptions>): string | Promise<string>
utility to export a ranking to a table with the given separator

Returns
Parameters
- ranking: Ranking
- options: Partial<IExportOptions> = {}
Returns string | Promise<string>
- Defined in provider/ADataProvider.ts:1173

find

find(idOrFilter: string | ((col: Column) => boolean)): Column
finds a column in all rankings returning the first match

Returns
Parameters
- idOrFilter: string | ((col: Column) => boolean)
  
  by id or by a filter function
Returns Column
Implementation of IDataProvider.find
- Defined in provider/ADataProvider.ts:710

`Abstract` findDesc

findDesc(ref: string): IColumnDesc
Parameters
- ref: string
Returns IColumnDesc
- Defined in provider/ADataProvider.ts:808

`Protected` fire

fire(type: string | string[], ...args: any[]): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Implementation of IDataProvider.fire

Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

`Protected` fireBusy

fireBusy(busy: boolean): void
Parameters
- busy: boolean
Returns void
- Defined in provider/ADataProvider.ts:403

`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
Implementation of IDataProvider.forward

Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

fromDescRef

fromDescRef(descRef: any): any
inverse operation of toDescRef
Parameters
- descRef: any
Returns any
Implementation of IDataProvider.fromDescRef
- Defined in provider/ADataProvider.ts:755

getAggregationState

getAggregationState(ranking: Ranking, group: IGroup): EAggregationState
Parameters
- ranking: Ranking
- group: IGroup
Returns EAggregationState
Implementation of IDataProvider.getAggregationState
- Defined in provider/ADataProvider.ts:836

getAggregationStrategy

getAggregationStrategy(): IAggregationStrategy
Returns IAggregationStrategy
Implementation of IDataProvider.getAggregationStrategy
- Defined in provider/ADataProvider.ts:880

`Abstract` getColumns

getColumns(): IColumnDesc[]
returns a list of all known column descriptions

Returns

Returns IColumnDesc[]
Implementation of IDataProvider.getColumns
- Defined in provider/ADataProvider.ts:387

getFirstRanking

getFirstRanking(): Ranking
returns the last ranking for quicker access

Returns

Returns Ranking
Implementation of IDataProvider.getFirstRanking
- Defined in provider/ADataProvider.ts:553

getLastRanking

getLastRanking(): Ranking
returns the last ranking for quicker access

Returns

Returns Ranking
Implementation of IDataProvider.getLastRanking
- Defined in provider/ADataProvider.ts:561

getRankings

getRankings(): Ranking[]
returns a list of all current rankings

Returns

Returns Ranking[]
Implementation of IDataProvider.getRankings
- Defined in provider/ADataProvider.ts:545

`Abstract` getRow

getRow(index: number): IDataRow | Promise<IDataRow>
Parameters
- index: number
Returns IDataRow | Promise<IDataRow>
Implementation of IDataProvider.getRow
- Defined in provider/ADataProvider.ts:1001

getSelection

getSelection(): number[]
returns the currently selected indices

Returns

Returns number[]
Implementation of IDataProvider.getSelection
- Defined in provider/ADataProvider.ts:1152

getShowTopN

getShowTopN(): number
Returns number
Implementation of IDataProvider.getShowTopN
- Defined in provider/ADataProvider.ts:961

`Abstract` getTaskExecutor

getTaskExecutor(): IRenderTasks
Returns IRenderTasks
Implementation of IDataProvider.getTaskExecutor
- Defined in provider/ADataProvider.ts:389

getTopNAggregated

getTopNAggregated(ranking: Ranking, group: IGroup): number
Parameters
- ranking: Ranking
- group: IGroup
Returns number
Implementation of IDataProvider.getTopNAggregated
- Defined in provider/ADataProvider.ts:853

`Abstract` getTotalNumberOfRows

getTotalNumberOfRows(): number
Returns number
Implementation of IDataProvider.getTotalNumberOfRows
- Defined in provider/ADataProvider.ts:381

getTypeFactory

getTypeFactory(): ITypeFactory
Returns ITypeFactory
Implementation of IDataProvider.getTypeFactory
- Defined in provider/ADataProvider.ts:320

insert

insert(ranking: Ranking, index: number, desc: IColumnDesc): Column
adds a column to a ranking described by its column description

Returns
the newly created column or null
Parameters
- ranking: Ranking
  
  the ranking to add the column to
- index: number
  
  the position to insert the column
- desc: IColumnDesc
  
  the description of the column
Returns Column
- Defined in provider/ADataProvider.ts:613

insertRanking

insertRanking(r: Ranking, index?: number): void
Parameters
- r: Ranking
- index: number = ...
Returns void
- Defined in provider/ADataProvider.ts:445

`Protected` instantiateColumn

instantiateColumn(type: IColumnConstructor, id: string, desc: IColumnDesc, typeFactory: ITypeFactory): Column
Parameters
- type: IColumnConstructor
- id: string
- desc: IColumnDesc
- typeFactory: ITypeFactory
Returns Column
- Defined in provider/ADataProvider.ts:680

isAggregated

isAggregated(ranking: Ranking, group: IGroup): boolean
Parameters
- ranking: Ranking
- group: IGroup
Returns boolean
Implementation of IDataProvider.isAggregated
- Defined in provider/ADataProvider.ts:832

isSelected

isSelected(index: number): boolean
is the given row selected

Returns
Parameters
- index: number
Returns boolean
Implementation of IDataProvider.isSelected
- Defined in provider/ADataProvider.ts:1015

jumpToNearest

jumpToNearest(indices: number[]): void
Parameters
- indices: number[]
Returns void
- Defined in provider/ADataProvider.ts:1041

`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
Implementation of IDataProvider.listenersChanged

Inherited from AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

`Abstract` mappingSample

mappingSample(col: Column): ISequence<number> | Promise<ISequence<number>>
returns a data sample used for the mapping editor

Returns
Parameters
- col: Column
Returns ISequence<number> | Promise<ISequence<number>>
Implementation of IDataProvider.mappingSample
- Defined in provider/ADataProvider.ts:1008

on

on(type: "busy", listener: ((busy: boolean) => void)): DataProvider
Parameters
- type: "busy"
- listener: ((busy: boolean) => void)
  - - (busy: boolean): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      busy: boolean
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:357
on(type: "dataChanged", listener: ((rows: IDataRow[]) => void)): DataProvider
Parameters
- type: "dataChanged"
- listener: ((rows: IDataRow[]) => void)
  - - (rows: IDataRow[]): void
    - emitted when the data changes
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      rows: IDataRow[]
      
      the new data rows
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:358
on(type: "showTopNChanged", listener: ((previous: number, current: number) => void)): DataProvider
Parameters
- type: "showTopNChanged"
- listener: ((previous: number, current: number) => void)
  - - (previous: number, current: number): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      previous: number
      
      current: number
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:359
on(type: "addColumn", listener: ((col: Column, index: number) => void)): DataProvider
Parameters
- type: "addColumn"
- listener: ((col: Column, index: number) => void)
  - - (col: Column, index: number): void
    - emitted when a column has been added
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      col: Column
      
      index: number
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:360
on(type: "moveColumn", listener: ((col: Column, index: number, oldIndex: number) => void)): DataProvider
Parameters
- type: "moveColumn"
- listener: ((col: Column, index: number, oldIndex: number) => void)
  - - (col: Column, index: number, oldIndex: number): void
    - emitted when a column has been moved within this composite column
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      col: Column
      
      index: number
      
      oldIndex: number
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:361
on(type: "removeColumn", listener: ((col: Column, index: number) => void)): DataProvider
Parameters
- type: "removeColumn"
- listener: ((col: Column, index: number) => void)
  - - (col: Column, index: number): void
    - emitted when a column has been removed
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      col: Column
      
      index: number
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:362
on(type: "addRanking", listener: ((ranking: Ranking, index: number) => void)): DataProvider
Parameters
- type: "addRanking"
- listener: ((ranking: Ranking, index: number) => void)
  - - (ranking: Ranking, index: number): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      ranking: Ranking
      
      index: number
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:363
on(type: "removeRanking", listener: ((ranking: Ranking, index: number) => void)): DataProvider
Parameters
- type: "removeRanking"
- listener: ((ranking: Ranking, index: number) => void)
  - - (ranking: Ranking, index: number): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      ranking: Ranking
      
      if null all rankings are removed else just the specific one
      
      index: number
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:364
on(type: "dirty", listener: (() => void)): DataProvider
Parameters
- type: "dirty"
- listener: (() => void)
  - - (): void
    - emitted when state of the column is dirty
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:365
on(type: "dirtyHeader", listener: (() => void)): DataProvider
Parameters
- type: "dirtyHeader"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to its header is dirty
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:366
on(type: "dirtyValues", listener: (() => void)): DataProvider
Parameters
- type: "dirtyValues"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to its values is dirty
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:367
on(type: "dirtyCaches", listener: (() => void)): DataProvider
Parameters
- type: "dirtyCaches"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to cached values (hist, compare, ...) is dirty
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:368
on(type: "orderChanged", listener: ((previous: number[], current: number[], previousGroups: IOrderedGroup[], currentGroups: IOrderedGroup[], dirtyReason: EDirtyReason[]) => void)): DataProvider
Parameters
- type: "orderChanged"
- listener: ((previous: number[], current: number[], previousGroups: IOrderedGroup[], currentGroups: IOrderedGroup[], dirtyReason: EDirtyReason[]) => void)
  - - (previous: number[], current: number[], previousGroups: IOrderedGroup[], currentGroups: IOrderedGroup[], dirtyReason: EDirtyReason[]): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      previous: number[]
      
      current: number[]
      
      previousGroups: IOrderedGroup[]
      
      currentGroups: IOrderedGroup[]
      
      dirtyReason: EDirtyReason[]
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:369
on(type: "addDesc", listener: ((desc: IColumnDesc) => void)): DataProvider
Parameters
- type: "addDesc"
- listener: ((desc: IColumnDesc) => void)
  - - (desc: IColumnDesc): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      desc: IColumnDesc
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:370
on(type: "removeDesc", listener: ((desc: IColumnDesc) => void)): DataProvider
Parameters
- type: "removeDesc"
- listener: ((desc: IColumnDesc) => void)
  - - (desc: IColumnDesc): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      desc: IColumnDesc
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:371
on(type: "clearDesc", listener: (() => void)): DataProvider
Parameters
- type: "clearDesc"
- listener: (() => void)
  - - (): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:372
on(type: "jumpToNearest", listener: ((dataIndices: number[]) => void)): DataProvider
Parameters
- type: "jumpToNearest"
- listener: ((dataIndices: number[]) => void)
  - - (dataIndices: number[]): void
    - emitted when the selection changes
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      dataIndices: number[]
      
      the selected data indices
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:373
on(type: "aggregate", listener: ((ranking: Ranking, group: IGroup | IGroup[], previousTopN: number | number[], currentTopN: number | number[]) => void)): DataProvider
Parameters
- type: "aggregate"
- listener: ((ranking: Ranking, group: IGroup | IGroup[], previousTopN: number | number[], currentTopN: number | number[]) => void)
  - - (ranking: Ranking, group: IGroup | IGroup[], previousTopN: number | number[], currentTopN: number | number[]): void
    - As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      ranking: Ranking
      
      group: IGroup | IGroup[]
      
      previousTopN: number | number[]
      
      currentTopN: number | number[]
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:374
on(type: "selectionChanged", listener: ((dataIndices: number[]) => void)): DataProvider
Parameters
- type: "selectionChanged"
- listener: ((dataIndices: number[]) => void)
  - - (dataIndices: number[]): void
    - emitted when the selection changes
      
      As Member Of
      ADataProvider
      
      Group
      Events
      
      Parameters
      
      dataIndices: number[]
      
      the selected data indices
      
      Returns void
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:375
on(type: string | string[], listener: IEventListener): DataProvider
Parameters
- type: string | string[]
- listener: IEventListener
Returns DataProvider
Implementation of IDataProvider.on

Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:376

`Protected` patchColumn

patchColumn(column: Column): Column
Parameters
- column: Column
Returns Column
- Defined in provider/ADataProvider.ts:675

push

push(ranking: Ranking, desc: IColumnDesc): Column
adds a column to a ranking described by its column description

Returns
the newly created column or null
Parameters
- ranking: Ranking
  
  the ranking to add the column to
- desc: IColumnDesc
  
  the description of the column
Returns Column
- Defined in provider/ADataProvider.ts:597

pushRanking

pushRanking(existing?: Ranking): Ranking
adds a new ranking

Returns
the new ranking
Parameters
- Optional existing: Ranking
  
  an optional existing ranking to clone
Returns Ranking
- Defined in provider/ADataProvider.ts:396

removeRanking

removeRanking(ranking: Ranking): boolean
removes a ranking from this data provider

Returns
Parameters
- ranking: Ranking
Returns boolean
Implementation of IDataProvider.removeRanking
- Defined in provider/ADataProvider.ts:492

restore

restore(dump: IDataProviderDump): void
Parameters
- dump: IDataProviderDump
Returns void
- Defined in provider/ADataProvider.ts:767

restoreColumn

restoreColumn(dump: any): Column
restores a column from a dump

Returns
Parameters
- dump: any
Returns Column
- Defined in provider/ADataProvider.ts:699

restoreRanking

restoreRanking(dump: IRankingDump): Ranking
Parameters
- dump: IRankingDump
Returns Ranking
- Defined in provider/ADataProvider.ts:759

`Abstract` searchAndJump

searchAndJump(search: string | RegExp, col: Column): void
hook for selecting elements matching the given arguments
Parameters
- search: string | RegExp
- col: Column
Returns void
Implementation of IDataProvider.searchAndJump
- Defined in provider/ADataProvider.ts:1039

select

select(index: number): void
also select the given row
Parameters
- index: number
Returns void
- Defined in provider/ADataProvider.ts:1023

selectAll

selectAll(indices: IndicesArray): void
also select all the given rows
Parameters
- indices: IndicesArray
Returns void
- Defined in provider/ADataProvider.ts:1052

selectAllOf

selectAllOf(ranking: Ranking): void
Parameters
- ranking: Ranking
Returns void
Implementation of IDataProvider.selectAllOf
- Defined in provider/ADataProvider.ts:1069

selectedRows

selectedRows(): any[] | Promise<any[]>
returns a promise containing the selected rows

Returns

Returns any[] | Promise<any[]>
- Defined in provider/ADataProvider.ts:1141

setAggregated

setAggregated(ranking: Ranking, group: IGroup | IGroup[], value: boolean): void
Parameters
- ranking: Ranking
- group: IGroup | IGroup[]
- value: boolean
Returns void
- Defined in provider/ADataProvider.ts:841

setAggregationState

setAggregationState(ranking: Ranking, group: IGroup | IGroup[], value: EAggregationState): void
Parameters
- ranking: Ranking
- group: IGroup | IGroup[]
- value: EAggregationState
Returns void
Implementation of IDataProvider.setAggregationState
- Defined in provider/ADataProvider.ts:845

setSelection

setSelection(indices: number[]): void
set the selection to the given rows
Parameters
- indices: number[]
Returns void
Implementation of IDataProvider.setSelection
- Defined in provider/ADataProvider.ts:1077

setShowTopN

setShowTopN(value: number): void
Parameters
- value: number
Returns void
Implementation of IDataProvider.setShowTopN
- Defined in provider/ADataProvider.ts:965

setTopNAggregated

setTopNAggregated(ranking: Ranking, group: IGroup | IGroup[], value: number | number[]): void
Parameters
- ranking: Ranking
- group: IGroup | IGroup[]
- value: number | number[]
Returns void
Implementation of IDataProvider.setTopNAggregated
- Defined in provider/ADataProvider.ts:908

`Abstract` sort

sort(ranking: Ranking, dirtyReason: EDirtyReason[]): Promise<{ groups: IOrderedGroup[]; index2pos: IndicesArray }> | { groups: IOrderedGroup[]; index2pos: IndicesArray }
sorts the given ranking and eventually return a ordering of the data items

Returns
Parameters
- ranking: Ranking
- dirtyReason: EDirtyReason[]
Returns Promise<{ groups: IOrderedGroup[]; index2pos: IndicesArray }> | { groups: IOrderedGroup[]; index2pos: IndicesArray }
- Defined in provider/ADataProvider.ts:987

takeSnapshot

takeSnapshot(col: Column): Ranking
Parameters
- col: Column
Returns Ranking
Implementation of IDataProvider.takeSnapshot
- Defined in provider/ADataProvider.ts:407

toDescRef

toDescRef(desc: any): any
for better dumping describe reference, by default just return the description
Parameters
- desc: any
Returns any
Implementation of IDataProvider.toDescRef
- Defined in provider/ADataProvider.ts:748

toggleSelection

toggleSelection(index: number, additional?: boolean): boolean
toggles the selection of the given data index

Returns
whether the index is currently selected
Parameters
- index: number
- additional: boolean = false
  
  just this element or all
Returns boolean
Implementation of IDataProvider.toggleSelection
- Defined in provider/ADataProvider.ts:1094

`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
Implementation of IDataProvider.unforward

Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146

`Abstract` view

view(indices: ArrayLike<number>): any[] | Promise<any[]>
returns a view in the order of the given indices

Returns
Parameters
- indices: ArrayLike<number>
Returns any[] | Promise<any[]>
- Defined in provider/ADataProvider.ts:999

Class DataProviderAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Partial<IDataProviderOptions> = {}

Returns DataProvider

Properties

Readonly colorMappingFunctionTypes

Type declaration

[colorMappingFunctionType: string]: IColorMappingFunctionConstructor

Readonly columnTypes

Type declaration

[columnType: string]: IColumnConstructor

Readonly mappingFunctionTypes

Type declaration

[mappingFunctionType: string]: IMappingFunctionConstructor

Static Readonly EVENT_ADD_COLUMN

Static Readonly EVENT_ADD_DESC

Static Readonly EVENT_ADD_RANKING

Static Readonly EVENT_BUSY

Static Readonly EVENT_CLEAR_DESC

Static Readonly EVENT_DATA_CHANGED

Static Readonly EVENT_DIRTY

Static Readonly EVENT_DIRTY_CACHES

Static Readonly EVENT_DIRTY_HEADER

Static Readonly EVENT_DIRTY_VALUES

Static Readonly EVENT_GROUP_AGGREGATION_CHANGED

Static Readonly EVENT_JUMP_TO_NEAREST

Static Readonly EVENT_MOVE_COLUMN

Static Readonly EVENT_ORDER_CHANGED

Static Readonly EVENT_REMOVE_COLUMN

Static Readonly EVENT_REMOVE_DESC

Static Readonly EVENT_REMOVE_RANKING

Static Readonly EVENT_SELECTION_CHANGED

Static Readonly EVENT_SHOWTOPN_CHANGED

Methods

aggregateAllOf

Parameters

ranking: Ranking

aggregateAll: number | boolean | EAggregationState

groups: IOrderedGroup[] = ...

Returns void

Protected cleanDesc

Parameters

desc: IColumnDesc

Returns IColumnDesc

cleanUpRanking

Parameters

_ranking: Ranking

Returns void

clearFilters

Returns void

clearRankings

Returns void

clearSelection

Returns void

clone

Returns

Parameters

col: Column

Returns Column

Abstract cloneRanking

Returns

Parameters

Optional existing: Ranking

Returns Ranking

create

Returns

Parameters

desc: IColumnDesc

Returns Column

Protected createEventList

Returns

Returns string[]

Class DataProvider`Abstract`

`Readonly` colorMappingFunctionTypes

`Readonly` columnTypes

`Readonly` mappingFunctionTypes

`Static` `Readonly` EVENT_ADD_COLUMN

`Static` `Readonly` EVENT_ADD_DESC

`Static` `Readonly` EVENT_ADD_RANKING

`Static` `Readonly` EVENT_BUSY

`Static` `Readonly` EVENT_CLEAR_DESC

`Static` `Readonly` EVENT_DATA_CHANGED

`Static` `Readonly` EVENT_DIRTY

`Static` `Readonly` EVENT_DIRTY_CACHES

`Static` `Readonly` EVENT_DIRTY_HEADER

`Static` `Readonly` EVENT_DIRTY_VALUES

`Static` `Readonly` EVENT_GROUP_AGGREGATION_CHANGED

`Static` `Readonly` EVENT_JUMP_TO_NEAREST

`Static` `Readonly` EVENT_MOVE_COLUMN

`Static` `Readonly` EVENT_ORDER_CHANGED

`Static` `Readonly` EVENT_REMOVE_COLUMN

`Static` `Readonly` EVENT_REMOVE_DESC

`Static` `Readonly` EVENT_REMOVE_RANKING

`Static` `Readonly` EVENT_SELECTION_CHANGED

`Static` `Readonly` EVENT_SHOWTOPN_CHANGED

`Protected` cleanDesc

`Abstract` cloneRanking

`Optional` existing: Ranking

`Protected` createEventList

`Abstract` findDesc

`Protected` fire

`Rest` ...args: any[]

`Protected` fireBusy

`Protected` forward

`Rest` ...types: string[]

`Abstract` getColumns