Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Taggle

Hierarchy

  • ALineUp
    • Taggle

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Methods

Protected addCopyListener

  • addCopyListener(): void

Protected createEventList

  • createEventList(): string[]

destroy

  • destroy(): void

dump

Protected enableHighlightListening

  • enableHighlightListening(enable: boolean): void

Protected fire

  • fire(type: string | string[], ...args: any[]): void

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

getHighlight

  • getHighlight(): number

getSelection

  • getSelection(): number[]

isOverviewMode

  • isOverviewMode(): boolean

Protected listenersChanged

  • listenersChanged(type: string, enabled: boolean): void

  • Parameters

    • type: string
    • enabled: boolean

    Returns void

on

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

  • 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 Taggle

  • 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 Taggle

  • Parameters

    • type: "dialogOpened"
    • listener: (dialog: ADialog) => void

        • emitted a dialog is opened

          asmemberof

          ALineUp

          Parameters

          Returns void

    Returns Taggle

  • 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 Taggle

  • Parameters

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

    Returns Taggle

restore

setDataProvider

setHighlight

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

  • Parameters

    • dataIndex: number
    • scrollIntoView: boolean = true

    Returns boolean

setOverviewMode

  • setOverviewMode(overviewMode: boolean): void

setSelection

  • setSelection(dataIndices: number[]): void

  • Parameters

    • dataIndices: number[]

    Returns void

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

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

update

  • update(): void