Class DataProvider`Abstract`

a basic data provider holding the data and rankings

Hierarchy (View Summary)

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:293

Properties

`Readonly`colorMappingFunctionTypes

colorMappingFunctionTypes: {
[colorMappingFunctionType: string]: IColorMappingFunctionConstructor;
}

`Readonly`columnTypes

columnTypes: { [columnType: string]: IColumnConstructor }

lookup map of a column type to its column implementation

`Readonly`mappingFunctionTypes

mappingFunctionTypes: {
[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:963

`Protected`cleanDesc

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

cleanUpRanking

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

clearFilters

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

clearRankings

clearRankings(): void
removes all rankings

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

clearSelection

clearSelection(): void
clears the selection

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

clone

clone(col: Column): Column
clones a column by dumping and restoring
Parameters
- col: Column
Returns Column
Implementation of IDataProvider.clone
- Defined in provider/ADataProvider.ts:696

`Abstract`cloneRanking

cloneRanking(existing?: Ranking): Ranking
abstract method for cloning a ranking
Parameters
- Optionalexisting: Ranking
Returns Ranking
- Defined in provider/ADataProvider.ts:596

create

create(desc: IColumnDesc): Column
creates an internal column model out of the given column description
Parameters
- desc: IColumnDesc
Returns Column
the new column or null if it can't be created
Implementation of IDataProvider.create
- Defined in provider/ADataProvider.ts:672

`Protected`createEventList

createEventList(): string[]
events:
- column changes: addColumn, removeColumn
- ranking changes: addRanking, removeRanking
- dirty: dirty, dirtyHeder, dirtyValues
- selectionChanged
Returns string[]
Implementation of IDataProvider.createEventList
Overrides AEventDispatcher.createEventList
- Defined in provider/ADataProvider.ts:339

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:820

deselect

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

deselectAll

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

destroy

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

dump

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

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

dumpColumn

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

ensureOneRanking

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

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

exportTable

exportTable(
ranking: Ranking,
options?: Partial<IExportOptions>,
): string | Promise<string>
utility to export a ranking to a table with the given separator
Parameters
- ranking: Ranking
- options: Partial<IExportOptions> = {}
Returns string | Promise<string>
- Defined in provider/ADataProvider.ts:1187

find

find(idOrFilter: string | (col: Column) => boolean): Column
finds a column in all rankings returning the first match
Parameters
- idOrFilter: string | (col: Column) => boolean
  by id or by a filter function
Returns Column
Implementation of IDataProvider.find
- Defined in provider/ADataProvider.ts:717

`Abstract`findDesc

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

`Protected`fire

fire(type: string | string[], ...args: any[]): void
Parameters
- type: string | string[]
- ...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:410

`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
- ...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:762

getAggregationState

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

getAggregationStrategy

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

`Abstract`getColumns

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

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

getFirstRanking

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

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

getLastRanking

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

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

getRankings

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

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

`Abstract`getRow

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

getSelection

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

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

getShowTopN

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

`Abstract`getTaskExecutor

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

getTopNAggregated

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

`Abstract`getTotalNumberOfRows

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

getTypeFactory

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

insert

insert(ranking: Ranking, index: number, desc: IColumnDesc): Column
adds a column to a ranking described by its column description
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
the newly created column or null
- Defined in provider/ADataProvider.ts:620

insertRanking

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

`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:687

isAggregated

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

isSelected

isSelected(index: number): boolean
is the given row selected
Parameters
- index: number
Returns boolean
Implementation of IDataProvider.isSelected
- Defined in provider/ADataProvider.ts:1022

jumpToNearest

jumpToNearest(indices: number[]): void
Parameters
- indices: number[]
Returns void
Implementation of IDataProvider.jumpToNearest
- Defined in provider/ADataProvider.ts:1055

`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
Parameters
- col: Column
Returns ISequence<number> | Promise<ISequence<number>>
Implementation of IDataProvider.mappingSample
- Defined in provider/ADataProvider.ts:1015

on

on(type: "busy", listener: (busy: boolean) => void): this
Parameters
- type: "busy"
- listener: (busy: boolean) => void
  - - (busy: boolean): void
    - Parameters
      busy: boolean
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:364
on(type: "dataChanged", listener: (rows: IDataRow[]) => void): this
Parameters
- type: "dataChanged"
- listener: (rows: IDataRow[]) => void
  - - (rows: IDataRow[]): void
    - emitted when the data changes
      
      Parameters
      rows: IDataRow[]
      the new data rows
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:365
on(
type: "showTopNChanged",
listener: (previous: number, current: number) => void,
): this
Parameters
- type: "showTopNChanged"
- listener: (previous: number, current: number) => void
  - - (previous: number, current: number): void
    - Parameters
      previous: number
      current: number
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:366
on(type: "addColumn", listener: (col: Column, index: number) => void): this
Parameters
- type: "addColumn"
- listener: (col: Column, index: number) => void
  - - (col: Column, index: number): void
    - emitted when a column has been added
      
      Parameters
      col: Column
      index: number
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:367
on(
type: "moveColumn",
listener: (col: Column, index: number, oldIndex: number) => void,
): this
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
      
      Parameters
      col: Column
      index: number
      oldIndex: number
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:368
on(type: "removeColumn", listener: (col: Column, index: number) => void): this
Parameters
- type: "removeColumn"
- listener: (col: Column, index: number) => void
  - - (col: Column, index: number): void
    - emitted when a column has been removed
      
      Parameters
      col: Column
      index: number
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:369
on(
type: "addRanking",
listener: (ranking: Ranking, index: number) => void,
): this
Parameters
- type: "addRanking"
- listener: (ranking: Ranking, index: number) => void
  - - (ranking: Ranking, index: number): void
    - Parameters
      ranking: Ranking
      index: number
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:370
on(
type: "removeRanking",
listener: (ranking: Ranking, index: number) => void,
): this
Parameters
- type: "removeRanking"
- listener: (ranking: Ranking, index: number) => void
  - - (ranking: Ranking, index: number): void
    - Parameters
      ranking: Ranking
      if null all rankings are removed else just the specific one
      
      index: number
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:371
on(type: "dirty", listener: () => void): this
Parameters
- type: "dirty"
- listener: () => void
  - - (): void
    - emitted when state of the column is dirty
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:372
on(type: "dirtyHeader", listener: () => void): this
Parameters
- type: "dirtyHeader"
- listener: () => void
  - - (): void
    - emitted when state of the column related to its header is dirty
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:373
on(type: "dirtyValues", listener: () => void): this
Parameters
- type: "dirtyValues"
- listener: () => void
  - - (): void
    - emitted when state of the column related to its values is dirty
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:374
on(type: "dirtyCaches", listener: () => void): this
Parameters
- type: "dirtyCaches"
- listener: () => void
  - - (): void
    - emitted when state of the column related to cached values (hist, compare, ...) is dirty
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:375
on(
    type: "orderChanged",
    listener: (
        previous: number[],
        current: number[],
        previousGroups: IOrderedGroup[],
        currentGroups: IOrderedGroup[],
        dirtyReason: EDirtyReason[],
    ) => void,
): this
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
    - Parameters
      previous: number[]
      current: number[]
      previousGroups: IOrderedGroup[]
      currentGroups: IOrderedGroup[]
      dirtyReason: EDirtyReason[]
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:376
on(type: "addDesc", listener: (desc: IColumnDesc) => void): this
Parameters
- type: "addDesc"
- listener: (desc: IColumnDesc) => void
  - - (desc: IColumnDesc): void
    - Parameters
      desc: IColumnDesc
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:377
on(type: "removeDesc", listener: (desc: IColumnDesc) => void): this
Parameters
- type: "removeDesc"
- listener: (desc: IColumnDesc) => void
  - - (desc: IColumnDesc): void
    - Parameters
      desc: IColumnDesc
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:378
on(type: "clearDesc", listener: () => void): this
Parameters
- type: "clearDesc"
- listener: () => void
  - - (): void
    - Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:379
on(type: "jumpToNearest", listener: (dataIndices: number[]) => void): this
Parameters
- type: "jumpToNearest"
- listener: (dataIndices: number[]) => void
  - - (dataIndices: number[]): void
    - emitted when the selection changes
      
      Parameters
      dataIndices: number[]
      the selected data indices
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:380
on(
    type: "aggregate",
    listener: (
        ranking: Ranking,
        group: IGroup | IGroup[],
        previousTopN: number | number[],
        currentTopN: number | number[],
    ) => void,
): this
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
    - Parameters
      ranking: Ranking
      group: IGroup | IGroup[]
      previousTopN: number | number[]
      currentTopN: number | number[]
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:381
on(type: "selectionChanged", listener: (dataIndices: number[]) => void): this
Parameters
- type: "selectionChanged"
- listener: (dataIndices: number[]) => void
  - - (dataIndices: number[]): void
    - emitted when the selection changes
      
      Parameters
      dataIndices: number[]
      the selected data indices
      
      Returns void
      As Member Of
      ADataProvider
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:382
on(type: string | string[], listener: IEventListener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of IDataProvider.on
Overrides AEventDispatcher.on
- Defined in provider/ADataProvider.ts:383

`Protected`patchColumn

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

push

push(ranking: Ranking, desc: IColumnDesc): Column
adds a column to a ranking described by its column description
Parameters
- ranking: Ranking
  the ranking to add the column to
- desc: IColumnDesc
  the description of the column
Returns Column
the newly created column or null
- Defined in provider/ADataProvider.ts:604

pushRanking

pushRanking(existing?: Ranking): Ranking
adds a new ranking
Parameters
- Optionalexisting: Ranking
  an optional existing ranking to clone
Returns Ranking
the new ranking
- Defined in provider/ADataProvider.ts:403

removeRanking

removeRanking(ranking: Ranking): boolean
removes a ranking from this data provider
Parameters
- ranking: Ranking
Returns boolean
Implementation of IDataProvider.removeRanking
- Defined in provider/ADataProvider.ts:499

restore

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

restoreColumn

restoreColumn(dump: any): Column
restores a column from a dump
Parameters
- dump: any
Returns Column
- Defined in provider/ADataProvider.ts:706

restoreRanking

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

`Abstract`searchAndJump

searchAndJump(
    search: string | RegExp,
    col: Column,
    first?: boolean,
    filterType?: EStringFilterType,
): void | number[]
hook for selecting elements matching the given arguments
Parameters
- search: string | RegExp
- col: Column
- Optionalfirst: boolean
- OptionalfilterType: EStringFilterType
Returns void | number[]
Implementation of IDataProvider.searchAndJump
- Defined in provider/ADataProvider.ts:1048

select

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

selectAll

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

selectAllOf

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

selectedRows

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

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

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:848

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:852

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:1091

setShowTopN

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

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:915

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

takeSnapshot

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

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:755

toggleSelection

toggleSelection(index: number, additional?: boolean): boolean
toggles the selection of the given data index
Parameters
- index: number
- additional: boolean = false
  just this element or all
Returns boolean
whether the index is currently selected
Implementation of IDataProvider.toggleSelection
- Defined in provider/ADataProvider.ts:1108

`Protected`unforward

unforward(from: IEventHandler, ...types: string[]): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- ...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
Parameters
- indices: ArrayLike<number>
Returns any[] | Promise<any[]>
- Defined in provider/ADataProvider.ts:1006

Class DataProviderAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DataProvider

Properties

ReadonlycolorMappingFunctionTypes

ReadonlycolumnTypes

ReadonlymappingFunctionTypes

Static ReadonlyEVENT_ADD_COLUMN

Static ReadonlyEVENT_ADD_DESC

Static ReadonlyEVENT_ADD_RANKING

Static ReadonlyEVENT_BUSY

Static ReadonlyEVENT_CLEAR_DESC

Static ReadonlyEVENT_DATA_CHANGED

Static ReadonlyEVENT_DIRTY

Static ReadonlyEVENT_DIRTY_CACHES

Static ReadonlyEVENT_DIRTY_HEADER

Static ReadonlyEVENT_DIRTY_VALUES

Static ReadonlyEVENT_GROUP_AGGREGATION_CHANGED

Static ReadonlyEVENT_JUMP_TO_NEAREST

Static ReadonlyEVENT_MOVE_COLUMN

Static ReadonlyEVENT_ORDER_CHANGED

Static ReadonlyEVENT_REMOVE_COLUMN

Static ReadonlyEVENT_REMOVE_DESC

Static ReadonlyEVENT_REMOVE_RANKING

Static ReadonlyEVENT_SELECTION_CHANGED

Static ReadonlyEVENT_SHOWTOPN_CHANGED

Methods

aggregateAllOf

Parameters

Returns void

ProtectedcleanDesc

Parameters

Returns IColumnDesc

cleanUpRanking

Parameters

Returns void

clearFilters

Returns void

clearRankings

Returns void

clearSelection

Returns void

clone

Parameters

Returns Column

AbstractcloneRanking

Parameters

Returns Ranking

create

Parameters

Returns Column

ProtectedcreateEventList

Returns string[]

deriveDefault

Parameters

Returns Ranking

deselect

Parameters

Returns void

deselectAll

Parameters

Returns void

destroy

Returns void

dump

Returns IDataProviderDump

dumpColumn

Parameters

Returns IColumnDump

ensureOneRanking

Returns void

exportSelection

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

`Protected`createEventList

`Abstract`findDesc

`Protected`fire

`Protected`fireBusy

`Protected`forward

`Abstract`getColumns

`Abstract`getRow

`Abstract`getTaskExecutor

`Abstract`getTotalNumberOfRows

`Protected`instantiateColumn