Interface IEngineRankingContext

context for rendering, wrapped as an object for easy extensibility

interface IEngineRankingContext {
    caches: {
        toolbar: Map<string, IToolbarAction[]>;
        toolbarAddons: Map<string, IToolbarDialogAddon[]>;
    };
    dialogManager: DialogManager;
    document: Document;
    flags: ILineUpFlags;
    idPrefix: string;
    provider: IDataProvider;
    tasks: IRenderTasks;
    asElement(html: string): HTMLElement;
    colWidth(col: Column): number;
    createRenderer(c: Column, imposer?: IImposer): IRenderers;
    getPossibleRenderer(
        col: Column,
    ): { group: IRenderInfo[]; item: IRenderInfo[]; summary: IRenderInfo[] };
    groupRenderer(col: Column, imposer?: IImposer): IGroupCellRenderer;
    renderer(col: Column, imposer?: IImposer): ICellRenderer;
    resolveToolbarActions(col: Column, keys: string[]): IToolbarAction[];
    resolveToolbarDialogAddons(
        col: Column,
        keys: string[],
    ): IToolbarDialogAddon[];
    sanitize(text: string): string;
    summaryRenderer(
        co: Column,
        interactive: boolean,
        imposer?: IImposer,
    ): ISummaryRenderer;
}

Hierarchy (View Summary)

Properties

caches dialogManager document flags idPrefix provider tasks

Methods

asElement colWidth createRenderer getPossibleRenderer groupRenderer renderer resolveToolbarActions resolveToolbarDialogAddons sanitize summaryRenderer

Properties

Readonlycaches

caches: {
    toolbar: Map<string, IToolbarAction[]>;
    toolbarAddons: Map<string, IToolbarDialogAddon[]>;
}

ReadonlydialogManager

dialogManager: DialogManager

Readonlydocument

document: Document

Readonlyflags

flags: ILineUpFlags

ReadonlyidPrefix

idPrefix: string

prefix used for all generated id names

Readonlyprovider

provider: IDataProvider

Readonlytasks

tasks: IRenderTasks

Methods

asElement

colWidth

createRenderer

getPossibleRenderer

groupRenderer

renderer

resolveToolbarActions

resolveToolbarDialogAddons

sanitize

summaryRenderer

Settings

Member Visibility

On This Page

Properties
Methods