Interface IRankingBodyContext

context for rendering, wrapped as an object for easy extensibility

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

Hierarchy (view full)

Properties

caches dialogManager document flags idPrefix provider tasks

Methods

asElement colWidth getGroup getPossibleRenderer getRow groupRenderer isGroup renderer resolveToolbarActions resolveToolbarDialogAddons sanitize summaryRenderer

Properties

Readonly caches

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

Type declaration

Readonly dialogManager

dialogManager: DialogManager

Readonly document

document: Document

Readonly flags

flags: ILineUpFlags

Readonly idPrefix

idPrefix: string

prefix used for all generated id names

Readonly provider

provider: IDataProvider

Readonly tasks

tasks: IRenderTasks

Methods

asElement

colWidth

getGroup

getPossibleRenderer

getRow

groupRenderer

isGroup

renderer

resolveToolbarActions

resolveToolbarDialogAddons

sanitize

summaryRenderer

Settings

Member Visibility

Theme

On This Page

cachesdialogManagerdocumentflagsidPrefixprovidertasksasElementcolWidthgetGroupgetPossibleRenderergetRowgroupRendererisGrouprendererresolveToolbarActionsresolveToolbarDialogAddonssanitizesummaryRenderer