Class LocalDataProvider

a data provider based on an local array

Hierarchy

  • ACommonDataProvider
    • LocalDataProvider

Constructors

constructor

Properties

colorMappingFunctionTypes columnTypes mappingFunctionTypes EVENT_ADD_COLUMN EVENT_ADD_DESC EVENT_ADD_RANKING EVENT_BUSY EVENT_CLEAR_DESC EVENT_DATA_CHANGED EVENT_DIRTY EVENT_DIRTY_CACHES EVENT_DIRTY_HEADER EVENT_DIRTY_VALUES EVENT_GROUP_AGGREGATION_CHANGED EVENT_JUMP_TO_NEAREST EVENT_MOVE_COLUMN EVENT_ORDER_CHANGED EVENT_REMOVE_COLUMN EVENT_REMOVE_DESC EVENT_REMOVE_RANKING EVENT_SELECTION_CHANGED EVENT_SHOWTOPN_CHANGED

Accessors

data

Methods

aggregateAllOf appendData cleanDesc cleanUpRanking clearColumns clearData 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 getFilter 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 search searchAndJump select selectAll selectAllOf selectedRows seq setAggregated setAggregationState setData setFilter setSelection setShowTopN setTopNAggregated sort takeSnapshot toDescRef toggleSelection unforward view viewRaw viewRawRows

Constructors

constructor

Properties

ReadonlycolorMappingFunctionTypes

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

ReadonlycolumnTypes

columnTypes: { [columnType: string]: IColumnConstructor }

lookup map of a column type to its column implementation

ReadonlymappingFunctionTypes

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

Static ReadonlyEVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = Ranking.EVENT_ADD_COLUMN

Static ReadonlyEVENT_ADD_DESC

EVENT_ADD_DESC: "addDesc" = 'addDesc'

Static ReadonlyEVENT_ADD_RANKING

EVENT_ADD_RANKING: "addRanking" = 'addRanking'

Static ReadonlyEVENT_BUSY

EVENT_BUSY: "busy" = 'busy'

Static ReadonlyEVENT_CLEAR_DESC

EVENT_CLEAR_DESC: "clearDesc" = 'clearDesc'

Static ReadonlyEVENT_DATA_CHANGED

EVENT_DATA_CHANGED: "dataChanged" = 'dataChanged'

Static ReadonlyEVENT_DIRTY

EVENT_DIRTY: "dirty" = Ranking.EVENT_DIRTY

Static ReadonlyEVENT_DIRTY_CACHES

EVENT_DIRTY_CACHES: "dirtyCaches" = Ranking.EVENT_DIRTY_CACHES

Static ReadonlyEVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = Ranking.EVENT_DIRTY_HEADER

Static ReadonlyEVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = Ranking.EVENT_DIRTY_VALUES

Static ReadonlyEVENT_GROUP_AGGREGATION_CHANGED

EVENT_GROUP_AGGREGATION_CHANGED: "aggregate" = AggregateGroupColumn.EVENT_AGGREGATE

Static ReadonlyEVENT_JUMP_TO_NEAREST

EVENT_JUMP_TO_NEAREST: "jumpToNearest" = 'jumpToNearest'

Static ReadonlyEVENT_MOVE_COLUMN

EVENT_MOVE_COLUMN: "moveColumn" = Ranking.EVENT_MOVE_COLUMN

Static ReadonlyEVENT_ORDER_CHANGED

EVENT_ORDER_CHANGED: "orderChanged" = Ranking.EVENT_ORDER_CHANGED

Static ReadonlyEVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = Ranking.EVENT_REMOVE_COLUMN

Static ReadonlyEVENT_REMOVE_DESC

EVENT_REMOVE_DESC: "removeDesc" = 'removeDesc'

Static ReadonlyEVENT_REMOVE_RANKING

EVENT_REMOVE_RANKING: "removeRanking" = 'removeRanking'

Static ReadonlyEVENT_SELECTION_CHANGED

EVENT_SELECTION_CHANGED: "selectionChanged" = 'selectionChanged'

Static ReadonlyEVENT_SHOWTOPN_CHANGED

EVENT_SHOWTOPN_CHANGED: "showTopNChanged" = 'showTopNChanged'

Accessors

data

Methods

aggregateAllOf

appendData

ProtectedcleanDesc

cleanUpRanking

clearColumns

clearData

clearFilters

clearRankings

clearSelection

clone

cloneRanking

create

ProtectedcreateEventList

  • createEventList(): string[]

  • events:

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

    Returns string[]

deriveDefault

  • deriveDefault(addSupportType?: boolean): Ranking

  • generates a default ranking by using all column descriptions ones

    Parameters

    • addSupportType: boolean = true

    Returns Ranking

deselect

  • deselect(index: number): void

  • deselect the given row

    Parameters

    • index: number

    Returns void

deselectAll

destroy

dump

dumpColumn

ensureOneRanking

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

    Returns string | Promise<string>

exportTable

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

findDesc

Protectedfire

  • fire(type: string | string[], ...args: any[]): void

  • Parameters

    • type: string | string[]
    • ...args: any[]

    Returns void

ProtectedfireBusy

  • fireBusy(busy: boolean): void

  • Parameters

    • busy: boolean

    Returns void

Protectedforward

  • 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

fromDescRef

  • fromDescRef(descRef: any): any

  • inverse operation of toDescRef

    Parameters

    • descRef: any

    Returns any

getAggregationState

getAggregationStrategy

getColumns

getFilter

getFirstRanking

getLastRanking

getRankings

getRow

getSelection

  • getSelection(): number[]

  • returns the currently selected indices

    Returns number[]

getShowTopN

getTaskExecutor

getTopNAggregated

getTotalNumberOfRows

getTypeFactory

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

insertRanking

ProtectedinstantiateColumn

isAggregated

isSelected

  • isSelected(index: number): boolean

  • is the given row selected

    Parameters

    • index: number

    Returns boolean

jumpToNearest

  • jumpToNearest(indices: number[]): void

  • Parameters

    • indices: number[]

    Returns void

ProtectedlistenersChanged

  • 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

nextRankingId

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

  • on(type: "dataChanged", listener: (rows: IDataRow[]) => void): this

  • Parameters

    • type: "dataChanged"
    • listener: (rows: IDataRow[]) => void
        • (rows: IDataRow[]): void

        • emitted when the data changes

          Parameters

          Returns void

          As Member Of

          ADataProvider

    Returns this

  • 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

  • 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

          Returns void

          As Member Of

          ADataProvider

    Returns this

  • 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

  • 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

          Returns void

          As Member Of

          ADataProvider

    Returns this

  • 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

          Returns void

          As Member Of

          ADataProvider

    Returns this

  • 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

  • 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

  • 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

  • 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

  • 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

  • on(
        type: "orderChanged",
        listener: (
            previous: number[],
            current: number[],
            previousGroups: IOrderedGroup[],
            currentGroups: IOrderedGroup[],
            dirtyReason: EDirtyReason[],
        ) => void,
    ): this

  • Parameters

    Returns this

  • on(type: "addDesc", listener: (desc: IColumnDesc) => void): this

  • Parameters

    Returns this

  • on(type: "removeDesc", listener: (desc: IColumnDesc) => void): this

  • Parameters

    Returns this

  • on(type: "clearDesc", listener: () => void): this

  • Parameters

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

        • Returns void

          As Member Of

          ADataProvider

    Returns this

  • 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

  • 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

  • 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

  • on(type: string | string[], listener: IEventListener): this

  • Parameters

    Returns this

ProtectedpatchColumn

push

pushDesc

pushRanking

removeDesc

  • 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

restore

restoreColumn

restoreRanking

search

searchAndJump

  • searchAndJump(search: string | RegExp, col: Column, first?: boolean): number[]

  • hook for selecting elements matching the given arguments

    Parameters

    • search: string | RegExp
    • col: Column
    • Optionalfirst: boolean

    Returns number[]

select

  • select(index: number): void

  • also select the given row

    Parameters

    • index: number

    Returns void

selectAll

selectAllOf

selectedRows

  • selectedRows(): any[] | Promise<any[]>

  • returns a promise containing the selected rows

    Returns any[] | Promise<any[]>

seq

setAggregated

setAggregationState

setData

setFilter

setSelection

  • setSelection(indices: number[]): void

  • set the selection to the given rows

    Parameters

    • indices: number[]

    Returns void

setShowTopN

  • setShowTopN(value: number): void

  • Parameters

    • value: number

    Returns void

setTopNAggregated

sort

  • sort(
        ranking: Ranking,
        dirtyReason: EDirtyReason[],
    ):
        | {
            groups: (
                {
                    order: | Uint8Array<ArrayBuffer>
                    | Uint16Array<ArrayBuffer>
                    | Uint32Array<ArrayBuffer>;
                } & IGroup
            )[];
            index2pos: | Uint8Array<ArrayBuffer>
            | Uint16Array<ArrayBuffer>
            | Uint32Array<ArrayBuffer>;
        }
        | Promise<
            {
                groups: IOrderedGroup[];
                index2pos: | Uint8Array<ArrayBuffer>
                | Uint16Array<ArrayBuffer>
                | Uint32Array<ArrayBuffer>;
            },
        >
        | { groups: any[]; index2pos: any[] }

  • sorts the given ranking and eventually return a ordering of the data items

    Parameters

    Returns
        | {
            groups: (
                {
                    order: | Uint8Array<ArrayBuffer>
                    | Uint16Array<ArrayBuffer>
                    | Uint32Array<ArrayBuffer>;
                } & IGroup
            )[];
            index2pos: | Uint8Array<ArrayBuffer>
            | Uint16Array<ArrayBuffer>
            | Uint32Array<ArrayBuffer>;
        }
        | Promise<
            {
                groups: IOrderedGroup[];
                index2pos: | Uint8Array<ArrayBuffer>
                | Uint16Array<ArrayBuffer>
                | Uint32Array<ArrayBuffer>;
            },
        >
        | { groups: any[]; index2pos: any[] }

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
    • additional: boolean = false

      just this element or all

    Returns boolean

    whether the index is currently selected

Protectedunforward

view

viewRaw

viewRawRows

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
aggregateAllOfappendDatacleanDesccleanUpRankingclearColumnsclearDataclearFiltersclearRankingsclearSelectionclonecloneRankingcreatecreateEventListderiveDefaultdeselectdeselectAlldestroydumpdumpColumnensureOneRankingexportSelectionexportTablefindfindDescfirefireBusyforwardfromDescRefgetAggregationStategetAggregationStrategygetColumnsgetFiltergetFirstRankinggetLastRankinggetRankingsgetRowgetSelectiongetShowTopNgetTaskExecutorgetTopNAggregatedgetTotalNumberOfRowsgetTypeFactoryinsertinsertRankinginstantiateColumnisAggregatedisSelectedjumpToNearestlistenersChangedmappingSamplenextRankingIdonpatchColumnpushpushDescpushRankingremoveDescremoveRankingrestorerestoreColumnrestoreRankingsearchsearchAndJumpselectselectAllselectAllOfselectedRowsseqsetAggregatedsetAggregationStatesetDatasetFiltersetSelectionsetShowTopNsetTopNAggregatedsorttakeSnapshottoDescReftoggleSelectionunforwardviewviewRawviewRawRows