Class NestedColumn

constructor

• new NestedColumn(id, desc): NestedColumn

• Parameters

  • id: string

  • desc: Readonly<IMultiLevelCompositeColumnDesc>

  Returns NestedColumn

Readonly desc

parent

Static Readonly COLLAPSED_RENDERER

Static Readonly EVENT_ADD_COLUMN

Static Readonly EVENT_COLLAPSE_CHANGED

Static Readonly EVENT_DIRTY

Static Readonly EVENT_DIRTY_CACHES

Static Readonly EVENT_DIRTY_HEADER

Static Readonly EVENT_DIRTY_VALUES

Static Readonly EVENT_FILTER_CHANGED

Static Readonly EVENT_GROUP_RENDERER_TYPE_CHANGED

Static Readonly EVENT_LABEL_CHANGED

Static Readonly EVENT_METADATA_CHANGED

Static Readonly EVENT_MOVE_COLUMN

Static Readonly EVENT_MULTI_LEVEL_CHANGED

Static Readonly EVENT_REMOVE_COLUMN

Static Readonly EVENT_RENDERER_TYPE_CHANGED

Static Readonly EVENT_SUMMARY_RENDERER_TYPE_CHANGED

Static Readonly EVENT_VISIBILITY_CHANGED

Static Readonly EVENT_WIDTH_CHANGED

Static Readonly FLAT_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): void

• Parameters

  • idGenerator: (() => string)

    • • (): string

      • Returns string

  Returns void

at

• at(index): Column

• Parameters

  • index: number

  Returns Column

attach

• attach(parent): 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): any

• dumps this column to JSON compatible format

  Parameters

  • toDescRef: ((desc) => any)

    helper mapping function

    • • (desc): any

      • Parameters

        • desc: any

        Returns any

  Returns any

  dump of this column

filter

• filter(row): 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, offset, levelsToGo?, padding?): 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

getCollapsed

• getCollapsed(): boolean

• Returns boolean

getColor

• getColor(_row): string

• Parameters

  • _row: IDataRow

  Returns string

getExportValue

• getExportValue(row, format): 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): {
      asHTML: boolean;
      content: string;
  }

• Parameters

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

  Returns {
      asHTML: boolean;
      content: string;
  }

  • 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, fallback?): {
      asHTML: boolean;
      content: string;
  }

• Parameters

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

  • fallback: boolean = false

  Returns {
      asHTML: boolean;
      content: string;
  }

  • asHTML: boolean

  • content: string

getSummaryRenderer

• getSummaryRenderer(): string

• Returns string

getVisible

• getVisible(): boolean

• Returns boolean

getWidth

• getWidth(): number

• Returns number

group

• group(_row, _valueCache?): 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?, priority?): boolean

• Parameters

  • ascending: boolean = ...

  • priority: number = 0

  Returns boolean

hide

• hide(): void

• Returns void

indexOf

• indexOf(col): number

• Parameters

  • col: Column

  Returns number

insert

• insert(col, index): Column

• inserts a column at a the given position

  Parameters

  • col: Column

  • index: number

  Returns Column

insertAfter

• insertAfter(col, ref): Column

• Parameters

  • col: Column

  • ref: Column

  Returns Column

insertAfterMe

• insertAfterMe(col): boolean

• inserts the given column after itself

  Parameters

  • col: Column

    the column to insert

  Returns boolean

  was successful

insertBefore

• insertBefore(col, ref): Column

• Parameters

  • col: Column

  • ref: Column

  Returns Column

insertBeforeMe

• insertBeforeMe(col): 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

isGroupSortedByMe

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

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

  • asc: "desc" | "asc"

  • priority: number

isGroupedBy

• isGroupedBy(): number

• Returns 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;
  }

  • asc: "desc" | "asc"

  • priority: number

isVisible

• isVisible(): boolean

• Returns boolean

markDirty

• markDirty(type?): 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, index): Column

• Parameters

  • col: Column

  • index: number

  Returns Column

moveAfter

• moveAfter(col, ref): Column

• Parameters

  • col: Column

  • ref: Column

  Returns Column

moveBefore

• moveBefore(col, ref): Column

• Parameters

  • col: Column

  • ref: Column

  Returns Column

nextSibling

• nextSibling(): Column

• returns the next sibling

  Returns Column

on

• on(type, listener): this

• Parameters

  • type: "collapseChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the collapse property changes

        Parameters

        • previous: boolean

        • current: boolean

        Returns void

        As Member Of

        MultiLevelCompositeColumn

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "nestedChildRatio"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the ratios between the children changes

        Parameters

        • previous: number

        • current: number

        Returns void

        As Member Of

        MultiLevelCompositeColumn

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "filterChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the filter property changes

        Parameters

        • previous: any

        • current: any

        Returns void

        As Member Of

        CompositeColumn

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "addColumn"

  • listener: ((col, index) => void)

    • • (col, index): void

      • emitted when a column has been added

        Parameters

        • col: Column

        • index: number

        Returns void

        As Member Of

        CompositeColumn

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "moveColumn"

  • listener: ((col, index, oldIndex) => void)

    • • (col, index, oldIndex): 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

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "removeColumn"

  • listener: ((col, index) => void)

    • • (col, index): void

      • emitted when a column has been removed

        Parameters

        • col: Column

        • index: number

        Returns void

        As Member Of

        CompositeColumn

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "widthChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the width property changes

        Parameters

        • previous: number

        • current: number

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "labelChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the label property changes

        Parameters

        • previous: string

        • current: string

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "metaDataChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the meta data property changes

        Parameters

        • previous: IColumnMetaData

        • current: IColumnMetaData

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "dirty"

  • listener: (() => void)

    • • (): void

      • emitted when state of the column is dirty

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): 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

        Group

        Events

  Returns this

• on(type, listener): 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

        Group

        Events

  Returns this

• on(type, listener): 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

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "rendererTypeChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the renderer type property changes

        Parameters

        • previous: string

        • current: string

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "groupRendererChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the group renderer property changes

        Parameters

        • previous: string

        • current: string

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "summaryRendererChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the pattern property changes

        Parameters

        • previous: string

        • current: string

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: "visibilityChanged"

  • listener: ((previous, current) => void)

    • • (previous, current): void

      • emitted when the visibility of this column changes

        Parameters

        • previous: boolean

        • current: boolean

        Returns void

        As Member Of

        Column

        Group

        Events

  Returns this

• on(type, listener): this

• Parameters

  • type: string | string[]

  • listener: IEventListener

  Returns this

previousSibling

• previousSibling(): Column

• returns the previous sibling

  Returns Column

push

• push(col): Column

• Parameters

  • col: Column

  Returns Column

remove

• remove(col): boolean

• Parameters

  • col: Column

  Returns boolean

removeImpl

• removeImpl(child, index): boolean

• Parameters

  • child: Column

  • index: number

  Returns boolean

removeMe

• removeMe(): boolean

• removes the column from the ranking

  Returns boolean

  was successful

restore

• restore(dump, factory): void

• restore the column content from a dump

  Parameters

  • dump: any

    column dump

  • factory: ITypeFactory

    helper for creating columns

  Returns void

setCollapsed

• setCollapsed(value): void

• Parameters

  • value: boolean

  Returns void

setGroupRenderer

• setGroupRenderer(renderer): void

• Parameters

  • renderer: string

  Returns void

setMetaData

• setMetaData(value): void

• Parameters

  • value: Readonly<IColumnMetaData>

  Returns void

setRenderer

• setRenderer(renderer): void

• Parameters

  • renderer: string

  Returns void

setSummaryRenderer

• setSummaryRenderer(renderer): void

• Parameters

  • renderer: string

  Returns void

setVisible

• setVisible(value): void

• Parameters

  • value: boolean

  Returns void

setWidth

• setWidth(value): void

• Parameters

  • value: number

  Returns void

setWidthImpl

• setWidthImpl(value): void

• Parameters

  • value: number

  Returns void

show

• show(): void

• Returns void

sortByMe

• sortByMe(ascending?, priority?): 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, group, _valueCache?): 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