Interface IEngineRankingContext

context for rendering, wrapped as an object for easy extensibility

Hierarchy

IRankingHeaderContextContainer
IRenderContext
- IEngineRankingContext

Index

Properties

caches dialogManager document flags idPrefix provider tasks

Methods

asElement colWidth createRenderer getPossibleRenderer groupRenderer renderer resolveToolbarActions resolveToolbarDialogAddons sanitize summaryRenderer

Properties

`Readonly` caches

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

Type declaration

toolbar: Map<string, IToolbarAction[]>
toolbarAddons: Map<string, IToolbarDialogAddon[]>

`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

asElement(html: string): HTMLElement
Parameters
- html: string
Returns HTMLElement
Inherited from IRenderContext.asElement
- Defined in ui/interfaces.ts:75

colWidth

colWidth(col: Column): number
Parameters
- col: Column
Returns number
Inherited from IRenderContext.colWidth
- Defined in renderer/interfaces.ts:167

createRenderer

createRenderer(c: Column, imposer?: IImposer): IRenderers
Parameters
- c: Column
- Optional imposer: IImposer
Returns IRenderers
- Defined in ui/EngineRanking.ts:44

getPossibleRenderer

getPossibleRenderer(col: Column): { group: IRenderInfo[]; item: IRenderInfo[]; summary: IRenderInfo[] }
Parameters
- col: Column
Returns { group: IRenderInfo[]; item: IRenderInfo[]; summary: IRenderInfo[] }
- group: IRenderInfo[]
- item: IRenderInfo[]
- summary: IRenderInfo[]
Inherited from IRankingHeaderContextContainer.getPossibleRenderer
- Defined in ui/interfaces.ts:83

groupRenderer

groupRenderer(col: Column, imposer?: IImposer): IGroupCellRenderer
render a column
Parameters
- col: Column
- Optional imposer: IImposer
Returns IGroupCellRenderer
Inherited from IRenderContext.groupRenderer
- Defined in renderer/interfaces.ts:155

renderer

renderer(col: Column, imposer?: IImposer): ICellRenderer
render a column
Parameters
- col: Column
- Optional imposer: IImposer
Returns ICellRenderer
Inherited from IRenderContext.renderer
- Defined in renderer/interfaces.ts:149

resolveToolbarActions

resolveToolbarActions(col: Column, keys: string[]): IToolbarAction[]
Parameters
- col: Column
- keys: string[]
Returns IToolbarAction[]
Inherited from IRankingHeaderContextContainer.resolveToolbarActions
- Defined in ui/interfaces.ts:78

resolveToolbarDialogAddons

resolveToolbarDialogAddons(col: Column, keys: string[]): IToolbarDialogAddon[]
Parameters
- col: Column
- keys: string[]
Returns IToolbarDialogAddon[]
Inherited from IRankingHeaderContextContainer.resolveToolbarDialogAddons
- Defined in ui/interfaces.ts:79

sanitize

sanitize(text: string): string
Parameters
- text: string
Returns string
Inherited from IRenderContext.sanitize
- Defined in ui/interfaces.ts:76

summaryRenderer

summaryRenderer(co: Column, interactive: boolean, imposer?: IImposer): ISummaryRenderer
Parameters
- co: Column
- interactive: boolean
- Optional imposer: IImposer
Returns ISummaryRenderer
Inherited from IRenderContext.summaryRenderer
- Defined in ui/interfaces.ts:85