Class LineUp

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

Hierarchy (view full)

ALineUp
- LineUp

Constructors

constructor

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

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/LineUp.ts:59

dump

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

`Protected` enableHighlightListening

enableHighlightListening(enable): void
Parameters
- enable: boolean
Returns void
Overrides ALineUp.enableHighlightListening
- Defined in ui/LineUp.ts:96

`Protected` fire

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

getHighlight

getHighlight(): number
Returns number
Overrides ALineUp.getHighlight
- Defined in ui/LineUp.ts:92

getSelection

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

`Protected` listenersChanged

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

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

restore

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

setDataProvider

setDataProvider(data, dump?): void
Parameters
- data: DataProvider
- Optional dump: any
Returns void
Overrides ALineUp.setDataProvider
- Defined in ui/LineUp.ts:76

setHighlight

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

setSelection

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

sortBy

sortBy(column, ascending?): boolean
sorts LineUp by he given column
Parameters
- column: string | ((col) => 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, ...types): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- Rest ...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/LineUp.ts:70

Class LineUp

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LineUp

Properties

Readonly isBrowserSupported

Readonly node

Static Readonly EVENT_DIALOG_CLOSED

Static Readonly EVENT_DIALOG_OPENED

Static Readonly EVENT_HIGHLIGHT_CHANGED

Static Readonly EVENT_SELECTION_CHANGED

Accessors

data

Returns DataProvider

Methods

Protected addCopyListener

Returns void

Protected createEventList

Returns string[]

destroy

Returns void

dump

Returns IDataProviderDump

Protected enableHighlightListening

Parameters

Returns void

Protected fire

Parameters

Returns void

Protected forward

Parameters

Returns void

getHighlight

Returns number

getSelection

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

Parameters

Returns void

As Member Of

Group

Returns this

Parameters

Returns this

restore

Parameters

Returns void

setDataProvider

Parameters

Returns void

setHighlight

`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