Interface IMapAbleColumn

a column in LineUp

interface IMapAbleColumn {
    desc: Readonly<IColumnDesc>;
    parent: Readonly<IColumnParent>;
    get description(): string;
    get fixed(): boolean;
    get fqid(): string;
    get fqpath(): string;
    get frozen(): boolean;
    get id(): string;
    get label(): string;
    assignNewId(idGenerator): void;
    attach(parent): void;
    clearFilter(): boolean;
    createEventList(): string[];
    detach(): void;
    dump(toDescRef): any;
    filter(row, _valueCache?): boolean;
    findMyRanker(): Ranking;
    fire(type, ...args): void;
    flatten(r, offset, _levelsToGo?, _padding?): number;
    forward(from, ...types): void;
    getColor(_row): string;
    getColorMapping(): IColorMappingFunction;
    getExportValue(row, format): any;
    getFilter(): INumberFilter;
    getGroupRenderer(): string;
    getHeaderLabel(ctx): {
        asHTML: boolean;
        content: string;
    };
    getLabel(row): string;
    getMapping(): IMappingFunction;
    getMetaData(): Readonly<IColumnMetaData>;
    getNumber(row): number;
    getNumberFormat(): ((v) => string);
    getOriginalMapping(): IMappingFunction;
    getRange(): [string, string];
    getRawNumber(row): number;
    getRenderer(): string;
    getSummaryLabel(ctx, fallback?): {
        asHTML: boolean;
        content: string;
    };
    getSummaryRenderer(): string;
    getValue(_row): any;
    getVisible(): boolean;
    getWidth(): number;
    group(_row, _valueCache?): IGroup;
    groupByMe(): boolean;
    groupSortByMe(ascending?, priority?): boolean;
    hide(): void;
    insertAfterMe(col): boolean;
    insertBeforeMe(col): boolean;
    isFiltered(): boolean;
    isGroupSortedByMe(): {
        asc: "desc" | "asc";
        priority: number;
    };
    isGroupedBy(): number;
    isSortedByMe(): {
        asc: "desc" | "asc";
        priority: number;
    };
    isVisible(): boolean;
    iterNumber(row): IForEachAble<number>;
    iterRawNumber(row): IForEachAble<number>;
    listenersChanged(_type, _active): void;
    markDirty(type?): void;
    nextSibling(): Column;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    on(type, listener): this;
    previousSibling(): Column;
    removeMe(): boolean;
    restore(dump, _factory): void;
    setColorMapping(mapping): void;
    setFilter(value): void;
    setGroupRenderer(renderer): void;
    setMapping(mapping): void;
    setMetaData(value): void;
    setRenderer(renderer): void;
    setSummaryRenderer(renderer): void;
    setVisible(value): void;
    setWidth(value): void;
    setWidthImpl(value): void;
    show(): void;
    sortByMe(ascending?, priority?): boolean;
    toCompareGroupValue(_rows, group, _valueCache?): ICompareValue | ICompareValue[];
    toCompareGroupValueType(): ECompareValueType | ECompareValueType[];
    toCompareValue(_row, _valueCache?): ICompareValue | ICompareValue[];
    toCompareValueType(): ECompareValueType | ECompareValueType[];
    toggleMyGroupSorting(): boolean;
    toggleMySorting(): boolean;
    unforward(from, ...types): void;
}

Hierarchy (view full)

Implemented by

Properties

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 string

  • get fqpath(): string
  • Returns string

  • get frozen(): boolean
  • Returns boolean

  • get label(): string
  • Returns string

Methods

  • 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

  • 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

  • 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

  • Parameters

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

    Returns {
        asHTML: boolean;
        content: string;
    }

    • asHTML: boolean
    • content: string
  • return the label of a given row for the current column

    Parameters

    Returns string

    the label of this column at the specified row

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

    Returns string

  • Parameters

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

    Returns {
        asHTML: boolean;
        content: string;
    }

    • asHTML: boolean
    • content: string
  • Returns {
        asc: "desc" | "asc";
        priority: number;
    }

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

    • asc: "desc" | "asc"
    • priority: number
  • 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, 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

  • 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

  • Parameters

    • type: "metaDataChanged"
    • listener: ((previous, current) => void)
        • (previous, current): void
        • emitted when the meta data property changes

          Parameters

          Returns void

          As Member Of

          Column

          Group

          Events

    Returns 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • Parameters

    Returns this

  • triggers that the ranking is sorted by this column

    Parameters

    • ascending: boolean = ...

      ascending order?

    • priority: number = 0

      sorting priority

    Returns boolean

    was successful