Interface IMultiLevelColumn

implementation of a combine column, standard operations how to select

interface IMultiLevelColumn {
    _children: Column[];
    desc: Readonly<IColumnDesc>;
    parent: Readonly<IColumnParent>;
    get canJustAddNumbers(): boolean;
    get children(): Column[];
    get description(): string;
    get fixed(): boolean;
    get fqid(): string;
    get fqpath(): string;
    get frozen(): boolean;
    get id(): string;
    get label(): string;
    get length(): number;
    assignNewId(idGenerator: () => string): void;
    at(index: number): Column;
    attach(parent: IColumnParent): void;
    clearFilter(): boolean;
    createEventList(): string[];
    detach(): void;
    dump(toDescRef: (desc: any) => any): any;
    filter(row: IDataRow): boolean;
    findMyRanker(): Ranking;
    fire(type: string | string[], ...args: any[]): void;
    flatten(
        r: IFlatColumn[],
        offset: number,
        levelsToGo?: number,
        padding?: number,
    ): number;
    forward(from: IEventHandler, ...types: string[]): void;
    getCollapsed(): boolean;
    getColor(_row: IDataRow): string;
    getExportValue(row: IDataRow, format: "text" | "json"): any;
    getGroupRenderer(): string;
    getHeaderLabel(
        ctx: "header" | "sidePanel" | "reorder",
    ): { asHTML: boolean; content: string };
    getLabel(row: IDataRow): string;
    getMetaData(): Readonly<IColumnMetaData>;
    getRenderer(): string;
    getSummaryLabel(
        ctx: "header" | "sidePanel" | "reorder",
        fallback?: boolean,
    ): { asHTML: boolean; content: string };
    getSummaryRenderer(): string;
    getValue(_row: IDataRow): any;
    getVisible(): boolean;
    getWidth(): number;
    group(_row: IDataRow, _valueCache?: any): IGroup;
    groupByMe(): boolean;
    groupSortByMe(ascending?: boolean, priority?: number): boolean;
    hide(): void;
    indexOf(col: Column): number;
    insert(col: Column, index: number): Column;
    insertAfter(col: Column, ref: Column): Column;
    insertAfterMe(col: Column): boolean;
    insertBefore(col: Column, ref: Column): Column;
    insertBeforeMe(col: Column): boolean;
    insertImpl(col: Column, index: number): Column;
    isFiltered(): boolean;
    isGroupedBy(): number;
    isGroupSortedByMe(): { asc: "desc" | "asc"; priority: number };
    isLoaded(): boolean;
    isShowNestedSummaries(): boolean;
    isSortedByMe(): { asc: "desc" | "asc"; priority: number };
    isVisible(): boolean;
    listenersChanged(_type: string, _active: boolean): void;
    markDirty(type?: "values" | "all" | "header"): void;
    move(col: Column, index: number): Column;
    moveAfter(col: Column, ref: Column): Column;
    moveBefore(col: Column, ref: Column): Column;
    moveImpl(col: Column, index: number, oldIndex: number): Column;
    nextSibling(): Column;
    on(
        type: "filterChanged",
        listener: (previous: any, current: any) => void,
    ): this;
    on(type: "addColumn", listener: (col: Column, index: number) => void): this;
    on(
        type: "moveColumn",
        listener: (col: Column, index: number, oldIndex: number) => void,
    ): this;
    on(
        type: "removeColumn",
        listener: (col: Column, index: number) => void,
    ): this;
    on(
        type: "widthChanged",
        listener: (previous: number, current: number) => void,
    ): this;
    on(
        type: "labelChanged",
        listener: (previous: string, current: string) => void,
    ): this;
    on(
        type: "metaDataChanged",
        listener: (previous: IColumnMetaData, current: IColumnMetaData) => void,
    ): this;
    on(type: "dirty", listener: () => void): this;
    on(type: "dirtyHeader", listener: () => void): this;
    on(type: "dirtyValues", listener: () => void): this;
    on(type: "dirtyCaches", listener: () => void): this;
    on(
        type: "rendererTypeChanged",
        listener: (previous: string, current: string) => void,
    ): this;
    on(
        type: "groupRendererChanged",
        listener: (previous: string, current: string) => void,
    ): this;
    on(
        type: "summaryRendererChanged",
        listener: (previous: string, current: string) => void,
    ): this;
    on(
        type: "visibilityChanged",
        listener: (previous: boolean, current: boolean) => void,
    ): this;
    on(type: string | string[], listener: IEventListener): this;
    previousSibling(): Column;
    push(col: Column): Column;
    remove(col: Column): boolean;
    removeImpl(col: Column, index: number): boolean;
    removeMe(): boolean;
    restore(dump: any, factory: ITypeFactory): void;
    setCollapsed(value: boolean): void;
    setGroupRenderer(renderer: string): void;
    setMetaData(value: Readonly<IColumnMetaData>): 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;
    toCompareGroupValue(
        _rows: ISequence<IDataRow>,
        group: IGroup,
        _valueCache?: ISequence<any>,
    ): ICompareValue | ICompareValue[];
    toCompareGroupValueType(): ECompareValueType | ECompareValueType[];
    toCompareValue(
        _row: IDataRow,
        _valueCache?: any,
    ): ICompareValue | ICompareValue[];
    toCompareValueType(): ECompareValueType | ECompareValueType[];
    toggleMyGroupSorting(): boolean;
    toggleMySorting(): boolean;
    unforward(from: IEventHandler, ...types: string[]): void;
}

Hierarchy (View Summary)

Implemented by

Properties

_children desc parent

Accessors

canJustAddNumbers children description fixed fqid fqpath frozen id label length

Methods

assignNewId at attach clearFilter createEventList detach dump filter findMyRanker fire flatten forward getCollapsed getColor getExportValue getGroupRenderer getHeaderLabel getLabel getMetaData getRenderer getSummaryLabel getSummaryRenderer getValue getVisible getWidth group groupByMe groupSortByMe hide indexOf insert insertAfter insertAfterMe insertBefore insertBeforeMe insertImpl isFiltered isGroupedBy isGroupSortedByMe isLoaded isShowNestedSummaries isSortedByMe isVisible listenersChanged markDirty move moveAfter moveBefore moveImpl nextSibling on previousSibling push remove removeImpl removeMe restore setCollapsed setGroupRenderer setMetaData setRenderer setSummaryRenderer setVisible setWidth setWidthImpl show sortByMe toCompareGroupValue toCompareGroupValueType toCompareValue toCompareValueType toggleMyGroupSorting toggleMySorting unforward

Properties

Protected Readonly_children

_children: Column[] = []

Readonlydesc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> = null

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

Accessors

canJustAddNumbers

children

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

label

  • get label(): string

  • Returns string

length

Methods

assignNewId

at

attach

clearFilter

ProtectedcreateEventList

detach

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

findMyRanker

Protectedfire

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

Protectedforward

  • 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

    • ...types: string[]

      the event types to forward

    Returns void

getCollapsed

getColor

getExportValue

getGroupRenderer

getHeaderLabel

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

  • Parameters

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

    Returns { asHTML: boolean; content: string }

getLabel

getMetaData

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

getValue

getVisible

getWidth

group

groupByMe

groupSortByMe

hide

indexOf

insert

insertAfter

insertAfterMe

insertBefore

insertBeforeMe

ProtectedinsertImpl

isFiltered

isGroupedBy

isGroupSortedByMe

isLoaded

isShowNestedSummaries

  • isShowNestedSummaries(): boolean

  • whether to show nested summaries or not

    Returns boolean

isSortedByMe

isVisible

ProtectedlistenersChanged

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

moveAfter

moveBefore

ProtectedmoveImpl

nextSibling

on

  • 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

          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

          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

    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

    Returns this

previousSibling

push

remove

ProtectedremoveImpl

removeMe

restore

setCollapsed

setGroupRenderer

setMetaData

setRenderer

setSummaryRenderer

setVisible

setWidth

setWidthImpl

show

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

toCompareGroupValueType

toCompareValue

toCompareValueType

toggleMyGroupSorting

toggleMySorting

Protectedunforward

Settings

Member Visibility

On This Page

Properties
Accessors
Methods