Options
All
  • Public
  • Public/Protected
  • All
Menu

implementation of the stacked column

Hierarchy

Implements

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: "number" = 'number'
EVENT_ADD_COLUMN: "addColumn" = 'addColumn'
EVENT_COLLAPSE_CHANGED: "collapseChanged" = 'collapseChanged'
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" = 'nestedChildRatio'
EVENT_REMOVE_COLUMN: "removeColumn" = 'removeColumn'
EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = 'rendererTypeChanged'
EVENT_SUMMARY_RENDERER_TYPE_CHANGED: "summaryRendererChanged" = 'summaryRendererChanged'
EVENT_VISIBILITY_CHANGED: "visibilityChanged" = 'visibilityChanged'
EVENT_WEIGHTS_CHANGED: "weightsChanged" = 'weightsChanged'
EVENT_WIDTH_CHANGED: "widthChanged" = 'widthChanged'
FLAT_ALL_COLUMNS: -1 = -1

magic variable for showing all columns

Accessors

  • get canJustAddNumbers(): boolean
  • Returns boolean

  • 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 id(): string
  • Returns 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
  • getCollapsed(): boolean
  • getExportValue(row: IDataRow, format: "text" | "json"): any
  • getGroupRenderer(): string
  • getNumberFormat(): (n: number) => string
  • getRenderer(): string
  • getSummaryRenderer(): string
  • getVisible(): boolean
  • getWeights(): number[]
  • 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
  • moveImpl(col: Column, index: number, oldIndex: number): Column
  • on(type: "collapseChanged", listener: (previous: boolean, current: boolean) => void): StackColumn
  • on(type: "weightsChanged", listener: (previous: number[], current: number[]) => void): StackColumn
  • on(type: "nestedChildRatio", listener: (previous: number[], current: number[]) => void): StackColumn
  • on(type: "filterChanged", listener: (previous: any, current: any) => void): StackColumn
  • on(type: "addColumn", listener: (col: Column, index: number) => void): StackColumn
  • on(type: "moveColumn", listener: (col: Column, index: number, oldIndex: number) => void): StackColumn
  • on(type: "removeColumn", listener: (col: Column, index: number) => void): StackColumn
  • on(type: "widthChanged", listener: (previous: number, current: number) => void): StackColumn
  • on(type: "labelChanged", listener: (previous: string, current: string) => void): StackColumn
  • on(type: "metaDataChanged", listener: (previous: IColumnMetaData, current: IColumnMetaData) => void): StackColumn
  • on(type: "dirty", listener: () => void): StackColumn
  • on(type: "dirtyHeader", listener: () => void): StackColumn
  • on(type: "dirtyValues", listener: () => void): StackColumn
  • on(type: "dirtyCaches", listener: () => void): StackColumn
  • on(type: "rendererTypeChanged", listener: (previous: string, current: string) => void): StackColumn
  • on(type: "groupRendererChanged", listener: (previous: string, current: string) => void): StackColumn
  • on(type: "summaryRendererChanged", listener: (previous: string, current: string) => void): StackColumn
  • on(type: "visibilityChanged", listener: (previous: boolean, current: boolean) => void): StackColumn
  • on(type: string | string[], listener: IEventListener): StackColumn
  • 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
  • setWeights(weights: number[]): void
  • setWidth(value: number): void
  • setWidthImpl(value: number): void
  • show(): void
  • sortByMe(ascending?: boolean, priority?: number): boolean
  • toggleMyGroupSorting(): boolean
  • toggleMySorting(): boolean
  • unforward(from: IEventHandler, ...types: string[]): void