Options
All
  • Public
  • Public/Protected
  • All
Menu

a column in LineUp

Hierarchy

Index

Constructors

Properties

desc: Readonly<IColumnDesc>
parent: Readonly<IColumnParent> = null

parent column of this column, set when added to a ranking or combined column

EVENT_DIRTY: "dirty" = 'dirty'
EVENT_DIRTY_CACHES: "dirtyCaches" = 'dirtyCaches'
EVENT_DIRTY_HEADER: "dirtyHeader" = 'dirtyHeader'
EVENT_DIRTY_VALUES: "dirtyValues" = 'dirtyValues'
EVENT_GROUP_RENDERER_TYPE_CHANGED: "groupRendererChanged" = 'groupRendererChanged'
EVENT_LABEL_CHANGED: "labelChanged" = 'labelChanged'
EVENT_METADATA_CHANGED: "metaDataChanged" = 'metaDataChanged'
EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = 'rendererTypeChanged'
EVENT_SUMMARY_RENDERER_TYPE_CHANGED: "summaryRendererChanged" = 'summaryRendererChanged'
EVENT_VISIBILITY_CHANGED: "visibilityChanged" = 'visibilityChanged'
EVENT_WIDTH_CHANGED: "widthChanged" = 'widthChanged'
FLAT_ALL_COLUMNS: -1 = -1

magic variable for showing all columns

Accessors

  • get description(): string
  • get fixed(): boolean
  • get fqid(): string
  • get fqpath(): string
  • get frozen(): boolean
  • get id(): string
  • get label(): string

Methods

  • assignNewId(idGenerator: () => string): void
  • clearFilter(): boolean
  • createEventList(): string[]
  • detach(): void
  • dump(toDescRef: (desc: any) => any): any
  • dumps this column to JSON compatible format

    Parameters

    • toDescRef: (desc: any) => any

      helper mapping function

        • (desc: any): any
        • Parameters

          • desc: any

          Returns any

    Returns any

    dump of this column

  • filter(row: IDataRow, _valueCache?: any): boolean
  • fire(type: string | string[], ...args: any[]): void
  • flatten(r: IFlatColumn[], offset: number, _levelsToGo?: number, _padding?: number): number
  • visitor pattern for flattening the columns

    Parameters

    • r: IFlatColumn[]

      the result array

    • offset: number

      left offset

    • _levelsToGo: number = 0

      how many levels down

    • _padding: number = 0

      padding between columns

    Returns number

    the used width by this column

  • 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

  • getExportValue(row: IDataRow, format: "text" | "json"): any
  • getGroupRenderer(): string
  • return the label of a given row for the current column

    Parameters

    Returns string

    the label of this column at the specified row

  • getRenderer(): string
  • determines the renderer type that should be used to render this column. By default the same type as the column itself

    Returns string

  • getSummaryRenderer(): string
  • return the value of a given row for the current column

    Parameters

    Returns any

    the value of this column at the specified row

  • getVisible(): boolean
  • getWidth(): number
  • groupByMe(): boolean
  • groupSortByMe(ascending?: boolean, priority?: number): boolean
  • hide(): void
  • insertAfterMe(col: Column): boolean
  • inserts the given column after itself

    Parameters

    • col: Column

      the column to insert

    Returns boolean

    was successful

  • insertBeforeMe(col: Column): boolean
  • inserts the given column before itself

    Parameters

    • col: Column

      the column to insert

    Returns boolean

    was successful

  • isFiltered(): boolean
  • isGroupSortedByMe(): { asc: "asc" | "desc"; priority: number }
  • Returns { asc: "asc" | "desc"; priority: number }

    • asc: "asc" | "desc"
    • priority: number
  • isGroupedBy(): number
  • isSortedByMe(): { asc: "asc" | "desc"; priority: number }
  • Returns { asc: "asc" | "desc"; priority: number }

    • asc: "asc" | "desc"
    • priority: number
  • isVisible(): boolean
  • listenersChanged(_type: string, _active: boolean): void
  • helper function that will be called upon a listener has changed

    Parameters

    • _type: string

      event type

    • _active: boolean

      registered or de registered

    Returns void

  • markDirty(type?: "header" | "values" | "all"): void
  • marks the header, values, or both as dirty such that the values are reevaluated

    Parameters

    • type: "header" | "values" | "all" = 'all'

      specify in more detail what is dirty, by default whole column

    Returns void

  • on(type: "widthChanged", listener: (previous: number, current: number) => void): Column
  • on(type: "labelChanged", listener: (previous: string, current: string) => void): Column
  • on(type: "metaDataChanged", listener: (previous: IColumnMetaData, current: IColumnMetaData) => void): Column
  • on(type: "dirty", listener: () => void): Column
  • on(type: "dirtyHeader", listener: () => void): Column
  • on(type: "dirtyValues", listener: () => void): Column
  • on(type: "dirtyCaches", listener: () => void): Column
  • on(type: "rendererTypeChanged", listener: (previous: string, current: string) => void): Column
  • on(type: "groupRendererChanged", listener: (previous: string, current: string) => void): Column
  • on(type: "summaryRendererChanged", listener: (previous: string, current: string) => void): Column
  • on(type: "visibilityChanged", listener: (previous: boolean, current: boolean) => void): Column
  • on(type: string | string[], listener: IEventListener): Column
  • Parameters

    • type: "widthChanged"
    • listener: (previous: number, current: number) => void
        • (previous: number, current: number): void
        • emitted when the width property changes

          asmemberof

          Column

          Parameters

          • previous: number
          • current: number

          Returns void

    Returns Column

  • Parameters

    • type: "labelChanged"
    • listener: (previous: string, current: string) => void
        • (previous: string, current: string): void
        • emitted when the label property changes

          asmemberof

          Column

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns Column

  • Parameters

    Returns Column

  • Parameters

    • type: "dirty"
    • listener: () => void
        • (): void
        • emitted when state of the column is dirty

          asmemberof

          Column

          Returns void

    Returns Column

  • Parameters

    • type: "dirtyHeader"
    • listener: () => void
        • (): void
        • emitted when state of the column related to its header is dirty

          asmemberof

          Column

          Returns void

    Returns Column

  • Parameters

    • type: "dirtyValues"
    • listener: () => void
        • (): void
        • emitted when state of the column related to its values is dirty

          asmemberof

          Column

          Returns void

    Returns Column

  • Parameters

    • type: "dirtyCaches"
    • listener: () => void
        • (): void
        • emitted when state of the column related to cached values (hist, compare, ...) is dirty

          asmemberof

          Column

          Returns void

    Returns Column

  • Parameters

    • type: "rendererTypeChanged"
    • listener: (previous: string, current: string) => void
        • (previous: string, current: string): void
        • emitted when the renderer type property changes

          asmemberof

          Column

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns Column

  • Parameters

    • type: "groupRendererChanged"
    • listener: (previous: string, current: string) => void
        • (previous: string, current: string): void
        • emitted when the group renderer property changes

          asmemberof

          Column

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns Column

  • Parameters

    • type: "summaryRendererChanged"
    • listener: (previous: string, current: string) => void
        • (previous: string, current: string): void
        • emitted when the pattern property changes

          asmemberof

          Column

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns Column

  • Parameters

    • type: "visibilityChanged"
    • listener: (previous: boolean, current: boolean) => void
        • (previous: boolean, current: boolean): void
        • emitted when the visibility of this column changes

          asmemberof

          Column

          Parameters

          • previous: boolean
          • current: boolean

          Returns void

    Returns Column

  • Parameters

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

    Returns Column

  • removeMe(): boolean
  • setGroupRenderer(renderer: string): void
  • setRenderer(renderer: string): void
  • setSummaryRenderer(renderer: string): void
  • setVisible(value: boolean): void
  • setWidth(value: number): void
  • setWidthImpl(value: number): void
  • show(): void
  • sortByMe(ascending?: boolean, priority?: number): boolean
  • triggers that the ranking is sorted by this column

    Parameters

    • ascending: boolean = ...

      ascending order?

    • priority: number = 0

      sorting priority

    Returns boolean

    was successful

  • toggleMyGroupSorting(): boolean
  • toggleMySorting(): boolean
  • toggles the sorting order of this column in the ranking

    Returns boolean

    was successful

  • 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