Options
All
  • Public
  • Public/Protected
  • All
Menu

a remote implementation of the data provider

Hierarchy

  • ACommonDataProvider
    • RemoteDataProvider

Implements

Index

Constructors

constructor

Properties

columnTypes

columnTypes: object

lookup map of a column type to its column implementation

Type declaration

  • [columnType: string]: Column

Static EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = Ranking.EVENT_ADD_COLUMN

Static EVENT_ADD_DESC

EVENT_ADD_DESC: "addDesc" = "addDesc"

Static EVENT_ADD_RANKING

EVENT_ADD_RANKING: "addRanking" = "addRanking"

Static EVENT_CLEAR_DESC

EVENT_CLEAR_DESC: "clearDesc" = "clearDesc"

Static EVENT_DIRTY

EVENT_DIRTY: "dirty" = Ranking.EVENT_DIRTY

Static EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = Ranking.EVENT_DIRTY_HEADER

Static EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = Ranking.EVENT_DIRTY_VALUES

Static EVENT_GROUP_AGGREGATION_CHANGED

EVENT_GROUP_AGGREGATION_CHANGED: "aggregate" = AggregateGroupColumn.EVENT_AGGREGATE

Static EVENT_JUMP_TO_NEAREST

EVENT_JUMP_TO_NEAREST: "jumpToNearest" = "jumpToNearest"

Static EVENT_ORDER_CHANGED

EVENT_ORDER_CHANGED: "orderChanged" = Ranking.EVENT_ORDER_CHANGED

Static EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = Ranking.EVENT_REMOVE_COLUMN

Static EVENT_REMOVE_RANKING

EVENT_REMOVE_RANKING: "removeRanking" = "removeRanking"

Static EVENT_SELECTION_CHANGED

EVENT_SELECTION_CHANGED: "selectionChanged" = "selectionChanged"

Methods

aggregateAllOf

  • aggregateAllOf(ranking: Ranking, aggregateAll: boolean): void

cleanUpRanking

  • cleanUpRanking(ranking: Ranking): void

clearColumns

  • clearColumns(): void

clearRankings

  • clearRankings(): void

clearSelection

  • clearSelection(): void

clone

cloneRanking

create

deriveDefault

  • deriveDefault(addSupportType?: boolean): Ranking
  • generates a default ranking by using all column descriptions ones

    Parameters

    • Default value addSupportType: boolean = true

    Returns Ranking

deselect

  • deselect(index: number): void

deselectAll

  • deselectAll(indices: number[]): void
  • also select all the given rows

    Parameters

    • indices: number[]

    Returns void

dump

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

    Returns any

dumpColumn

  • dumpColumn(col: Column): any

ensureOneRanking

  • ensureOneRanking(): void

exportTable

  • utility to export a ranking to a table with the given separator

    Parameters

    Returns Promise<string>

fetch

  • fetch(orders: number[][]): Promise<IDataRow>[][]

find

  • find(idOrFilter: string | function): Column | null
  • finds a column in all rankings returning the first match

    Parameters

    • idOrFilter: string | function

      by id or by a filter function

    Returns Column | null

findDesc

fromDescRef

  • fromDescRef(descRef: any): any

getColumns

getFirstRanking

getLastRanking

getRankings

getSelection

  • getSelection(): number[]

getTotalNumberOfRows

  • getTotalNumberOfRows(): number

insert

  • 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 null | Column

    the newly created column or null

insertRanking

  • insertRanking(r: Ranking, index?: number): void

isAggregated

isSelected

  • isSelected(index: number): boolean

jumpToNearest

  • jumpToNearest(indices: number[]): void

mappingSample

  • mappingSample(col: Column): Promise<number[]>

nextRankingId

  • nextRankingId(): string

on

  • on(type: "addColumn", listener: addColumn | null): this
  • on(type: "removeColumn", listener: removeColumn | null): this
  • on(type: "addRanking", listener: addRanking | null): this
  • on(type: "removeRanking", listener: removeRanking | null): this
  • on(type: "dirty", listener: dirty | null): this
  • on(type: "dirtyHeader", listener: dirtyHeader | null): this
  • on(type: "dirtyValues", listener: dirtyValues | null): this
  • on(type: "orderChanged", listener: orderChanged | null): this
  • on(type: "addDesc", listener: addDesc | null): this
  • on(type: "clearDesc", listener: clearDesc | null): this
  • on(type: "jumpToNearest", listener: jumpToNearest | null): this
  • on(type: "aggregate", listener: aggregate | null): this
  • on(type: "selectionChanged", listener: selectionChanged | null): this
  • on(type: string | string[], listener: IEventListener | null): this

push

  • 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 | null

    the newly created column or null

pushDesc

pushRanking

removeRanking

  • removeRanking(ranking: Ranking): boolean

restore

  • restore(dump: any): void

restoreColumn

  • restoreColumn(dump: any): Column

restoreRanking

  • restoreRanking(dump: any): Ranking

searchAndJump

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

select

  • select(index: number): void

selectAll

  • selectAll(indices: number[]): void
  • also select all the given rows

    Parameters

    • indices: number[]

    Returns void

selectAllOf

  • selectAllOf(ranking: Ranking): void

selectedRows

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

    Returns Promise<any[]> | any[]

setAggregated

  • setAggregated(ranking: Ranking, group: IGroup, value: boolean): void

setSelection

  • setSelection(indices: number[]): void

sort

sortImpl

stats

takeSnapshot

toDescRef

  • toDescRef(desc: any): any
  • identify by the tuple type@columnname

    Parameters

    • desc: any

    Returns any

toggleSelection

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

    Parameters

    • index: number
    • Default value additional: boolean = false

      just this element or all

    Returns boolean

    whether the index is currently selected

view

  • view(indices: number[]): Promise<any[]>