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

Implements

Index

Constructors

constructor

Properties

desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> | null = null

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

Static DEFAULT_COLOR

DEFAULT_COLOR: "#C1C1C1" = "#C1C1C1"

default color that should be used

type

{string}

Static EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = "addColumn"

Static EVENT_COLLAPSE_CHANGED

EVENT_COLLAPSE_CHANGED: "collapseChanged" = StackColumn.EVENT_COLLAPSE_CHANGED

Static EVENT_DIRTY

EVENT_DIRTY: "dirty" = "dirty"

Static EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = "dirtyHeader"

Static EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = "dirtyValues"

Static EVENT_FILTER_CHANGED

EVENT_FILTER_CHANGED: "filterChanged" = "filterChanged"

Static EVENT_GROUP_RENDERER_TYPE_CHANGED

EVENT_GROUP_RENDERER_TYPE_CHANGED: "groupRendererChanged" = "groupRendererChanged"

Static EVENT_LABEL_CHANGED

EVENT_LABEL_CHANGED: "labelChanged" = "labelChanged"

Static EVENT_METADATA_CHANGED

EVENT_METADATA_CHANGED: "metaDataChanged" = "metaDataChanged"

Static EVENT_MOVE_COLUMN

EVENT_MOVE_COLUMN: "moveColumn" = "moveColumn"

Static EVENT_MULTI_LEVEL_CHANGED

EVENT_MULTI_LEVEL_CHANGED: "nestedChildRatio" = StackColumn.EVENT_MULTI_LEVEL_CHANGED

Static EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = "removeColumn"

Static EVENT_RENDERER_TYPE_CHANGED

EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = "rendererTypeChanged"

Static EVENT_SUMMARY_RENDERER_TYPE_CHANGED

EVENT_SUMMARY_RENDERER_TYPE_CHANGED: "summaryRendererChanged" = "summaryRendererChanged"

Static EVENT_VISIBILITY_CHANGED

EVENT_VISIBILITY_CHANGED: "visibilityChanged" = "visibilityChanged"

Static EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = "widthChanged"

Static FLAT_ALL_COLUMNS

FLAT_ALL_COLUMNS: -1 = -1

magic variable for showing all columns

type

{number}

Accessors

canJustAddNumbers

  • get canJustAddNumbers(): boolean

children

color

  • get color(): null | string

description

  • get description(): string

fixed

  • get fixed(): boolean

fqid

  • get fqid(): string

fqpath

  • get fqpath(): string

frozen

  • get frozen(): boolean

id

  • get id(): string

label

  • get label(): string

length

  • get length(): number

Methods

assignNewId

  • assignNewId(idGenerator: function): void

at

attach

compare

detach

  • detach(): void

dump

  • dump(toDescRef: function): any

filter

findMyRanker

flatten

  • flatten(r: IFlatColumn[], offset: number, levelsToGo?: number, padding?: number): any

getCollapsed

  • getCollapsed(): boolean

getColor

  • getColor(_row: IDataRow): null | string

getExportValue

  • getExportValue(row: IDataRow, format: "text" | "json"): any

getGroupRenderer

  • getGroupRenderer(): string

getLabel

getMetaData

getRenderer

  • getRenderer(): string

getSummaryRenderer

  • getSummaryRenderer(): string

getValue

getVisible

  • getVisible(): boolean

getWidth

  • getWidth(): number

group

groupByMe

  • groupByMe(): boolean

groupCompare

groupSortByMe

  • groupSortByMe(ascending?: boolean, priority?: number): boolean

hide

  • hide(): void

indexOf

  • indexOf(col: Column): number

insert

insertAfter

insertAfterMe

  • insertAfterMe(col: Column): boolean

isFiltered

  • isFiltered(): boolean

isGroupSortedByMe

  • isGroupSortedByMe(): object

isGroupedBy

  • isGroupedBy(): number

isLoaded

  • isLoaded(): boolean

isMissing

isSortedByMe

  • isSortedByMe(): object

isVisible

  • isVisible(): boolean

markDirty

  • markDirty(type?: "header" | "values" | "all"): void
  • marks the header, values, or both as dirty such that the values are reevaluated

    Parameters

    • Default value type: "header" | "values" | "all" = "all"

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

    Returns void

move

moveAfter

on

push

remove

  • remove(col: Column): boolean

removeImpl

  • removeImpl(child: Column, index: number): boolean

removeMe

  • removeMe(): boolean

restore

  • restore(dump: any, factory: function): void

setCollapsed

  • setCollapsed(value: boolean): void

setGroupRenderer

  • setGroupRenderer(renderer: string): void

setMetaData

setRenderer

  • setRenderer(renderer: string): void

setSummaryRenderer

  • setSummaryRenderer(renderer: string): void

setVisible

  • setVisible(value: boolean): void

setWidth

  • setWidth(value: number): void

setWidthImpl

  • setWidthImpl(value: number): void

show

  • show(): void

sortByMe

  • sortByMe(ascending?: boolean, priority?: number): boolean
  • triggers that the ranking is sorted by this column

    Parameters

    • Default value ascending: boolean = isSortingAscByDefault(this)

      ascending order?

    • Default value priority: number = 0

      sorting priority

    Returns boolean

    was successful

toggleMyGroupSorting

  • toggleMyGroupSorting(): boolean

toggleMySorting

  • toggleMySorting(): boolean