Class NestedColumn

Readonlydesc

parent

Static ReadonlyCOLLAPSED_RENDERER

Static ReadonlyEVENT_ADD_COLUMN

Static ReadonlyEVENT_COLLAPSE_CHANGED

Static ReadonlyEVENT_DIRTY

Static ReadonlyEVENT_DIRTY_CACHES

Static ReadonlyEVENT_DIRTY_HEADER

Static ReadonlyEVENT_DIRTY_VALUES

Static ReadonlyEVENT_FILTER_CHANGED

Static ReadonlyEVENT_GROUP_RENDERER_TYPE_CHANGED

Static ReadonlyEVENT_LABEL_CHANGED

Static ReadonlyEVENT_METADATA_CHANGED

Static ReadonlyEVENT_MOVE_COLUMN

Static ReadonlyEVENT_MULTI_LEVEL_CHANGED

Static ReadonlyEVENT_REMOVE_COLUMN

Static ReadonlyEVENT_RENDERER_TYPE_CHANGED

Static ReadonlyEVENT_SUMMARY_RENDERER_TYPE_CHANGED

Static ReadonlyEVENT_VISIBILITY_CHANGED

Static ReadonlyEVENT_WIDTH_CHANGED

Static ReadonlyFLAT_ALL_COLUMNS

canJustAddNumbers

• get canJustAddNumbers(): boolean

• Returns boolean

children

• get children(): Column[]

• Returns Column[]

description

• get description(): string

• Returns string

fixed

• get fixed(): boolean

• Returns boolean

fqid

• get fqid(): string

• returns the fully qualified id i.e. path the parent

  Returns string

fqpath

• get fqpath(): string

• Returns string

frozen

• get frozen(): boolean

• Returns boolean

id

• get id(): string

• Returns string

label

• get label(): string

• Returns string

length

• get length(): number

• Returns number

assignNewId

• assignNewId(idGenerator: () => string): void

• Parameters

  • idGenerator: () => string

  Returns void

at

• at(index: number): Column

• Parameters

  • index: number

  Returns Column

attach

• attach(parent: IColumnParent): void

• called when the columns added to a ranking

  Parameters

  • parent: IColumnParent

  Returns void

clearFilter

• clearFilter(): boolean

• clear the filter

  Returns boolean

  whether the filtered needed to be reset

detach

• detach(): void

• called when the column is removed from the ranking

  Returns void

dump

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

• dumps this column to JSON compatible format

  Parameters

  • toDescRef: (desc: any) => any

    helper mapping function

  Returns any

  dump of this column

filter

• filter(row: IDataRow): boolean

• predicate whether the current row should be included

  Parameters

  • row: IDataRow

  Returns boolean

findMyRanker

• findMyRanker(): Ranking

• finds the underlying ranking column

  Returns Ranking

  my current ranking

flatten

• 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
  • padding: number = 0

  Returns number

  the used width by this column

getCollapsed

• getCollapsed(): boolean

• Returns boolean

getColor

• getColor(_row: IDataRow): string

• Parameters

  • _row: IDataRow

  Returns string

getExportValue

• getExportValue(row: IDataRow, format: "text" | "json"): any

• returns the value to be used when exporting

  Parameters

  • row: IDataRow
  • format: "text" | "json"

    format hint

  Returns any

getGroupRenderer

• getGroupRenderer(): string

• Returns string

getHeaderLabel

• getHeaderLabel(
      ctx: "header" | "sidePanel" | "reorder",
  ): { asHTML: boolean; content: string }

• Parameters

  • ctx: "header" | "sidePanel" | "reorder"

  Returns { asHTML: boolean; content: string }

getMetaData

• getMetaData(): Readonly<IColumnMetaData>

• Returns Readonly<IColumnMetaData>

getRenderer

• 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

getSummaryLabel

• getSummaryLabel(
      ctx: "header" | "sidePanel" | "reorder",
      fallback?: boolean,
  ): { asHTML: boolean; content: string }

• Parameters

  • ctx: "header" | "sidePanel" | "reorder"
  • fallback: boolean = false

  Returns { asHTML: boolean; content: string }

getSummaryRenderer

• getSummaryRenderer(): string

• Returns string

getVisible

• getVisible(): boolean

• Returns boolean

getWidth

• getWidth(): number

• Returns number

group

• group(_row: IDataRow, _valueCache?: any): IGroup

• group the given row into a bin/group

  Parameters

  • _row: IDataRow
  • Optional_valueCache: any

  Returns IGroup

groupByMe

• groupByMe(): boolean

• Returns boolean

groupSortByMe

• groupSortByMe(ascending?: boolean, priority?: number): boolean

• Parameters

  • ascending: boolean = ...
  • priority: number = 0

  Returns boolean

hide

• hide(): void

• Returns void

indexOf

• indexOf(col: Column): number

• Parameters

  • col: Column

  Returns number

insert

• insert(col: Column, index: number): Column

• inserts a column at a the given position

  Parameters

  • col: Column
  • index: number

  Returns Column

insertAfter

• insertAfter(col: Column, ref: Column): Column

• Parameters

  • col: Column
  • ref: Column

  Returns Column

insertAfterMe

• insertAfterMe(col: Column): boolean

• inserts the given column after itself

  Parameters

  • col: Column

    the column to insert

  Returns boolean

  was successful

insertBefore

• insertBefore(col: Column, ref: Column): Column

• Parameters

  • col: Column
  • ref: Column

  Returns Column

insertBeforeMe

• insertBeforeMe(col: Column): boolean

• inserts the given column before itself

  Parameters

  • col: Column

    the column to insert

  Returns boolean

  was successful

isFiltered

• isFiltered(): boolean

• flag whether any filter is applied

  Returns boolean

isGroupedBy

• isGroupedBy(): number

• Returns number

isGroupSortedByMe

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

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

isLoaded

• isLoaded(): boolean

• Returns boolean

isShowNestedSummaries

• isShowNestedSummaries(): boolean

• whether to show nested summaries or not

  Returns boolean

isSortedByMe

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

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

isVisible

• isVisible(): boolean

• Returns boolean

markDirty

• markDirty(type?: "values" | "all" | "header"): 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

move

• move(col: Column, index: number): Column

• Parameters

  • col: Column
  • index: number

  Returns Column

moveAfter

• moveAfter(col: Column, ref: Column): Column

• Parameters

  • col: Column
  • ref: Column

  Returns Column

moveBefore

• moveBefore(col: Column, ref: Column): Column

• Parameters

  • col: Column
  • ref: Column

  Returns Column

nextSibling

• nextSibling(): Column

• returns the next sibling

  Returns Column

on

• on(
      type: "collapseChanged",
      listener: (previous: boolean, current: boolean) => void,
  ): this

• Parameters

  • type: "collapseChanged"
  • listener: (previous: boolean, current: boolean) => void
    • • (previous: boolean, current: boolean): void

      • emitted when the collapse property changes

        Parameters

        • previous: boolean
        • current: boolean

        Returns void

        As Member Of

        MultiLevelCompositeColumn

  Returns this

• on(
      type: "nestedChildRatio",
      listener: (previous: number, current: number) => void,
  ): this

• Parameters

  • type: "nestedChildRatio"
  • listener: (previous: number, current: number) => void
    • • (previous: number, current: number): void

      • emitted when the ratios between the children changes

        Parameters

        • previous: number
        • current: number

        Returns void

        As Member Of

        MultiLevelCompositeColumn

  Returns this

• on(type: "filterChanged", listener: (previous: any, current: any) => void): this

• Parameters

  • type: "filterChanged"
  • listener: (previous: any, current: any) => void
    • • (previous: any, current: any): void

      • emitted when the filter property changes

        Parameters

        • previous: any
        • current: any

        Returns void

        As Member Of

        CompositeColumn

  Returns this

• on(type: "addColumn", listener: (col: Column, index: number) => void): this

• Parameters

  • type: "addColumn"
  • listener: (col: Column, index: number) => void
    • • (col: Column, index: number): void

      • emitted when a column has been added

        Parameters

        • col: Column
        • index: number

        Returns void

        As Member Of

        CompositeColumn

  Returns this

• on(
      type: "moveColumn",
      listener: (col: Column, index: number, oldIndex: number) => void,
  ): this

• Parameters

  • type: "moveColumn"
  • listener: (col: Column, index: number, oldIndex: number) => void
    • • (col: Column, index: number, oldIndex: number): void

      • emitted when a column has been moved within this composite columm

        Parameters

        • col: Column
        • index: number
        • oldIndex: number

        Returns void

        As Member Of

        CompositeColumn

  Returns this

• on(type: "removeColumn", listener: (col: Column, index: number) => void): this

• Parameters

  • type: "removeColumn"
  • listener: (col: Column, index: number) => void
    • • (col: Column, index: number): void

      • emitted when a column has been removed

        Parameters

        • col: Column
        • index: number

        Returns void

        As Member Of

        CompositeColumn

  Returns this

• on(
      type: "widthChanged",
      listener: (previous: number, current: number) => void,
  ): this

• Parameters

  • type: "widthChanged"
  • listener: (previous: number, current: number) => void
    • • (previous: number, current: number): void

      • emitted when the width property changes

        Parameters

        • previous: number
        • current: number

        Returns void

        As Member Of

        Column

  Returns this

• on(
      type: "labelChanged",
      listener: (previous: string, current: string) => void,
  ): this

• Parameters

  • type: "labelChanged"
  • listener: (previous: string, current: string) => void
    • • (previous: string, current: string): void

      • emitted when the label property changes

        Parameters

        • previous: string
        • current: string

        Returns void

        As Member Of

        Column

  Returns this

• on(
      type: "metaDataChanged",
      listener: (previous: IColumnMetaData, current: IColumnMetaData) => void,
  ): this

• Parameters

  • type: "metaDataChanged"
  • listener: (previous: IColumnMetaData, current: IColumnMetaData) => void
    • • (previous: IColumnMetaData, current: IColumnMetaData): void

      • emitted when the meta data property changes

        Parameters

        • previous: IColumnMetaData
        • current: IColumnMetaData

        Returns void

        As Member Of

        Column

  Returns this

• on(type: "dirty", listener: () => void): this

• Parameters

  • type: "dirty"
  • listener: () => void
    • • (): void

      • emitted when state of the column is dirty

        Returns void

        As Member Of

        Column

  Returns this

• on(type: "dirtyHeader", listener: () => void): this

• Parameters

  • type: "dirtyHeader"
  • listener: () => void
    • • (): void

      • emitted when state of the column related to its header is dirty

        Returns void

        As Member Of

        Column

  Returns this

• on(type: "dirtyValues", listener: () => void): this

• Parameters

  • type: "dirtyValues"
  • listener: () => void
    • • (): void

      • emitted when state of the column related to its values is dirty

        Returns void

        As Member Of

        Column

  Returns this

• on(type: "dirtyCaches", listener: () => void): this

• Parameters

  • type: "dirtyCaches"
  • listener: () => void
    • • (): void

      • emitted when state of the column related to cached values (hist, compare, ...) is dirty

        Returns void

        As Member Of

        Column

  Returns this

• on(
      type: "rendererTypeChanged",
      listener: (previous: string, current: string) => void,
  ): this

• Parameters

  • type: "rendererTypeChanged"
  • listener: (previous: string, current: string) => void
    • • (previous: string, current: string): void

      • emitted when the renderer type property changes

        Parameters

        • previous: string
        • current: string

        Returns void

        As Member Of

        Column

  Returns this

• on(
      type: "groupRendererChanged",
      listener: (previous: string, current: string) => void,
  ): this

• Parameters

  • type: "groupRendererChanged"
  • listener: (previous: string, current: string) => void
    • • (previous: string, current: string): void

      • emitted when the group renderer property changes

        Parameters

        • previous: string
        • current: string

        Returns void

        As Member Of

        Column

  Returns this

• on(
      type: "summaryRendererChanged",
      listener: (previous: string, current: string) => void,
  ): this

• Parameters

  • type: "summaryRendererChanged"
  • listener: (previous: string, current: string) => void
    • • (previous: string, current: string): void

      • emitted when the pattern property changes

        Parameters

        • previous: string
        • current: string

        Returns void

        As Member Of

        Column

  Returns this

• on(
      type: "visibilityChanged",
      listener: (previous: boolean, current: boolean) => void,
  ): this

• Parameters

  • type: "visibilityChanged"
  • listener: (previous: boolean, current: boolean) => void
    • • (previous: boolean, current: boolean): void

      • emitted when the visibility of this column changes

        Parameters

        • previous: boolean
        • current: boolean

        Returns void

        As Member Of

        Column

  Returns this

• on(type: string | string[], listener: IEventListener): this

• Parameters

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

  Returns this

previousSibling

• previousSibling(): Column

• returns the previous sibling

  Returns Column

push

• push(col: Column): Column

• Parameters

  • col: Column

  Returns Column

remove

• remove(col: Column): boolean

• Parameters

  • col: Column

  Returns boolean

removeImpl

• removeImpl(child: Column, index: number): boolean

• Parameters

  • child: Column
  • index: number

  Returns boolean

removeMe

• removeMe(): boolean

• removes the column from the ranking

  Returns boolean

  was successful

restore

• restore(dump: any, factory: ITypeFactory): void

• restore the column content from a dump

  Parameters

  • dump: any

    column dump
  • factory: ITypeFactory

  Returns void

setCollapsed

• setCollapsed(value: boolean): void

• Parameters

  • value: boolean

  Returns void

setGroupRenderer

• setGroupRenderer(renderer: string): void

• Parameters

  • renderer: string

  Returns void

setMetaData

• setMetaData(value: Readonly<IColumnMetaData>): void

• Parameters

  • value: Readonly<IColumnMetaData>

  Returns void

setRenderer

• setRenderer(renderer: string): void

• Parameters

  • renderer: string

  Returns void

setSummaryRenderer

• setSummaryRenderer(renderer: string): void

• Parameters

  • renderer: string

  Returns void

setVisible

• setVisible(value: boolean): void

• Parameters

  • value: boolean

  Returns void

setWidth

• setWidth(value: number): void

• Parameters

  • value: number

  Returns void

setWidthImpl

• setWidthImpl(value: number): void

• Parameters

  • value: number

  Returns void

show

• show(): void

• Returns void

sortByMe

• 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

toCompareGroupValue

• toCompareGroupValue(
      _rows: ISequence<IDataRow>,
      group: IGroup,
      _valueCache?: ISequence<any>,
  ): ICompareValue | ICompareValue[]

• Parameters

  • _rows: ISequence<IDataRow>
  • group: IGroup
  • Optional_valueCache: ISequence<any>

  Returns ICompareValue | ICompareValue[]

toCompareGroupValueType

• toCompareGroupValueType(): ECompareValueType | ECompareValueType[]

• Returns ECompareValueType | ECompareValueType[]

toggleMyGroupSorting

• toggleMyGroupSorting(): boolean

• Returns boolean

toggleMySorting

• toggleMySorting(): boolean

• toggles the sorting order of this column in the ranking

  Returns boolean

  was successful