Class EngineRanking

Hierarchy

ACellTableSection<RenderColumn>
- EngineRanking

Implements

ITableSection
IEventHandler

Constructors

constructor

new EngineRanking(
    ranking: Ranking,
    header: HTMLElement,
    body: HTMLElement,
    tableId: string,
    style: GridStyleManager,
    ctx: IEngineRankingContext,
    roptions?: Partial<IEngineRankingOptions>,
): EngineRanking
Parameters
- ranking: Ranking
- header: HTMLElement
- body: HTMLElement
- tableId: string
- style: GridStyleManager
- ctx: IEngineRankingContext
- roptions: Partial<IEngineRankingOptions> = {}
Returns EngineRanking
Overrides ACellTableSection<RenderColumn>.constructor
- Defined in ui/EngineRanking.ts:232

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>
the current render context, upon change recreate the whole table

Returns ICellRenderContext<RenderColumn>
Overrides ACellTableSection.context
- Defined in ui/EngineRanking.ts:404

currentData

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

id

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

Methods

`Protected`createCell

createCell(
    _document: Document,
    index: number,
    column: RenderColumn,
): HTMLElement | IAsyncUpdate<HTMLElement>
create a new cell node fo the given row index and column
Parameters
- _document: Document
- index: number
  the current row index
- column: RenderColumn
  the current column
Returns HTMLElement | IAsyncUpdate<HTMLElement>
the node representing the cell
Overrides ACellTableSection.createCell
- Defined in ui/EngineRanking.ts:427

`Protected`createHeader

createHeader(
_document: Document,
column: RenderColumn,
): HTMLElement | IAsyncUpdate<HTMLElement>
create a new header node for the given column
Parameters
- _document: Document
- column: RenderColumn
  the column to create the header for
Returns HTMLElement | IAsyncUpdate<HTMLElement>
the node representing the header
Overrides ACellTableSection.createHeader
- Defined in ui/EngineRanking.ts:408

`Protected`createRow

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

destroy

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

enableHighlightListening

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

findNearest

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

`Protected`forEachRow

forEachRow(
callback: (row: HTMLElement, rowIndex: number) => void,
inplace?: boolean,
): void
utility to execute a function for each visible row
Parameters
- callback: (row: HTMLElement, rowIndex: number) => void
  callback to execute
- inplace: boolean = false
Returns void
Overrides ACellTableSection.forEachRow
- Defined in ui/EngineRanking.ts:912

getHighlight

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

groupData

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

on

on(type: "widthChanged", listener: () => void): this
Parameters
- type: "widthChanged"
- listener: () => void
  - - (): void
    - emitted when the width of the ranking changed
      
      Returns void
      As Member Of
      EngineRanking
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:374
on(type: "updateData", listener: () => void): this
Parameters
- type: "updateData"
- listener: () => void
  - - (): void
    - emitted when the data of the ranking needs to be updated
      
      Returns void
      As Member Of
      EngineRanking
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:375
on(type: "recreate", listener: () => void): this
Parameters
- type: "recreate"
- listener: () => void
  - - (): void
    - emitted when the table has be recreated
      
      Returns void
      As Member Of
      EngineRanking
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:376
on(type: "highlightChanged", listener: (dataIndex: number) => void): this
Parameters
- type: "highlightChanged"
- listener: (dataIndex: number) => void
  - - (dataIndex: number): void
    - emitted when the highlight changes
      
      Parameters
      dataIndex: number
      the highlighted data index or -1 for none
      
      Returns void
      As Member Of
      EngineRanking
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:377
on(type: string | string[], listener: IEventListener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:378

`Protected`onVisibilityChanged

onVisibilityChanged(visible: boolean): void
hook when the visibility changes
Parameters
- visible: boolean
Returns void
Overrides ACellTableSection.onVisibilityChanged
- Defined in ui/EngineRanking.ts:388

render

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

scrollIntoView

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

setHighlight

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

updateAll

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

updateBody

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

`Protected`updateCanvasCell

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

`Protected`updateCell

updateCell(
    node: HTMLElement,
    index: number,
    column: RenderColumn,
): HTMLElement | IAsyncUpdate<HTMLElement>
updates the given cell node with the given row index and column
Parameters
- node: HTMLElement
  node to update
- index: number
  row index to use
- column: RenderColumn
  column to use
Returns HTMLElement | IAsyncUpdate<HTMLElement>
an optional new replacement node for the header
Overrides ACellTableSection.updateCell
- Defined in ui/EngineRanking.ts:443

updateColumnWidths

updateColumnWidths(): void
trigger an update all all column widths

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

`Protected`updateHeader

updateHeader(
node: HTMLElement,
column: RenderColumn,
): HTMLElement | IAsyncUpdate<HTMLElement>
updates the given header node with the given column
Parameters
- node: HTMLElement
  node to update
- column: RenderColumn
  the column to represents
Returns HTMLElement | IAsyncUpdate<HTMLElement>
an optional new replacement node for the header
Overrides ACellTableSection.updateHeader
- Defined in ui/EngineRanking.ts:420

updateHeaderOf

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

updateHeaders

updateHeaders(): void
triggers updating the header

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

`Protected`updateRow

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

updateSelection

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

`Protected`updateShifts

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

Class EngineRanking

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EngineRanking

Properties

Readonlyranking

Static ReadonlyEVENT_HIGHLIGHT_CHANGED

Static ReadonlyEVENT_RECREATE

Static ReadonlyEVENT_UPDATE_DATA

Static ReadonlyEVENT_WIDTH_CHANGED

Accessors

context

Returns ICellRenderContext<RenderColumn>

currentData

Returns (IGroupItem | Readonly<IOrderedGroup>)[]

id

Returns string

Methods

ProtectedcreateCell

Parameters

Returns HTMLElement | IAsyncUpdate<HTMLElement>

ProtectedcreateHeader

Parameters

Returns HTMLElement | IAsyncUpdate<HTMLElement>

ProtectedcreateRow

Parameters

Returns void

destroy

Returns void

enableHighlightListening

Parameters

Returns void

findNearest

Parameters

Returns number

ProtectedforEachRow

Parameters

Returns void

getHighlight

Returns number

groupData

Returns (IGroupItem | Readonly<IOrderedGroup>)[]

on

Parameters

Returns void

As Member Of

Returns this

Parameters

Returns void

As Member Of

Returns this

Parameters

Returns void

As Member Of

Returns this

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Returns this

ProtectedonVisibilityChanged

Parameters

Returns void

render

Parameters

Returns void

scrollIntoView

Parameters

Returns boolean

setHighlight

`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

`Protected`updateRow

`Protected`updateShifts