Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ALineUp
    • LineUp

Index

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

  • addCopyListener(): void
  • createEventList(): string[]
  • destroy(): void
  • enableHighlightListening(enable: boolean): void
  • Parameters

    • enable: boolean

    Returns void

  • fire(type: string | string[], ...args: any[]): void
  • 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

  • getHighlight(): number
  • getSelection(): number[]
  • listenersChanged(type: string, enabled: boolean): void
  • Parameters

    • type: string
    • enabled: boolean

    Returns void

  • on(type: "highlightChanged", listener: (dataIndex: number) => void): LineUp
  • on(type: "selectionChanged", listener: (dataIndices: number[]) => void): LineUp
  • on(type: "dialogOpened", listener: (dialog: ADialog) => void): LineUp
  • on(type: "dialogClosed", listener: (dialog: ADialog, action: "cancel" | "confirm") => void): LineUp
  • on(type: string | string[], listener: IEventListener): LineUp
  • Parameters

    • type: "highlightChanged"
    • listener: (dataIndex: number) => void
        • (dataIndex: number): void
        • emitted when the highlight changes

          asmemberof

          ALineUp

          Parameters

          • dataIndex: number

            the highlighted data index or -1 for none

          Returns void

    Returns LineUp

  • Parameters

    • type: "selectionChanged"
    • listener: (dataIndices: number[]) => void
        • (dataIndices: number[]): void
        • emitted when the selection changes

          asmemberof

          ALineUp

          Parameters

          • dataIndices: number[]

            the selected data indices

          Returns void

    Returns LineUp

  • Parameters

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

          asmemberof

          ALineUp

          Parameters

          Returns void

    Returns LineUp

  • Parameters

    • type: "dialogClosed"
    • listener: (dialog: ADialog, action: "cancel" | "confirm") => void
        • (dialog: ADialog, action: "cancel" | "confirm"): void
        • emitted a dialog is closed

          asmemberof

          ALineUp

          Parameters

          • dialog: ADialog

            the closed dialog

          • action: "cancel" | "confirm"

            the action how the dialog was closed

          Returns void

    Returns LineUp

  • Parameters

    • type: string | string[]
    • listener: IEventListener

    Returns LineUp

  • setHighlight(dataIndex: number, scrollIntoView?: boolean): boolean
  • Parameters

    • dataIndex: number
    • scrollIntoView: boolean = true

    Returns boolean

  • setSelection(dataIndices: number[]): void
  • Parameters

    • dataIndices: number[]

    Returns void

  • 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

  • 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

  • update(): void