Class EngineRanking

constructor

• new EngineRanking(ranking, header, body, tableId, style, ctx, roptions?): EngineRanking

• Parameters

  • ranking: Ranking
  • header: HTMLElement
  • body: HTMLElement
  • tableId: string
  • style: default
  • ctx: IEngineRankingContext
  • roptions: Partial<IEngineRankingOptions> = {}

  Returns EngineRanking

Readonly ranking

Static Readonly EVENT_HIGHLIGHT_CHANGED

Static Readonly EVENT_RECREATE

Static Readonly EVENT_UPDATE_DATA

Static Readonly EVENT_WIDTH_CHANGED

context

• get context(): ICellRenderContext<RenderColumn>

• Returns ICellRenderContext<RenderColumn>

currentData

• get currentData(): (IGroupItem | Readonly<IOrderedGroup>)[]

• Returns (IGroupItem | Readonly<IOrderedGroup>)[]

id

• get id(): string

• Returns string

destroy

• destroy(): void

• Returns void

enableHighlightListening

• enableHighlightListening(enable): void

• Parameters

  • enable: boolean

  Returns void

findNearest

• findNearest(dataIndices): number

• Parameters

  • dataIndices: number[]

  Returns number

getHighlight

• getHighlight(): number

• Returns number

groupData

• groupData(): (IGroupItem | Readonly<IOrderedGroup>)[]

• Returns (IGroupItem | Readonly<IOrderedGroup>)[]

on

• on(type, listener): this

• Parameters

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

      • emitted when the width of the ranking changed

        Returns void

        As Member Of

        EngineRanking

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

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

      • emitted when the data of the ranking needs to be updated

        Returns void

        As Member Of

        EngineRanking

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

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

      • emitted when the table has be recreated

        Returns void

        As Member Of

        EngineRanking

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "highlightChanged"
  • listener: ((dataIndex) => void)
    • • (dataIndex): void

      • emitted when the highlight changes

        Parameters

        • dataIndex: number

          the highlighted data index or -1 for none

        Returns void

        As Member Of

        EngineRanking

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: string | string[]
  • listener: IEventListener

  Returns this

render

• render(data, rowContext): void

• Parameters

  • data: (IGroupItem | Readonly<IOrderedGroup>)[]
  • rowContext: IExceptionContext

  Returns void

scrollIntoView

• scrollIntoView(dataIndex): boolean

• Parameters

  • dataIndex: number

  Returns boolean

setHighlight

• setHighlight(dataIndex): boolean

• Parameters

  • dataIndex: number

  Returns boolean

updateAll

• updateAll(): void

• Returns void

updateBody

• updateBody(): void

• Returns void

updateColumnWidths

• updateColumnWidths(): void

• Returns void

updateHeaderOf

• updateHeaderOf(col): false | RenderColumn

• Parameters

  • col: Column

  Returns false | RenderColumn

updateHeaders

• updateHeaders(): void

• Returns void

updateSelection

• updateSelection(selectedDataIndices): void

• Parameters

  • selectedDataIndices: {
        has(i): boolean;
    }

    • has:function

      • has(i): boolean

      • Parameters

        • i: number

        Returns boolean

  Returns void