Class EngineRenderer

base class for event dispatching using d3 event mechanism, thus .suffix is supported for multiple registrations

Hierarchy (view full)

AEventDispatcher
- EngineRenderer

Constructors

constructor

new EngineRenderer(data, parent, options): EngineRenderer
Parameters
- data: DataProvider
- parent: HTMLElement
- options: Readonly<ILineUpOptions>
Returns EngineRenderer
Overrides AEventDispatcher.constructor
- Defined in ui/EngineRenderer.ts:64

Properties

`Readonly` ctx

ctx: IRankingHeaderContextContainer & IRenderContext & IEngineRankingContext

`Protected` data

data: DataProvider

`Readonly` idPrefix

idPrefix: any

`Readonly` node

node: HTMLElement

`Protected` `Readonly` options

options: Readonly<ILineUpOptions>

`Readonly` selectionIndicator

selectionIndicator: SelectionIndicator

`Static` `Readonly` EVENT_DIALOG_CLOSED

EVENT_DIALOG_CLOSED: "dialogClosed" = DialogManager.EVENT_DIALOG_CLOSED

`Static` `Readonly` EVENT_DIALOG_OPENED

EVENT_DIALOG_OPENED: "dialogOpened" = DialogManager.EVENT_DIALOG_OPENED

`Static` `Readonly` EVENT_HIGHLIGHT_CHANGED

EVENT_HIGHLIGHT_CHANGED: "highlightChanged" = EngineRanking.EVENT_HIGHLIGHT_CHANGED

Accessors

style

get style(): default
Returns default
- Defined in ui/EngineRenderer.ts:243

Methods

`Protected` createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns string[]
by default no events
Overrides AEventDispatcher.createEventList
- Defined in ui/EngineRenderer.ts:268

destroy

destroy(): void
Returns void
- Defined in ui/EngineRenderer.ts:564

enableHighlightListening

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

`Protected` fire

fire(type, ...args): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

`Protected` forward

forward(from, ...types): void
forwards one or more events from a given dispatcher to the current one i.e. when one of the given events is fired in 'from' it will be forwarded to all my listeners
Parameters
- from: IEventHandler
  the event dispatcher to forward from
- Rest ...types: string[]
  the event types to forward
Returns void
Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

getHighlight

getHighlight(): number
Returns number
- Defined in ui/EngineRenderer.ts:547

`Protected` listenersChanged

listenersChanged(_type, _active): void
helper function that will be called upon a listener has changed
Parameters
- _type: string
  event type
- _active: boolean
  registered or de registered
Returns void
Inherited from AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

on

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
      EngineRenderer
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in ui/EngineRenderer.ts:278
on(type, listener): this
Parameters
- type: "dialogOpened"
- listener: ((dialog) => void)
  - - (dialog): void
    - emitted a dialog is opened
      
      Parameters
      dialog: ADialog
      the opened dialog
      
      Returns void
      As Member Of
      EngineRenderer
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in ui/EngineRenderer.ts:279
on(type, listener): this
Parameters
- type: "dialogClosed"
- listener: ((dialog, action) => void)
  - - (dialog, action): void
    - emitted a dialog is closed
      
      Parameters
      dialog: ADialog
      the closed dialog
      
      action: "cancel" | "confirm"
      the action how the dialog was closed
      
      Returns void
      As Member Of
      EngineRenderer
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in ui/EngineRenderer.ts:280
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Overrides AEventDispatcher.on
- Defined in ui/EngineRenderer.ts:281

pushUpdateAble

pushUpdateAble(updateAble): void
Parameters
- updateAble: ((ctx) => void)
  - - (ctx): void
    - Parameters
      ctx: Readonly<IRankingHeaderContextContainer>
      Returns void
Returns void
- Defined in ui/EngineRenderer.ts:264

setDataProvider

setDataProvider(data): void
Parameters
- data: DataProvider
Returns void
- Defined in ui/EngineRenderer.ts:286

setHighlight

setHighlight(dataIndex, scrollIntoView): boolean
Parameters
- dataIndex: number
- scrollIntoView: boolean
Returns boolean
- Defined in ui/EngineRenderer.ts:524

setHighlightToNearest

setHighlightToNearest(dataIndices, scrollIntoView): boolean
Parameters
- dataIndices: number[]
- scrollIntoView: boolean
Returns boolean
- Defined in ui/EngineRenderer.ts:536

`Protected` unforward

unforward(from, ...types): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- Rest ...types: string[]
  event types to forward
Returns void
Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146

update

update(rankings?): void
Parameters
- rankings: EngineRanking[] = ...
Returns void
- Defined in ui/EngineRenderer.ts:426

zoomIn

zoomIn(): void
Returns void
- Defined in ui/EngineRenderer.ts:253

zoomOut

zoomOut(): void
Returns void
- Defined in ui/EngineRenderer.ts:247

Class EngineRenderer

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EngineRenderer

Properties

Readonly ctx

Protected data

Readonly idPrefix

Readonly node

Protected Readonly options

Readonly selectionIndicator

Static Readonly EVENT_DIALOG_CLOSED

Static Readonly EVENT_DIALOG_OPENED

Static Readonly EVENT_HIGHLIGHT_CHANGED

Accessors

style

Returns default

Methods

Protected createEventList

Returns string[]

destroy

Returns void

enableHighlightListening

Parameters

Returns void

Protected fire

Parameters

Returns void

Protected forward

Parameters

Returns void

getHighlight

Returns number

Protected listenersChanged

Parameters

Returns void

on

Parameters

Parameters

Returns void

As Member Of

Group

Returns this

Parameters

Parameters

Returns void

As Member Of

Group

Returns this

Parameters

Parameters

Returns void

As Member Of

Group

Returns this

Parameters

Returns this

pushUpdateAble

Parameters

Parameters

Returns void

Returns void

setDataProvider

Parameters

Returns void

setHighlight

Parameters

Returns boolean

setHighlightToNearest

Parameters

Returns boolean

Protected unforward

Parameters

`Readonly` ctx

`Protected` data

`Readonly` idPrefix

`Readonly` node

`Protected` `Readonly` options

`Readonly` selectionIndicator

`Static` `Readonly` EVENT_DIALOG_CLOSED

`Static` `Readonly` EVENT_DIALOG_OPENED

`Static` `Readonly` EVENT_HIGHLIGHT_CHANGED

`Protected` createEventList

`Protected` fire

`Protected` forward

`Protected` listenersChanged

`Protected` unforward