Class LineUp

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

Hierarchy (view full)

Constructors

Properties

isBrowserSupported: boolean
node: HTMLElement
EVENT_DIALOG_CLOSED: "dialogClosed" = ALineUp.EVENT_DIALOG_CLOSED
EVENT_DIALOG_OPENED: "dialogOpened" = ALineUp.EVENT_DIALOG_OPENED
EVENT_HIGHLIGHT_CHANGED: "highlightChanged" = ALineUp.EVENT_HIGHLIGHT_CHANGED
EVENT_SELECTION_CHANGED: "selectionChanged" = ALineUp.EVENT_SELECTION_CHANGED

Accessors

Methods

  • 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

  • helper function that will be called upon a listener has changed

    Parameters

    • type: string

      event type

    • enabled: boolean

      registered or de registered

    Returns void

  • 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

  • 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

  • Parameters

    • type: "dialogOpened"
    • listener: ((dialog) => void)
        • (dialog): void
        • emitted a dialog is opened

          Parameters

          Returns void

          As Member Of

          ALineUp

          Group

          Events

    Returns 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

  • Parameters

    Returns this

  • Parameters

    • dataIndex: number
    • scrollIntoView: boolean = true

    Returns boolean

  • sorts LineUp by he given column

    Parameters

    • column: string | ((col) => boolean)

      callback function finding the column to sort

    • ascending: boolean = false

    Returns boolean