Class EngineRanking

Hierarchy

ACellTableSection<RenderColumn>
- EngineRanking

Implements

ITableSection
ITableSection
IEventHandler

Index

Constructors

constructor

Events

Properties

Accessors

Methods

Constructors

constructor

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

Overrides ACellTableSection.__constructor
- Defined in ui/EngineRanking.ts:160
Parameters
- ranking: Ranking
- header: HTMLElement
- body: HTMLElement
- tableId: string
- style: GridStyleManager
- ctx: IEngineRankingContext
- Default value roptions: Partial<IEngineRankingOptions> = {}
Returns EngineRanking

Events

highlightChanged

highlightChanged(dataIndex: number): void

- Defined in ui/EngineRanking.ts:55
Parameters
- dataIndex: number
Returns void

updateData

updateData(): void

- Defined in ui/EngineRanking.ts:41
Returns void

updateHist

updateHist(col: Column): void

- Defined in ui/EngineRanking.ts:48
Parameters
- col: Column
Returns void

widthChanged

widthChanged(): void

- Defined in ui/EngineRanking.ts:35
Returns void

Properties

body

body: HTMLElement

header

header: HTMLElement

height

height: number

hidden

hidden: boolean

ranking

ranking: Ranking

width

width: number

Static EVENT_HIGHLIGHT_CHANGED

EVENT_HIGHLIGHT_CHANGED: "highlightChanged" = RankingEvents.EVENT_HIGHLIGHT_CHANGED

Static EVENT_UPDATE_DATA

EVENT_UPDATE_DATA: "updateData" = RankingEvents.EVENT_UPDATE_DATA

Static EVENT_UPDATE_HIST

EVENT_UPDATE_HIST: "updateHist" = RankingEvents.EVENT_UPDATE_HIST

Static EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = RankingEvents.EVENT_WIDTH_CHANGED

Accessors

context

context:

currentData

currentData:

id

id:

Methods

destroy

destroy(): void

Overrides ACellTableSection.destroy
- Defined in ui/EngineRanking.ts:664
Returns void

enableHighlightListening

enableHighlightListening(enable: boolean): void

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

findNearest

findNearest(dataIndices: number[]): number

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

getHighlight

getHighlight(): number

- Defined in ui/EngineRanking.ts:832
Returns number

groupData

groupData(data: IDataRow[]): (IGroupData | IGroupItem)[]

- Defined in ui/EngineRanking.ts:669
Parameters
- data: IDataRow[]
Returns (IGroupData | IGroupItem)[]

hide

hide(): void

Inherited from ACellTableSection.hide
- Defined in /home/circleci/lineup/node_modules/lineupengine/src/table/ACellTableSection.d.ts:32
Returns void

init

init(): void

Inherited from ACellTableSection.init
- Defined in /home/circleci/lineup/node_modules/lineupengine/src/table/ACellTableSection.d.ts:34
Returns void

on

on(type: "widthChanged", listener: widthChanged | null): this
on(type: "updateData", listener: updateData | null): this
on(type: "updateHist", listener: updateHist | null): this
on(type: "highlightChanged", listener: highlightChanged | null): this
on(type: string | string[], listener: IEventListener | null): this

- Defined in ui/EngineRanking.ts:249
Parameters
- type: "widthChanged"
- listener: widthChanged | null
Returns this
- Defined in ui/EngineRanking.ts:250
Parameters
- type: "updateData"
- listener: updateData | null
Returns this
- Defined in ui/EngineRanking.ts:251
Parameters
- type: "updateHist"
- listener: updateHist | null
Returns this
- Defined in ui/EngineRanking.ts:252
Parameters
- type: "highlightChanged"
- listener: highlightChanged | null
Returns this
Implementation of IEventHandler.on
- Defined in ui/EngineRanking.ts:253
Parameters
- type: string | string[]
- listener: IEventListener | null
Returns this

render

render(data: (IGroupData | IGroupItem)[], rowContext: IExceptionContext): void

- Defined in ui/EngineRanking.ts:715
Parameters
- data: (IGroupData | IGroupItem)[]
- rowContext: IExceptionContext
Returns void

scrollIntoView

scrollIntoView(dataIndex: number): boolean

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

setHighlight

setHighlight(dataIndex: number): undefined | false | true

- Defined in ui/EngineRanking.ts:736
Parameters
- dataIndex: number
Returns undefined | false | true

show

show(scrollLeft: number, clientWidth: number, isGoingRight: boolean): void

Inherited from ACellTableSection.show
- Defined in /home/circleci/lineup/node_modules/lineupengine/src/table/ACellTableSection.d.ts:33
Parameters
- scrollLeft: number
- clientWidth: number
- isGoingRight: boolean
Returns void

updateAll

updateAll(): void

- Defined in ui/EngineRanking.ts:372
Returns void

updateBody

updateBody(): void

- Defined in ui/EngineRanking.ts:386
Returns void

updateColumnWidths

updateColumnWidths(): void

- Defined in ui/EngineRanking.ts:617
Returns void

updateHeaderOf

updateHeaderOf(col: Column): false | RenderColumn

- Defined in ui/EngineRanking.ts:394
Parameters
- col: Column
Returns false | RenderColumn

updateHeaders

updateHeaders(): void

- Defined in ui/EngineRanking.ts:270
Returns void

updateSelection

updateSelection(selectedDataIndices: object): void

- Defined in ui/EngineRanking.ts:606
Parameters
- selectedDataIndices: object
Returns void