Interface IDatesColumn

a column in LineUp

Hierarchy

Implemented by

Properties

dataLength: number
desc: Readonly<IColumnDesc>
labels: string[]
parent: Readonly<IColumnParent> = null

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

Accessors

  • get description(): string
  • Returns string

  • get fixed(): boolean
  • Returns boolean

  • get fqid(): string
  • returns the fully qualified id i.e. path the parent

    Returns

    Returns string

  • get fqpath(): string
  • Returns string

  • get frozen(): boolean
  • Returns boolean

  • get label(): string
  • Returns string

Methods

  • dumps this column to JSON compatible format

    Returns

    dump of this column

    Parameters

    • toDescRef: ((desc: any) => any)

      helper mapping function

        • (desc: any): any
        • Parameters

          • desc: any

          Returns any

    Returns any

  • visitor pattern for flattening the columns

    Returns

    the used width by this column

    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

  • 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

  • determines the renderer type that should be used to render this column. By default the same type as the column itself

    Returns

    Returns string

  • Returns { asc: "desc" | "asc"; priority: number }

    • asc: "desc" | "asc"
    • priority: number
  • helper function that will be called upon a listener has changed

    Parameters

    • _type: string

      event type

    • _active: boolean

      registered or de registered

    Returns void

  • marks the header, values, or both as dirty such that the values are reevaluated

    Parameters

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

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

    Returns void

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Parameters

          • previous: number
          • current: number

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns IDatesColumn

  • Parameters

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns IDatesColumn

  • Parameters

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

          As Member Of

          Column

          Group

          Events

          Parameters

          • previous: boolean
          • current: boolean

          Returns void

    Returns IDatesColumn

  • Parameters

    Returns IDatesColumn

  • triggers that the ranking is sorted by this column

    Returns

    was successful

    Parameters

    • ascending: boolean = ...

      ascending order?

    • priority: number = 0

      sorting priority

    Returns boolean