Class Taggle

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

Hierarchy (View Summary)

ALineUp
- Taggle

Constructors

constructor

new Taggle(
    node: HTMLElement,
    data: DataProvider,
    options?: Partial<ITaggleOptions>,
): Taggle
Parameters
- node: HTMLElement
- data: DataProvider
- options: Partial<ITaggleOptions> = {}
Returns Taggle
Overrides ALineUp.constructor
- Defined in ui/taggle/Taggle.ts:25

Properties

`Readonly`isBrowserSupported

isBrowserSupported: boolean

`Readonly`node

node: HTMLElement

`Static` `Readonly`EVENT_DIALOG_CLOSED

EVENT_DIALOG_CLOSED: "dialogClosed" = ALineUp.EVENT_DIALOG_CLOSED

`Static` `Readonly`EVENT_DIALOG_OPENED

EVENT_DIALOG_OPENED: "dialogOpened" = ALineUp.EVENT_DIALOG_OPENED

`Static` `Readonly`EVENT_HIGHLIGHT_CHANGED

EVENT_HIGHLIGHT_CHANGED: "highlightChanged" = ALineUp.EVENT_HIGHLIGHT_CHANGED

`Static` `Readonly`EVENT_SELECTION_CHANGED

EVENT_SELECTION_CHANGED: "selectionChanged" = ALineUp.EVENT_SELECTION_CHANGED

Accessors

data

get data(): DataProvider
Returns DataProvider
Inherited from ALineUp.data
- Defined in ui/ALineUp.ts:101

Methods

`Protected`addCopyListener

addCopyListener(): void
Returns void
Inherited from ALineUp.addCopyListener
- Defined in ui/ALineUp.ts:185

`Protected`createEventList

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

Returns string[]
by default no events
Inherited from ALineUp.createEventList
- Defined in ui/ALineUp.ts:81

destroy

destroy(): void
Returns void
Overrides ALineUp.destroy
- Defined in ui/taggle/Taggle.ts:127

dump

dump(): IDataProviderDump
Returns IDataProviderDump
Inherited from ALineUp.dump
- Defined in ui/ALineUp.ts:111

`Protected`enableHighlightListening

enableHighlightListening(enable: boolean): void
Parameters
- enable: boolean
Returns void
Overrides ALineUp.enableHighlightListening
- Defined in ui/taggle/Taggle.ts:152

`Protected`fire

fire(type: string | string[], ...args: any[]): void
Parameters
- type: string | string[]
- ...args: any[]
Returns void
Inherited from ALineUp.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
- ...types: string[]
  the event types to forward
Returns void
Inherited from ALineUp.forward
- Defined in internal/AEventDispatcher.ts:137

getHighlight

getHighlight(): number
Returns number
Overrides ALineUp.getHighlight
- Defined in ui/taggle/Taggle.ts:148

getSelection

getSelection(): number[]
Returns number[]
Inherited from ALineUp.getSelection
- Defined in ui/ALineUp.ts:135

isOverviewMode

isOverviewMode(): boolean
Returns boolean
- Defined in ui/taggle/Taggle.ts:90

`Protected`listenersChanged

listenersChanged(type: string, enabled: boolean): void
helper function that will be called upon a listener has changed
Parameters
- type: string
- enabled: boolean
Returns void
Inherited from ALineUp.listenersChanged
- Defined in ui/ALineUp.ts:161

on

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
      ALineUp
Returns this
Inherited from ALineUp.on
- Defined in ui/ALineUp.ts:92
on(type: "selectionChanged", listener: (dataIndices: number[]) => void): this
Parameters
- type: "selectionChanged"
- listener: (dataIndices: number[]) => void
  - - (dataIndices: number[]): void
    - emitted when the selection changes
      
      Parameters
      dataIndices: number[]
      the selected data indices
      
      Returns void
      As Member Of
      ALineUp
Returns this
Inherited from ALineUp.on
- Defined in ui/ALineUp.ts:93
on(type: "dialogOpened", listener: (dialog: ADialog) => void): this
Parameters
- type: "dialogOpened"
- listener: (dialog: ADialog) => void
  - - (dialog: ADialog): void
    - emitted a dialog is opened
      
      Parameters
      dialog: ADialog
      the opened dialog
      
      Returns void
      As Member Of
      ALineUp
Returns this
Inherited from ALineUp.on
- Defined in ui/ALineUp.ts:94
on(
type: "dialogClosed",
listener: (dialog: ADialog, action: "cancel" | "confirm") => void,
): this
Parameters
- type: "dialogClosed"
- listener: (dialog: ADialog, action: "cancel" | "confirm") => void
  - - (dialog: ADialog, action: "cancel" | "confirm"): 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
      ALineUp
Returns this
Inherited from ALineUp.on
- Defined in ui/ALineUp.ts:95
on(type: string | string[], listener: IEventListener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Inherited from ALineUp.on
- Defined in ui/ALineUp.ts:96

restore

restore(dump: IDataProviderDump): void
Parameters
- dump: IDataProviderDump
Returns void
Inherited from ALineUp.restore
- Defined in ui/ALineUp.ts:115

setDataProvider

setDataProvider(data: DataProvider, dump?: any): void
Parameters
- data: DataProvider
- Optionaldump: any
Returns void
Overrides ALineUp.setDataProvider
- Defined in ui/taggle/Taggle.ts:158

setHighlight

setHighlight(dataIndex: number, scrollIntoView?: boolean): boolean
Parameters
- dataIndex: number
- scrollIntoView: boolean = true
Returns boolean
Overrides ALineUp.setHighlight
- Defined in ui/taggle/Taggle.ts:144

setOverviewMode

setOverviewMode(overviewMode: boolean): void
Parameters
- overviewMode: boolean
Returns void
- Defined in ui/taggle/Taggle.ts:94

setSelection

setSelection(dataIndices: number[]): void
Parameters
- dataIndices: number[]
Returns void
Inherited from ALineUp.setSelection
- Defined in ui/ALineUp.ts:139

sortBy

sortBy(column: string | (col: Column) => boolean, ascending?: boolean): boolean
sorts LineUp by he given column
Parameters
- column: string | (col: Column) => boolean
  callback function finding the column to sort
- ascending: boolean = false
Returns boolean
Inherited from ALineUp.sortBy
- Defined in ui/ALineUp.ts:149

`Protected`unforward

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

update

update(): void
Returns void
Overrides ALineUp.update
- Defined in ui/taggle/Taggle.ts:138

Class Taggle

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Taggle

Properties

ReadonlyisBrowserSupported

Readonlynode

Static ReadonlyEVENT_DIALOG_CLOSED

Static ReadonlyEVENT_DIALOG_OPENED

Static ReadonlyEVENT_HIGHLIGHT_CHANGED

Static ReadonlyEVENT_SELECTION_CHANGED

Accessors

data

Returns DataProvider

Methods

ProtectedaddCopyListener

Returns void

ProtectedcreateEventList

Returns string[]

destroy

Returns void

dump

Returns IDataProviderDump

ProtectedenableHighlightListening

Parameters

Returns void

Protectedfire

Parameters

Returns void

Protectedforward

Parameters

Returns void

getHighlight

Returns number

getSelection

Returns number[]

isOverviewMode

Returns boolean

ProtectedlistenersChanged

Parameters

Returns void

on

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Parameters

Returns void

As Member Of

Returns this

Parameters

Returns this

restore

Parameters

Returns void

setDataProvider

Parameters

Returns void

setHighlight

Parameters

Returns boolean

`Readonly`isBrowserSupported

`Readonly`node

`Static` `Readonly`EVENT_DIALOG_CLOSED

`Static` `Readonly`EVENT_DIALOG_OPENED

`Static` `Readonly`EVENT_HIGHLIGHT_CHANGED

`Static` `Readonly`EVENT_SELECTION_CHANGED

`Protected`addCopyListener

`Protected`createEventList

`Protected`enableHighlightListening

`Protected`fire

`Protected`forward

`Protected`listenersChanged

`Protected`unforward