Class TaggleRenderer

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

Hierarchy

AEventDispatcher
- TaggleRenderer

Index

Constructors

constructor

new TaggleRenderer(data: DataProvider, parent: HTMLElement, options: Partial<ITaggleRendererOptions> & Readonly<ILineUpOptions>): TaggleRenderer
Parameters
- data: DataProvider
- parent: HTMLElement
- options: Partial<ITaggleRendererOptions> & Readonly<ILineUpOptions>
Returns TaggleRenderer
Overrides AEventDispatcher.constructor
- Defined in ui/taggle/TaggleRenderer.ts:67

Properties

data

data: DataProvider

`Static` `Readonly` EVENT_DIALOG_CLOSED

EVENT_DIALOG_CLOSED: "dialogClosed" = EngineRenderer.EVENT_DIALOG_CLOSED

`Static` `Readonly` EVENT_DIALOG_OPENED

EVENT_DIALOG_OPENED: "dialogOpened" = EngineRenderer.EVENT_DIALOG_OPENED

`Static` `Readonly` EVENT_HIGHLIGHT_CHANGED

EVENT_HIGHLIGHT_CHANGED: "highlightChanged" = EngineRenderer.EVENT_HIGHLIGHT_CHANGED

Accessors

ctx

get ctx(): IRankingHeaderContextContainer & IRenderContext & IEngineRankingContext
Returns IRankingHeaderContextContainer & IRenderContext & IEngineRankingContext
- Defined in ui/taggle/TaggleRenderer.ts:110

style

get style(): default
Returns default
- Defined in ui/taggle/TaggleRenderer.ts:106

Methods

`Protected` createEventList

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

Returns
by default no events

Returns string[]
Overrides AEventDispatcher.createEventList
- Defined in ui/taggle/TaggleRenderer.ts:161

destroy

destroy(): void
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:199

enableHighlightListening

enableHighlightListening(enable: boolean): void
Parameters
- enable: boolean
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:229

`Protected` fire

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

`Protected` forward

forward(from: IEventHandler, ...types: string[]): 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/taggle/TaggleRenderer.ts:225

getRule

getRule(): IRule
Returns IRule
- Defined in ui/taggle/TaggleRenderer.ts:195

`Protected` listenersChanged

listenersChanged(_type: string, _active: boolean): 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: "highlightChanged", listener: ((dataIndex: number) => void)): TaggleRenderer
Parameters
- type: "highlightChanged"
- listener: ((dataIndex: number) => void)
  - - (dataIndex: number): void
    - emitted when the highlight changes
      
      As Member Of
      TaggleRenderer
      
      Group
      Events
      
      Parameters
      
      dataIndex: number
      
      the highlighted data index or -1 for none
      
      Returns void
Returns TaggleRenderer
Overrides AEventDispatcher.on
- Defined in ui/taggle/TaggleRenderer.ts:171
on(type: "dialogOpened", listener: ((dialog: ADialog) => void)): TaggleRenderer
Parameters
- type: "dialogOpened"
- listener: ((dialog: ADialog) => void)
  - - (dialog: ADialog): void
    - emitted a dialog is opened
      
      As Member Of
      TaggleRenderer
      
      Group
      Events
      
      Parameters
      
      dialog: ADialog
      
      the opened dialog
      
      Returns void
Returns TaggleRenderer
Overrides AEventDispatcher.on
- Defined in ui/taggle/TaggleRenderer.ts:172
on(type: "dialogClosed", listener: ((dialog: ADialog, action: "cancel" | "confirm") => void)): TaggleRenderer
Parameters
- type: "dialogClosed"
- listener: ((dialog: ADialog, action: "cancel" | "confirm") => void)
  - - (dialog: ADialog, action: "cancel" | "confirm"): void
    - emitted a dialog is closed
      
      As Member Of
      TaggleRenderer
      
      Group
      Events
      
      Parameters
      
      dialog: ADialog
      
      the closed dialog
      
      action: "cancel" | "confirm"
      
      the action how the dialog was closed
      
      Returns void
Returns TaggleRenderer
Overrides AEventDispatcher.on
- Defined in ui/taggle/TaggleRenderer.ts:173
on(type: string | string[], listener: IEventListener): TaggleRenderer
Parameters
- type: string | string[]
- listener: IEventListener
Returns TaggleRenderer
Overrides AEventDispatcher.on
- Defined in ui/taggle/TaggleRenderer.ts:174

pushUpdateAble

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

setDataProvider

setDataProvider(data: DataProvider): void
Parameters
- data: DataProvider
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:207

setHighlight

setHighlight(dataIndex: number, scrollIntoView: boolean): boolean
Parameters
- dataIndex: number
- scrollIntoView: boolean
Returns boolean
- Defined in ui/taggle/TaggleRenderer.ts:221

switchRule

switchRule(rule: IRule): void
Parameters
- rule: IRule
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:187

`Protected` unforward

unforward(from: IEventHandler, ...types: string[]): 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(): void
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:203

zoomIn

zoomIn(): void
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:183

zoomOut

zoomOut(): void
Returns void
- Defined in ui/taggle/TaggleRenderer.ts:179

Class TaggleRenderer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: DataProvider

parent: HTMLElement

options: Partial<ITaggleRendererOptions> & Readonly<ILineUpOptions>

Returns TaggleRenderer

Properties

data

Static Readonly EVENT_DIALOG_CLOSED

Static Readonly EVENT_DIALOG_OPENED

Static Readonly EVENT_HIGHLIGHT_CHANGED

Accessors

ctx

Returns IRankingHeaderContextContainer & IRenderContext & IEngineRankingContext

style

Returns default

Methods

Protected createEventList

Returns

Returns string[]

destroy

Returns void

enableHighlightListening

Parameters

enable: boolean

Returns void

Protected fire

Parameters

type: string | string[]

Rest ...args: any[]

Returns void

Protected forward

Parameters

from: IEventHandler

Rest ...types: string[]

Returns void

getHighlight

Returns number

getRule

Returns IRule

Protected listenersChanged

Parameters

_type: string

_active: boolean

Returns void

on

Parameters

type: "highlightChanged"

listener: ((dataIndex: number) => void)

As Member Of

Group

Parameters

dataIndex: number

Returns void

Returns TaggleRenderer

Parameters

type: "dialogOpened"

listener: ((dialog: ADialog) => void)

As Member Of

Group

Parameters

dialog: ADialog

Returns void

Returns TaggleRenderer

Parameters

type: "dialogClosed"

listener: ((dialog: ADialog, action: "cancel" | "confirm") => void)

As Member Of

Group

Parameters

dialog: ADialog

action: "cancel" | "confirm"

`Static` `Readonly` EVENT_DIALOG_CLOSED

`Static` `Readonly` EVENT_DIALOG_OPENED

`Static` `Readonly` EVENT_HIGHLIGHT_CHANGED

`Protected` createEventList

`Protected` fire

`Rest` ...args: any[]

`Protected` forward

`Rest` ...types: string[]

`Protected` listenersChanged

`Protected` unforward

`Rest` ...types: string[]