Class DataProviderAbstract

a basic data provider holding the data and rankings

Hierarchy (view full)

Implements

Constructors

Properties

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

Type declaration

columnTypes: {
    [columnType: string]: IColumnConstructor;
}

lookup map of a column type to its column implementation

Type declaration

mappingFunctionTypes: {
    [mappingFunctionType: string]: IMappingFunctionConstructor;
}

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

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

    Parameters

    Returns string | Promise<string>

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

    Parameters

    Returns string | Promise<string>

  • 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

  • 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

  • Parameters

    • type: "busy"
    • listener: ((busy) => void)
        • (busy): void
        • Parameters

          • busy: boolean

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "dataChanged"
    • listener: ((rows) => void)
        • (rows): void
        • emitted when the data changes

          Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "showTopNChanged"
    • listener: ((previous, current) => void)
        • (previous, current): void
        • Parameters

          • previous: number
          • current: number

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "addColumn"
    • listener: ((col, index) => void)
        • (col, index): void
        • emitted when a column has been added

          Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns 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

  • Parameters

    • type: "removeColumn"
    • listener: ((col, index) => void)
        • (col, index): void
        • emitted when a column has been removed

          Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "addRanking"
    • listener: ((ranking, index) => void)
        • (ranking, index): void
        • Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns 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

          As Member Of

          ADataProvider

          Group

          Events

    Returns 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

  • 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

  • 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

  • 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

  • Parameters

    • type: "orderChanged"
    • listener: ((previous, current, previousGroups, currentGroups, dirtyReason) => void)
        • (previous, current, previousGroups, currentGroups, dirtyReason): void
        • Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "addDesc"
    • listener: ((desc) => void)
        • (desc): void
        • Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "removeDesc"
    • listener: ((desc) => void)
        • (desc): void
        • Parameters

          Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns this

  • Parameters

    • type: "clearDesc"
    • listener: (() => void)
        • (): void
        • Returns void

          As Member Of

          ADataProvider

          Group

          Events

    Returns 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

  • 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

          As Member Of

          ADataProvider

          Group

          Events

    Returns 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

  • Parameters

    Returns this

  • returns a promise containing the selected rows

    Returns any[] | Promise<any[]>

  • 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

  • returns a view in the order of the given indices

    Parameters

    • indices: ArrayLike<number>

    Returns any[] | Promise<any[]>