Interface IMultiLevelColumn

implementation of a combine column, standard operations how to select

Hierarchy

Implemented by

Properties

_children: Column[] = []
desc: Readonly<IColumnDesc>
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 id(): string
  • Returns string

  • 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

  • whether to show nested summaries or not

    Returns boolean

  • 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

  • triggers that the ranking is sorted by this column

    Returns

    was successful

    Parameters

    • ascending: boolean = ...

      ascending order?

    • priority: number = 0

      sorting priority

    Returns boolean