Interface IDataProvider

base class for event dispatching using d3 event mechanism, thus .suffix is supported for multiple registrations

interface IDataProvider {
    columnTypes: {
        [columnType: string]: IColumnConstructor;
    };
    aggregateAllOf(ranking, aggregateAll, groups?): void;
    clearFilters(): void;
    clone(col): Column;
    create(desc): Column;
    createEventList(): string[];
    ensureOneRanking(): void;
    find(id): Column;
    fire(type, ...args): void;
    forward(from, ...types): void;
    fromDescRef(ref): IColumnDesc;
    getAggregationState(ranking, group): EAggregationState;
    getAggregationStrategy(): IAggregationStrategy;
    getColumns(): IColumnDesc[];
    getFirstRanking(): Ranking;
    getLastRanking(): Ranking;
    getRankings(): Ranking[];
    getRow(dataIndex): IDataRow | Promise<IDataRow>;
    getSelection(): number[];
    getShowTopN(): number;
    getTaskExecutor(): IRenderTasks;
    getTopNAggregated(ranking, group): number;
    getTotalNumberOfRows(): number;
    getTypeFactory(): ITypeFactory;
    isAggregated(ranking, group): boolean;
    isSelected(i): boolean;
    jumpToNearest(indices): any;
    listenersChanged(_type, _active): void;
    mappingSample(col): ISequence<number> | Promise<ISequence<number>>;
    on(type, listener): this;
    removeRanking(ranking): void;
    searchAndJump(search, col, first?): void | number[];
    selectAllOf(ranking): void;
    setAggregationState(ranking, group, state): void;
    setSelection(dataIndices): void;
    setShowTopN(value): void;
    setTopNAggregated(ranking, group, value): void;
    takeSnapshot(col): void;
    toDescRef(desc): any;
    toggleSelection(i, additional?): boolean;
    unforward(from, ...types): void;
}

Hierarchy (view full)

Implemented by

Properties

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

Type declaration

Methods

  • 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

  • Parameters

    • search: string | RegExp
    • col: Column
    • Optional first: boolean

    Returns void | number[]

  • Parameters

    • i: number
    • Optional additional: boolean

    Returns boolean