Class EngineRanking

Hierarchy

ACellTableSection<RenderColumn>
- EngineRanking

Implements

ITableSection
IEventHandler

Constructors

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
Overrides ACellTableSection<RenderColumn>.constructor
- Defined in ui/EngineRanking.ts:230

Properties

`Readonly` ranking

ranking: Ranking

`Static` `Readonly` EVENT_HIGHLIGHT_CHANGED

EVENT_HIGHLIGHT_CHANGED: "highlightChanged" = RankingEvents.EVENT_HIGHLIGHT_CHANGED

`Static` `Readonly` EVENT_RECREATE

EVENT_RECREATE: "recreate" = RankingEvents.EVENT_RECREATE

`Static` `Readonly` EVENT_UPDATE_DATA

EVENT_UPDATE_DATA: "updateData" = RankingEvents.EVENT_UPDATE_DATA

`Static` `Readonly` EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = RankingEvents.EVENT_WIDTH_CHANGED

Accessors

context

get context(): ICellRenderContext<RenderColumn>
Returns ICellRenderContext<RenderColumn>
Overrides ACellTableSection.context
- Defined in ui/EngineRanking.ts:402

currentData

get currentData(): (IGroupItem | Readonly<IOrderedGroup>)[]
Returns (IGroupItem | Readonly<IOrderedGroup>)[]
- Defined in ui/EngineRanking.ts:398

id

get id(): string
Returns string
Implementation of ITableSection.id
Overrides ACellTableSection.id
- Defined in ui/EngineRanking.ts:382

Methods

`Protected` createCell

createCell(_document, index, column): HTMLElement | IAsyncUpdate<HTMLElement>
Parameters
- _document: Document
- index: number
- column: RenderColumn
Returns HTMLElement | IAsyncUpdate<HTMLElement>
Overrides ACellTableSection.createCell
- Defined in ui/EngineRanking.ts:425

`Protected` createHeader

createHeader(_document, column): HTMLElement | IAsyncUpdate<HTMLElement>
Parameters
- _document: Document
- column: RenderColumn
Returns HTMLElement | IAsyncUpdate<HTMLElement>
Overrides ACellTableSection.createHeader
- Defined in ui/EngineRanking.ts:406

`Protected` createRow

createRow(node, rowIndex): void
Parameters
- node: HTMLElement
- rowIndex: number
Returns void
Overrides ACellTableSection.createRow
- Defined in ui/EngineRanking.ts:706

destroy

destroy(): void
Returns void
Implementation of ITableSection.destroy
Overrides ACellTableSection.destroy
- Defined in ui/EngineRanking.ts:1016

enableHighlightListening

enableHighlightListening(enable): void
Parameters
- enable: boolean
Returns void
- Defined in ui/EngineRanking.ts:877

findNearest

findNearest(dataIndices): number
Parameters
- dataIndices: number[]
Returns number
- Defined in ui/EngineRanking.ts:1130

`Protected` forEachRow

forEachRow(callback, inplace?): void
Parameters
- callback: ((row, rowIndex) => void)
  - - (row, rowIndex): void
    - Parameters
      row: HTMLElement
      rowIndex: number
      Returns void
- inplace: boolean = false
Returns void
Overrides ACellTableSection.forEachRow
- Defined in ui/EngineRanking.ts:910

getHighlight

getHighlight(): number
Returns number
- Defined in ui/EngineRanking.ts:1216

groupData

groupData(): (IGroupItem | Readonly<IOrderedGroup>)[]
Returns (IGroupItem | Readonly<IOrderedGroup>)[]
- Defined in ui/EngineRanking.ts:1023

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
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:372
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
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:373
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
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:374
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
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:375
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:376

`Protected` onVisibilityChanged

onVisibilityChanged(visible): void
Parameters
- visible: boolean
Returns void
Overrides ACellTableSection.onVisibilityChanged
- Defined in ui/EngineRanking.ts:386

render

render(data, rowContext): void
Parameters
- data: (IGroupItem | Readonly<IOrderedGroup>)[]
- rowContext: IExceptionContext
Returns void
- Defined in ui/EngineRanking.ts:1085

scrollIntoView

scrollIntoView(dataIndex): boolean
Parameters
- dataIndex: number
Returns boolean
- Defined in ui/EngineRanking.ts:1166

setHighlight

setHighlight(dataIndex): boolean
Parameters
- dataIndex: number
Returns boolean
- Defined in ui/EngineRanking.ts:1114

updateAll

updateAll(): void
Returns void
- Defined in ui/EngineRanking.ts:663

updateBody

updateBody(): void
Returns void
- Defined in ui/EngineRanking.ts:684

`Protected` updateCanvasCell

updateCanvasCell(canvas, node, index, column, x): void
Parameters
- canvas: HTMLCanvasElement
- node: HTMLElement
- index: number
- column: RenderColumn
- x: number
Returns void
- Defined in ui/EngineRanking.ts:605

`Protected` updateCell

updateCell(node, index, column): HTMLElement | IAsyncUpdate<HTMLElement>
Parameters
- node: HTMLElement
- index: number
- column: RenderColumn
Returns HTMLElement | IAsyncUpdate<HTMLElement>
Overrides ACellTableSection.updateCell
- Defined in ui/EngineRanking.ts:441

updateColumnWidths

updateColumnWidths(): void
Returns void
Overrides ACellTableSection.updateColumnWidths
- Defined in ui/EngineRanking.ts:932

`Protected` updateHeader

updateHeader(node, column): HTMLElement | IAsyncUpdate<HTMLElement>
Parameters
- node: HTMLElement
- column: RenderColumn
Returns HTMLElement | IAsyncUpdate<HTMLElement>
Overrides ACellTableSection.updateHeader
- Defined in ui/EngineRanking.ts:418

updateHeaderOf

updateHeaderOf(col): false | RenderColumn
Parameters
- col: Column
Returns false | RenderColumn
- Defined in ui/EngineRanking.ts:692

updateHeaders

updateHeaders(): void
Returns void
Overrides ACellTableSection.updateHeaders
- Defined in ui/EngineRanking.ts:393

`Protected` updateRow

updateRow(node, rowIndex, hoverLod?): void
Parameters
- node: HTMLElement
- rowIndex: number
- Optional hoverLod: "high" | "low"
Returns void
Overrides ACellTableSection.updateRow
- Defined in ui/EngineRanking.ts:751

updateSelection

updateSelection(selectedDataIndices): void
Parameters
- selectedDataIndices: {
  has(i): boolean;
  }
  - has:function
    - has(i): boolean
    - Parameters
      i: number
      Returns boolean
      Defined in ui/EngineRanking.ts:921
Returns void
- Defined in ui/EngineRanking.ts:921

`Protected` updateShifts

updateShifts(top, left): void
Parameters
- top: number
- left: number
Returns void
Overrides ACellTableSection.updateShifts
- Defined in ui/EngineRanking.ts:853

Class EngineRanking

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

ranking: Ranking

header: HTMLElement

body: HTMLElement

tableId: string

style: default

ctx: IEngineRankingContext

roptions: Partial<IEngineRankingOptions> = {}

Returns EngineRanking

Properties

Readonly ranking

Static Readonly EVENT_HIGHLIGHT_CHANGED

Static Readonly EVENT_RECREATE

Static Readonly EVENT_UPDATE_DATA

Static Readonly EVENT_WIDTH_CHANGED

Accessors

context

Returns ICellRenderContext<RenderColumn>

currentData

Returns (IGroupItem | Readonly<IOrderedGroup>)[]

id

Returns string

Methods

Protected createCell

Parameters

_document: Document

index: number

column: RenderColumn

Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected createHeader

Parameters

_document: Document

column: RenderColumn

Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected createRow

Parameters

node: HTMLElement

rowIndex: number

Returns void

destroy

Returns void

enableHighlightListening

Parameters

enable: boolean

Returns void

findNearest

Parameters

dataIndices: number[]

Returns number

Protected forEachRow

Parameters

callback: ((row, rowIndex) => void)

Parameters

row: HTMLElement

rowIndex: number

Returns void

inplace: boolean = false

Returns void

getHighlight

Returns number

groupData

Returns (IGroupItem | Readonly<IOrderedGroup>)[]

on

Parameters

type: "widthChanged"

listener: (() => void)

Returns void

As Member Of

Group

Returns this

`Readonly` ranking

`Static` `Readonly` EVENT_HIGHLIGHT_CHANGED

`Static` `Readonly` EVENT_RECREATE

`Static` `Readonly` EVENT_UPDATE_DATA

`Static` `Readonly` EVENT_WIDTH_CHANGED

`Protected` createCell

`Protected` createHeader

`Protected` createRow

`Protected` forEachRow

`Protected` onVisibilityChanged

`Protected` updateCanvasCell

`Protected` updateCell

`Protected` updateHeader