Options
All
  • Public
  • Public/Protected
  • All
Menu

a remote implementation of the data provider

Hierarchy

  • ACommonDataProvider
    • RemoteDataProvider

Index

Constructors

Properties

colorMappingFunctionTypes: {}

Type declaration

columnTypes: {}

lookup map of a column type to its column implementation

Type declaration

mappingFunctionTypes: {}

Type declaration

EVENT_ADD_COLUMN: "addColumn" = Ranking.EVENT_ADD_COLUMN
EVENT_ADD_DESC: "addDesc" = 'addDesc'
EVENT_ADD_RANKING: "addRanking" = 'addRanking'
EVENT_BUSY: "busy" = 'busy'
EVENT_CLEAR_DESC: "clearDesc" = 'clearDesc'
EVENT_DATA_CHANGED: "dataChanged" = 'dataChanged'
EVENT_DIRTY: "dirty" = Ranking.EVENT_DIRTY
EVENT_DIRTY_CACHES: "dirtyCaches" = Ranking.EVENT_DIRTY_CACHES
EVENT_DIRTY_HEADER: "dirtyHeader" = Ranking.EVENT_DIRTY_HEADER
EVENT_DIRTY_VALUES: "dirtyValues" = Ranking.EVENT_DIRTY_VALUES
EVENT_GROUP_AGGREGATION_CHANGED: "aggregate" = AggregateGroupColumn.EVENT_AGGREGATE
EVENT_JUMP_TO_NEAREST: "jumpToNearest" = 'jumpToNearest'
EVENT_MOVE_COLUMN: "moveColumn" = Ranking.EVENT_MOVE_COLUMN
EVENT_ORDER_CHANGED: "orderChanged" = Ranking.EVENT_ORDER_CHANGED
EVENT_REMOVE_COLUMN: "removeColumn" = Ranking.EVENT_REMOVE_COLUMN
EVENT_REMOVE_DESC: "removeDesc" = 'removeDesc'
EVENT_REMOVE_RANKING: "removeRanking" = 'removeRanking'
EVENT_SELECTION_CHANGED: "selectionChanged" = 'selectionChanged'
EVENT_SHOWTOPN_CHANGED: "showTopNChanged" = 'showTopNChanged'

Methods

  • cleanUpRanking(_ranking: Ranking): void
  • clearColumns(): void
  • clearFilters(): void
  • clearRankings(): void
  • clearSelection(): void
  • createEventList(): string[]
  • events:

    • column changes: addColumn, removeColumn
    • ranking changes: addRanking, removeRanking
    • dirty: dirty, dirtyHeder, dirtyValues
    • selectionChanged

    Returns string[]

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

    Parameters

    • addSupportType: boolean = true

    Returns Ranking

  • deselect(index: number): void
  • destroy(): void
  • ensureOneRanking(): void
  • utility to export the selection within the given ranking to a table with the given separator

    Parameters

    Returns string | Promise<string>

  • fetch(orders: number[][]): Promise<IDataRow>[][]
  • 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

  • fire(type: string | string[], ...args: any[]): void
  • fireBusy(busy: boolean): void
  • 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

  • fromDescRef(descRef: any): any
  • getAggregationState(ranking: Ranking, group: IGroup): EAggregationState
  • getRow(index: number): Promise<IDataRow>
  • getSelection(): number[]
  • getShowTopN(): number
  • getTotalNumberOfRows(): number
  • 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

  • insertRanking(r: Ranking, index?: number): void
  • isSelected(index: number): boolean
  • jumpToNearest(indices: number[]): void
  • 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

  • mappingSample(col: Column): Promise<number[]>
  • nextRankingId(): string
  • 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

  • removeDesc(column: IColumnDesc, ignoreBeingUsed?: boolean): 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

  • removeRanking(ranking: Ranking): boolean
  • restoreColumn(dump: any): Column
  • searchAndJump(search: string | RegExp, col: Column): void
  • select(index: number): void
  • selectAllOf(ranking: Ranking): void
  • selectedRows(): any[] | Promise<any[]>
  • returns a promise containing the selected rows

    Returns any[] | Promise<any[]>

  • setSelection(indices: number[]): void
  • setShowTopN(value: number): void
  • toDescRef(desc: any): any
  • 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

  • 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

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