Options
All
  • Public
  • Public/Protected
  • All
Menu

a nested column is a composite column where the sorting order is determined by the nested ordering of the children i.e., sort by the first child if equal sort by the second child,...

Hierarchy

Index

Constructors

Properties

_children: Column[] = []
desc: Readonly<IColumnDesc>
parent: Readonly<IColumnParent> = null

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

COLLAPSED_RENDERER: "default" = 'default'
EVENT_ADD_COLUMN: "addColumn" = 'addColumn'
EVENT_COLLAPSE_CHANGED: "collapseChanged" = StackColumn.EVENT_COLLAPSE_CHANGED
EVENT_DIRTY: "dirty" = 'dirty'
EVENT_DIRTY_CACHES: "dirtyCaches" = 'dirtyCaches'
EVENT_DIRTY_HEADER: "dirtyHeader" = 'dirtyHeader'
EVENT_DIRTY_VALUES: "dirtyValues" = 'dirtyValues'
EVENT_FILTER_CHANGED: "filterChanged" = 'filterChanged'
EVENT_GROUP_RENDERER_TYPE_CHANGED: "groupRendererChanged" = 'groupRendererChanged'
EVENT_LABEL_CHANGED: "labelChanged" = 'labelChanged'
EVENT_METADATA_CHANGED: "metaDataChanged" = 'metaDataChanged'
EVENT_MOVE_COLUMN: "moveColumn" = 'moveColumn'
EVENT_MULTI_LEVEL_CHANGED: "nestedChildRatio" = StackColumn.EVENT_MULTI_LEVEL_CHANGED
EVENT_REMOVE_COLUMN: "removeColumn" = 'removeColumn'
EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = 'rendererTypeChanged'
EVENT_SUMMARY_RENDERER_TYPE_CHANGED: "summaryRendererChanged" = 'summaryRendererChanged'
EVENT_VISIBILITY_CHANGED: "visibilityChanged" = 'visibilityChanged'
EVENT_WIDTH_CHANGED: "widthChanged" = 'widthChanged'
FLAT_ALL_COLUMNS: -1 = -1

magic variable for showing all columns

Accessors

  • get canJustAddNumbers(): boolean
  • get description(): string
  • get fixed(): boolean
  • get fqid(): string
  • returns the fully qualified id i.e. path the parent

    Returns string

  • get fqpath(): string
  • get frozen(): boolean
  • get id(): string
  • get label(): string
  • get length(): number

Methods

  • assignNewId(idGenerator: () => string): void
  • clearFilter(): boolean
  • createEventList(): string[]
  • detach(): void
  • dump(toDescRef: (desc: any) => any): any
  • fire(type: string | string[], ...args: any[]): void
  • flatten(r: IFlatColumn[], offset: number, levelsToGo?: number, padding?: number): number
  • 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

    • Rest ...types: string[]

      the event types to forward

    Returns void

  • getCollapsed(): boolean
  • getExportValue(row: IDataRow, format: "text" | "json"): any
  • getGroupRenderer(): string
  • getRenderer(): string
  • getSummaryRenderer(): string
  • getVisible(): boolean
  • getWidth(): number
  • groupByMe(): boolean
  • groupSortByMe(ascending?: boolean, priority?: number): boolean
  • hide(): void
  • insertAfterMe(col: Column): boolean
  • insertBeforeMe(col: Column): boolean
  • isFiltered(): boolean
  • isGroupSortedByMe(): { asc: "asc" | "desc"; priority: number }
  • isGroupedBy(): number
  • isLoaded(): boolean
  • isShowNestedSummaries(): boolean
  • isSortedByMe(): { asc: "asc" | "desc"; priority: number }
  • isVisible(): boolean
  • listenersChanged(_type: string, _active: boolean): void
  • markDirty(type?: "header" | "values" | "all"): void
  • marks the header, values, or both as dirty such that the values are reevaluated

    Parameters

    • type: "header" | "values" | "all" = 'all'

      specify in more detail what is dirty, by default whole column

    Returns void

  • moveImpl(col: Column, index: number, oldIndex: number): Column
  • on(type: "collapseChanged", listener: (previous: boolean, current: boolean) => void): NestedColumn
  • on(type: "nestedChildRatio", listener: (previous: number, current: number) => void): NestedColumn
  • on(type: "filterChanged", listener: (previous: any, current: any) => void): NestedColumn
  • on(type: "addColumn", listener: (col: Column, index: number) => void): NestedColumn
  • on(type: "moveColumn", listener: (col: Column, index: number, oldIndex: number) => void): NestedColumn
  • on(type: "removeColumn", listener: (col: Column, index: number) => void): NestedColumn
  • on(type: "widthChanged", listener: (previous: number, current: number) => void): NestedColumn
  • on(type: "labelChanged", listener: (previous: string, current: string) => void): NestedColumn
  • on(type: "metaDataChanged", listener: (previous: IColumnMetaData, current: IColumnMetaData) => void): NestedColumn
  • on(type: "dirty", listener: () => void): NestedColumn
  • on(type: "dirtyHeader", listener: () => void): NestedColumn
  • on(type: "dirtyValues", listener: () => void): NestedColumn
  • on(type: "dirtyCaches", listener: () => void): NestedColumn
  • on(type: "rendererTypeChanged", listener: (previous: string, current: string) => void): NestedColumn
  • on(type: "groupRendererChanged", listener: (previous: string, current: string) => void): NestedColumn
  • on(type: "summaryRendererChanged", listener: (previous: string, current: string) => void): NestedColumn
  • on(type: "visibilityChanged", listener: (previous: boolean, current: boolean) => void): NestedColumn
  • on(type: string | string[], listener: IEventListener): NestedColumn
  • removeImpl(child: Column, index: number): boolean
  • removeMe(): boolean
  • setCollapsed(value: boolean): void
  • setGroupRenderer(renderer: string): 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
  • toCompareValue(row: IDataRow): (string | number)[]
  • toggleMyGroupSorting(): boolean
  • toggleMySorting(): boolean
  • unforward(from: IEventHandler, ...types: string[]): void