Class RemoteDataProvider

a remote implementation of the data provider

Hierarchy

ACommonDataProvider
- RemoteDataProvider

Index

Constructors

Methods

aggregateAllOf cleanDesc cleanUpRanking clearColumns clearFilters clearRankings clearSelection clone cloneRanking create createEventList deriveDefault deselect deselectAll destroy dump dumpColumn ensureOneRanking exportSelection exportTable fetch 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 nextRankingId on patchColumn push pushDesc pushRanking removeDesc removeRanking restore restoreColumn restoreRanking searchAndJump select selectAll selectAllOf selectedRows setAggregated setAggregationState setSelection setShowTopN setTopNAggregated sort takeSnapshot toDescRef toggleSelection unforward view

Constructors

constructor

new RemoteDataProvider(server, columns?, options?): RemoteDataProvider
Parameters
- server: IServerData
- columns: IColumnDesc[] = []
- options: Partial<IRemoteDataProviderOptions & IDataProviderOptions> = {}
Returns RemoteDataProvider
Overrides ACommonDataProvider.constructor
- Defined in provider/RemoteDataProvider.ts:69

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, aggregateAll, groups?): void
Parameters
- ranking: Ranking
- aggregateAll: number | boolean | EAggregationState
- groups: IOrderedGroup[] = ...
Returns void
Inherited from ACommonDataProvider.aggregateAllOf
- Defined in provider/ADataProvider.ts:962

`Protected` cleanDesc

cleanDesc(desc): IColumnDesc
Parameters
- desc: IColumnDesc
Returns IColumnDesc
Inherited from ACommonDataProvider.cleanDesc
- Defined in provider/ADataProvider.ts:653

cleanUpRanking

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

clearColumns

clearColumns(): void
Returns void
Inherited from ACommonDataProvider.clearColumns
- Defined in provider/ACommonDataProvider.ts:52

clearFilters

clearFilters(): void
Returns void
Inherited from ACommonDataProvider.clearFilters
- Defined in provider/ADataProvider.ts:543

clearRankings

clearRankings(): void
removes all rankings

Returns void
Inherited from ACommonDataProvider.clearRankings
- Defined in provider/ADataProvider.ts:523

clearSelection

clearSelection(): void
clears the selection

Returns void
Inherited from ACommonDataProvider.clearSelection
- Defined in provider/ADataProvider.ts:1165

clone

clone(col): Column
clones a column by dumping and restoring
Parameters
- col: Column
Returns Column
Inherited from ACommonDataProvider.clone
- Defined in provider/ADataProvider.ts:695

cloneRanking

cloneRanking(existing?): Ranking
Parameters
- Optional existing: Ranking
Returns Ranking
Inherited from ACommonDataProvider.cloneRanking
- Defined in provider/ACommonDataProvider.ts:27

create

create(desc): 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
Inherited from ACommonDataProvider.create
- Defined in provider/ADataProvider.ts:671

`Protected` createEventList

createEventList(): string[]
events:
- column changes: addColumn, removeColumn
- ranking changes: addRanking, removeRanking
- dirty: dirty, dirtyHeder, dirtyValues
- selectionChanged
Returns string[]
Inherited from ACommonDataProvider.createEventList
- Defined in provider/ADataProvider.ts:338

deriveDefault

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

deselect

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

deselectAll

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

destroy

destroy(): void
Returns void
Inherited from ACommonDataProvider.destroy
- Defined in provider/ADataProvider.ts:578

dump

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

Returns IDataProviderDump
Inherited from ACommonDataProvider.dump
- Defined in provider/ADataProvider.ts:733

dumpColumn

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

ensureOneRanking

ensureOneRanking(): void
Returns void
Inherited from ACommonDataProvider.ensureOneRanking
- Defined in provider/ADataProvider.ts:571

exportSelection

exportSelection(options?): 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>
Inherited from ACommonDataProvider.exportSelection
- Defined in provider/ADataProvider.ts:1192

exportTable

exportTable(ranking, options?): 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>
Inherited from ACommonDataProvider.exportTable
- Defined in provider/ADataProvider.ts:1179

fetch

fetch(orders): Promise<IDataRow>[][]
Parameters
- orders: number[][]
Returns Promise<IDataRow>[][]
- Defined in provider/RemoteDataProvider.ts:147

find

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

findDesc

findDesc(ref): IColumnDesc
Parameters
- ref: string
Returns IColumnDesc
Inherited from ACommonDataProvider.findDesc
- Defined in provider/ACommonDataProvider.ts:86

`Protected` fire

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

`Protected` fireBusy

fireBusy(busy): void
Parameters
- busy: boolean
Returns void
Inherited from ACommonDataProvider.fireBusy
- Defined in provider/ADataProvider.ts:409

`Protected` forward

forward(from, ...types): 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 ACommonDataProvider.forward
- Defined in internal/AEventDispatcher.ts:137

fromDescRef

fromDescRef(descRef): any
Parameters
- descRef: any
Returns any
Inherited from ACommonDataProvider.fromDescRef
- Defined in provider/ACommonDataProvider.ts:99

getAggregationState

getAggregationState(ranking, group): EAggregationState
Parameters
- ranking: Ranking
- group: IGroup
Returns EAggregationState
Inherited from ACommonDataProvider.getAggregationState
- Defined in provider/ADataProvider.ts:842

getAggregationStrategy

getAggregationStrategy(): IAggregationStrategy
Returns IAggregationStrategy
Inherited from ACommonDataProvider.getAggregationStrategy
- Defined in provider/ADataProvider.ts:886

getColumns

getColumns(): IColumnDesc[]
Returns IColumnDesc[]
Inherited from ACommonDataProvider.getColumns
- Defined in provider/ACommonDataProvider.ts:82

getFirstRanking

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

Returns Ranking
Inherited from ACommonDataProvider.getFirstRanking
- Defined in provider/ADataProvider.ts:559

getLastRanking

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

Returns Ranking
Inherited from ACommonDataProvider.getLastRanking
- Defined in provider/ADataProvider.ts:567

getRankings

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

Returns Ranking[]
Inherited from ACommonDataProvider.getRankings
- Defined in provider/ADataProvider.ts:551

getRow

getRow(index): Promise<IDataRow>
Parameters
- index: number
Returns Promise<IDataRow>
Overrides ACommonDataProvider.getRow
- Defined in provider/RemoteDataProvider.ts:154

getSelection

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

Returns number[]
Inherited from ACommonDataProvider.getSelection
- Defined in provider/ADataProvider.ts:1158

getShowTopN

getShowTopN(): number
Returns number
Inherited from ACommonDataProvider.getShowTopN
- Defined in provider/ADataProvider.ts:967

getTaskExecutor

getTaskExecutor(): IRenderTasks
Returns IRenderTasks
Overrides ACommonDataProvider.getTaskExecutor
- Defined in provider/RemoteDataProvider.ts:83

getTopNAggregated

getTopNAggregated(ranking, group): number
Parameters
- ranking: Ranking
- group: IGroup
Returns number
Inherited from ACommonDataProvider.getTopNAggregated
- Defined in provider/ADataProvider.ts:859

getTotalNumberOfRows

getTotalNumberOfRows(): number
Returns number
Overrides ACommonDataProvider.getTotalNumberOfRows
- Defined in provider/RemoteDataProvider.ts:78

getTypeFactory

getTypeFactory(): ITypeFactory
Returns ITypeFactory
Inherited from ACommonDataProvider.getTypeFactory
- Defined in provider/ADataProvider.ts:326

insert

insert(ranking, index, desc): 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
Inherited from ACommonDataProvider.insert
- Defined in provider/ADataProvider.ts:619

insertRanking

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

`Protected` instantiateColumn

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

isAggregated

isAggregated(ranking, group): boolean
Parameters
- ranking: Ranking
- group: IGroup
Returns boolean
Inherited from ACommonDataProvider.isAggregated
- Defined in provider/ADataProvider.ts:838

isSelected

isSelected(index): boolean
is the given row selected
Parameters
- index: number
Returns boolean
Inherited from ACommonDataProvider.isSelected
- Defined in provider/ADataProvider.ts:1021

jumpToNearest

jumpToNearest(indices): void
Parameters
- indices: number[]
Returns void
Inherited from ACommonDataProvider.jumpToNearest
- Defined in provider/ADataProvider.ts:1047

`Protected` listenersChanged

listenersChanged(_type, _active): 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 ACommonDataProvider.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

mappingSample

mappingSample(col): Promise<number[]>
Parameters
- col: Column
Returns Promise<number[]>
Overrides ACommonDataProvider.mappingSample
- Defined in provider/RemoteDataProvider.ts:162

nextRankingId

nextRankingId(): string
Returns string
Inherited from ACommonDataProvider.nextRankingId
- Defined in provider/ACommonDataProvider.ts:117

on

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

`Protected` patchColumn

patchColumn(column): Column
Parameters
- column: Column
Returns Column
Inherited from ACommonDataProvider.patchColumn
- Defined in provider/ADataProvider.ts:681

push

push(ranking, desc): 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
Inherited from ACommonDataProvider.push
- Defined in provider/ADataProvider.ts:603

pushDesc

pushDesc(column): void
adds another column description to this data provider
Parameters
- column: IColumnDesc
Returns void
Inherited from ACommonDataProvider.pushDesc
- Defined in provider/ACommonDataProvider.ts:46

pushRanking

pushRanking(existing?): Ranking
adds a new ranking
Parameters
- Optional existing: Ranking
  an optional existing ranking to clone
Returns Ranking
the new ranking
Inherited from ACommonDataProvider.pushRanking
- Defined in provider/ADataProvider.ts:402

removeDesc

removeDesc(column, ignoreBeingUsed?): boolean
Remove the given column description from the data provider. Column descriptions that are in use (i.e., has column instances in a ranking) cannot be removed by default. Skip the check by setting the ignoreBeingUsed parameter to true.
Parameters
- column: IColumnDesc
  Column description
- ignoreBeingUsed: boolean = false
  Flag whether to ignore the usage of the column descriptions in rankings
Returns boolean
Inherited from ACommonDataProvider.removeDesc
- Defined in provider/ACommonDataProvider.ts:66

removeRanking

removeRanking(ranking): boolean
removes a ranking from this data provider
Parameters
- ranking: Ranking
Returns boolean
Inherited from ACommonDataProvider.removeRanking
- Defined in provider/ADataProvider.ts:498

restore

restore(dump): void
Parameters
- dump: IDataProviderDump
Returns void
Inherited from ACommonDataProvider.restore
- Defined in provider/ACommonDataProvider.ts:112

restoreColumn

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

restoreRanking

restoreRanking(dump): Ranking
Parameters
- dump: IRankingDump
Returns Ranking
Inherited from ACommonDataProvider.restoreRanking
- Defined in provider/ADataProvider.ts:765

searchAndJump

searchAndJump(search, col, first?): void
Parameters
- search: string | RegExp
- col: Column
- Optional first: boolean
Returns void
Overrides ACommonDataProvider.searchAndJump
- Defined in provider/RemoteDataProvider.ts:166

select

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

selectAll

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

selectAllOf

selectAllOf(ranking): void
Parameters
- ranking: Ranking
Returns void
Inherited from ACommonDataProvider.selectAllOf
- Defined in provider/ADataProvider.ts:1075

selectedRows

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

Returns any[] | Promise<any[]>
Inherited from ACommonDataProvider.selectedRows
- Defined in provider/ADataProvider.ts:1147

setAggregated

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

setAggregationState

setAggregationState(ranking, group, value): void
Parameters
- ranking: Ranking
- group: IGroup | IGroup[]
- value: EAggregationState
Returns void
Inherited from ACommonDataProvider.setAggregationState
- Defined in provider/ADataProvider.ts:851

setSelection

setSelection(indices): void
set the selection to the given rows
Parameters
- indices: number[]
Returns void
Inherited from ACommonDataProvider.setSelection
- Defined in provider/ADataProvider.ts:1083

setShowTopN

setShowTopN(value): void
Parameters
- value: number
Returns void
Inherited from ACommonDataProvider.setShowTopN
- Defined in provider/ADataProvider.ts:971

setTopNAggregated

setTopNAggregated(ranking, group, value): void
Parameters
- ranking: Ranking
- group: IGroup | IGroup[]
- value: number | number[]
Returns void
Inherited from ACommonDataProvider.setTopNAggregated
- Defined in provider/ADataProvider.ts:914

sort

sort(ranking): Promise<{
    groups: IOrderedGroup[];
    index2pos: IndicesArray;
}> | {
    groups: IOrderedGroup[];
    index2pos: IndicesArray;
}
Parameters
- ranking: Ranking
Returns Promise<{
    groups: IOrderedGroup[];
    index2pos: IndicesArray;
}> | {
    groups: IOrderedGroup[];
    index2pos: IndicesArray;
}
Overrides ACommonDataProvider.sort
- Defined in provider/RemoteDataProvider.ts:88

takeSnapshot

takeSnapshot(col): Ranking
Parameters
- col: Column
Returns Ranking
Inherited from ACommonDataProvider.takeSnapshot
- Defined in provider/ADataProvider.ts:413

toDescRef

toDescRef(desc): any
identify by the tuple type@columnname
Parameters
- desc: any
Returns any
Inherited from ACommonDataProvider.toDescRef
- Defined in provider/ACommonDataProvider.ts:95

toggleSelection

toggleSelection(index, additional?): 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
Inherited from ACommonDataProvider.toggleSelection
- Defined in provider/ADataProvider.ts:1100

`Protected` unforward

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

view

view(indices): Promise<any[]>
Parameters
- indices: number[]
Returns Promise<any[]>
Overrides ACommonDataProvider.view
- Defined in provider/RemoteDataProvider.ts:109

Class RemoteDataProvider

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RemoteDataProvider

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

Returns void

Protected cleanDesc

Parameters

Returns IColumnDesc

cleanUpRanking

Parameters

Returns void

clearColumns

Returns void

clearFilters

Returns void

clearRankings

Returns void

clearSelection

Returns void

clone

Parameters

Returns Column

cloneRanking

Parameters

Returns Ranking

create

Parameters

Returns Column

Protected createEventList

Returns string[]

deriveDefault

Parameters

Returns Ranking

deselect

Parameters

Returns void

deselectAll

Parameters

Returns void

destroy

Returns void

dump

`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

`Protected` createEventList

`Protected` fire

`Protected` fireBusy

`Protected` forward

`Protected` instantiateColumn