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:158
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:56
emitted when the highlight changes

asmemberof

EngineRanking

Parameters
- dataIndex: number
  
  the highlghted data index or -1 for none
Returns void

updateData

updateData(): void

- Defined in ui/EngineRanking.ts:42
emitted when the data of the ranking needs to be updated

asmemberof

EngineRanking

Returns void

updateHist

updateHist(col: Column): void

- Defined in ui/EngineRanking.ts:49
emitted when the histogram of a column needs to be updated

asmemberof

EngineRanking

Parameters
- col: Column
  
  the column to update the histogram of
Returns void

widthChanged

widthChanged(): void

- Defined in ui/EngineRanking.ts:36
emitted when the width of the ranking changed

asmemberof

EngineRanking

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

get context(): ICellRenderContext<RenderColumn>

- Defined in ui/EngineRanking.ts:275
Returns ICellRenderContext<RenderColumn>

currentData

get currentData(): (IGroupData | IGroupItem)[]

- Defined in ui/EngineRanking.ts:271
Returns (IGroupData | IGroupItem)[]

id

get id(): string

Overrides ACellTableSection.id
- Defined in ui/EngineRanking.ts:256
Returns string

Methods

destroy

destroy(): void

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

enableHighlightListening

enableHighlightListening(enable: boolean): void

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

findNearest

findNearest(dataIndices: number[]): number

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

getHighlight

getHighlight(): number

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

groupData

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

- Defined in ui/EngineRanking.ts:665
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

- Defined in ui/EngineRanking.ts:247
Parameters
- type: "widthChanged"
- listener: widthChanged | null
Returns this
- Defined in ui/EngineRanking.ts:248
Parameters
- type: "updateData"
- listener: updateData | null
Returns this
- Defined in ui/EngineRanking.ts:249
Parameters
- type: "updateHist"
- listener: updateHist | null
Returns this
- Defined in ui/EngineRanking.ts:250
Parameters
- type: "highlightChanged"
- listener: highlightChanged | null
Returns this

render

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

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

scrollIntoView

scrollIntoView(dataIndex: number): boolean

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

setHighlight

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

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

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:368
Returns void

updateBody

updateBody(): void

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

updateColumnWidths

updateColumnWidths(): void

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

updateHeaderOf

updateHeaderOf(col: Column): false | RenderColumn

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

updateHeaders

updateHeaders(): void

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

updateSelection

updateSelection(selectedDataIndices: object): void

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