Class EngineRanking

Hierarchy

ACellTableSection<RenderColumn>
- EngineRanking

Implements

ITableSection
IEventHandler

Constructors

constructor

new EngineRanking(ranking: Ranking, header: HTMLElement, body: HTMLElement, tableId: string, style: default, ctx: IEngineRankingContext, roptions?: Partial<IEngineRankingOptions>): EngineRanking

Overrides ACellTableSection<RenderColumn>.constructor
- Defined in src/ui/EngineRanking.ts:221
Parameters
- ranking: Ranking
- header: HTMLElement
- body: HTMLElement
- tableId: string
- style: default
- ctx: IEngineRankingContext
- roptions: Partial<IEngineRankingOptions> = {}
Returns EngineRanking

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<default>

Overrides ACellTableSection.context
- Defined in src/ui/EngineRanking.ts:393
Returns ICellRenderContext<default>

currentData

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

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

id

get id(): string

Implementation of ITableSection.id
Overrides ACellTableSection.id
- Defined in src/ui/EngineRanking.ts:373
Returns string

Methods

Protected createCell

createCell(_document: Document, index: number, column: default): HTMLElement | IAsyncUpdate<HTMLElement>

Overrides ACellTableSection.createCell
- Defined in src/ui/EngineRanking.ts:416
Parameters
- _document: Document
- index: number
- column: default
Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected createHeader

createHeader(_document: Document, column: default): HTMLElement | IAsyncUpdate<HTMLElement>

Overrides ACellTableSection.createHeader
- Defined in src/ui/EngineRanking.ts:397
Parameters
- _document: Document
- column: default
Returns HTMLElement | IAsyncUpdate<HTMLElement>

Protected createRow

createRow(node: HTMLElement, rowIndex: number): void

Overrides ACellTableSection.createRow
- Defined in src/ui/EngineRanking.ts:697
Parameters
- node: HTMLElement
- rowIndex: number
Returns void

destroy

destroy(): void

Implementation of ITableSection.destroy
Overrides ACellTableSection.destroy
- Defined in src/ui/EngineRanking.ts:1007
Returns void

enableHighlightListening

enableHighlightListening(enable: boolean): void

- Defined in src/ui/EngineRanking.ts:868
Parameters
- enable: boolean
Returns void

findNearest

findNearest(dataIndices: number[]): number

- Defined in src/ui/EngineRanking.ts:1121
Parameters
- dataIndices: number[]
Returns number

Protected forEachRow

forEachRow(callback: (row: HTMLElement, rowIndex: number) => void, inplace?: boolean): void

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

getHighlight

getHighlight(): number

- Defined in src/ui/EngineRanking.ts:1207
Returns number

groupData

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

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

on

on(type: "widthChanged", listener: () => void): EngineRanking
on(type: "updateData", listener: () => void): EngineRanking
on(type: "recreate", listener: () => void): EngineRanking
on(type: "highlightChanged", listener: (dataIndex: number) => void): EngineRanking
on(type: string | string[], listener: IEventListener): EngineRanking

Implementation of IEventHandler.on
- Defined in src/ui/EngineRanking.ts:363
Parameters
- type: "widthChanged"
- listener: () => void
  - - (): void
    - emitted when the width of the ranking changed
      
      asmemberof
      EngineRanking
      
      Returns void
Returns EngineRanking
Implementation of IEventHandler.on
- Defined in src/ui/EngineRanking.ts:364
Parameters
- type: "updateData"
- listener: () => void
  - - (): void
    - emitted when the data of the ranking needs to be updated
      
      asmemberof
      EngineRanking
      
      Returns void
Returns EngineRanking
Implementation of IEventHandler.on
- Defined in src/ui/EngineRanking.ts:365
Parameters
- type: "recreate"
- listener: () => void
  - - (): void
    - emitted when the table has be recreated
      
      asmemberof
      EngineRanking
      
      Returns void
Returns EngineRanking
Implementation of IEventHandler.on
- Defined in src/ui/EngineRanking.ts:366
Parameters
- type: "highlightChanged"
- listener: (dataIndex: number) => void
  - - (dataIndex: number): void
    - emitted when the highlight changes
      
      asmemberof
      EngineRanking
      
      Parameters
      - dataIndex: number
        
        the highlighted data index or -1 for none
      Returns void
Returns EngineRanking
Implementation of IEventHandler.on
- Defined in src/ui/EngineRanking.ts:367
Parameters
- type: string | string[]
- listener: IEventListener
Returns EngineRanking

Protected onVisibilityChanged

onVisibilityChanged(visible: boolean): void

Overrides ACellTableSection.onVisibilityChanged
- Defined in src/ui/EngineRanking.ts:377
Parameters
- visible: boolean
Returns void

render

render(data: (IGroupItem | Readonly<IOrderedGroup>)[], rowContext: IExceptionContext): void

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

scrollIntoView

scrollIntoView(dataIndex: number): boolean

- Defined in src/ui/EngineRanking.ts:1157
Parameters
- dataIndex: number
Returns boolean

setHighlight

setHighlight(dataIndex: number): boolean

- Defined in src/ui/EngineRanking.ts:1105
Parameters
- dataIndex: number
Returns boolean

updateAll

updateAll(): void

- Defined in src/ui/EngineRanking.ts:654
Returns void

updateBody

updateBody(): void

- Defined in src/ui/EngineRanking.ts:675
Returns void

Protected updateCanvasCell

updateCanvasCell(canvas: HTMLCanvasElement, node: HTMLElement, index: number, column: default, x: number): void

- Defined in src/ui/EngineRanking.ts:596
Parameters
- canvas: HTMLCanvasElement
- node: HTMLElement
- index: number
- column: default
- x: number
Returns void

Protected updateCell

updateCell(node: HTMLElement, index: number, column: default): HTMLElement | IAsyncUpdate<HTMLElement>

Overrides ACellTableSection.updateCell
- Defined in src/ui/EngineRanking.ts:432
Parameters
- node: HTMLElement
- index: number
- column: default
Returns HTMLElement | IAsyncUpdate<HTMLElement>

updateColumnWidths

updateColumnWidths(): void

Overrides ACellTableSection.updateColumnWidths
- Defined in src/ui/EngineRanking.ts:923
Returns void

Protected updateHeader

updateHeader(node: HTMLElement, column: default): HTMLElement | IAsyncUpdate<HTMLElement>

Overrides ACellTableSection.updateHeader
- Defined in src/ui/EngineRanking.ts:409
Parameters
- node: HTMLElement
- column: default
Returns HTMLElement | IAsyncUpdate<HTMLElement>

updateHeaderOf

updateHeaderOf(col: Column): false | default

- Defined in src/ui/EngineRanking.ts:683
Parameters
- col: Column
Returns false | default

updateHeaders

updateHeaders(): void

Overrides ACellTableSection.updateHeaders
- Defined in src/ui/EngineRanking.ts:384
Returns void

Protected updateRow

updateRow(node: HTMLElement, rowIndex: number, hoverLod?: "high" | "low"): void

Overrides ACellTableSection.updateRow
- Defined in src/ui/EngineRanking.ts:742
Parameters
- node: HTMLElement
- rowIndex: number
- Optional hoverLod: "high" | "low"
Returns void

updateSelection

updateSelection(selectedDataIndices: { has: any }): void

- Defined in src/ui/EngineRanking.ts:912
Parameters
- selectedDataIndices: { has: any }
  - has:function
    - has(i: number): boolean
    - Defined in src/ui/EngineRanking.ts:912
      Parameters
      - i: number
      Returns boolean
Returns void

Protected updateShifts

updateShifts(top: number, left: number): void

Overrides ACellTableSection.updateShifts
- Defined in src/ui/EngineRanking.ts:844
Parameters
- top: number
- left: number
Returns void