Class StackColumn

implementation of the stacked column

Hierarchy

CompositeNumberColumn
- StackColumn

Implements

IMultiLevelColumn

Index

Constructors

constructor

new StackColumn(id: string, desc: IStackColumnColumnDesc): StackColumn
Parameters
- id: string
- desc: IStackColumnColumnDesc
Returns StackColumn
Overrides CompositeNumberColumn.constructor
- Defined in model/StackColumn.ts:80

Properties

`Protected` `Readonly` _children

_children: Column[] = []

`Readonly` desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> = null

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

`Static` `Readonly` COLLAPSED_RENDERER

COLLAPSED_RENDERER: "number" = 'number'

`Static` `Readonly` EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = 'addColumn'

`Static` `Readonly` EVENT_COLLAPSE_CHANGED

EVENT_COLLAPSE_CHANGED: "collapseChanged" = 'collapseChanged'

`Static` `Readonly` EVENT_DIRTY

EVENT_DIRTY: "dirty" = 'dirty'

`Static` `Readonly` EVENT_DIRTY_CACHES

EVENT_DIRTY_CACHES: "dirtyCaches" = 'dirtyCaches'

`Static` `Readonly` EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = 'dirtyHeader'

`Static` `Readonly` EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = 'dirtyValues'

`Static` `Readonly` EVENT_FILTER_CHANGED

EVENT_FILTER_CHANGED: "filterChanged" = 'filterChanged'

`Static` `Readonly` EVENT_GROUP_RENDERER_TYPE_CHANGED

EVENT_GROUP_RENDERER_TYPE_CHANGED: "groupRendererChanged" = 'groupRendererChanged'

`Static` `Readonly` EVENT_LABEL_CHANGED

EVENT_LABEL_CHANGED: "labelChanged" = 'labelChanged'

`Static` `Readonly` EVENT_METADATA_CHANGED

EVENT_METADATA_CHANGED: "metaDataChanged" = 'metaDataChanged'

`Static` `Readonly` EVENT_MOVE_COLUMN

EVENT_MOVE_COLUMN: "moveColumn" = 'moveColumn'

`Static` `Readonly` EVENT_MULTI_LEVEL_CHANGED

EVENT_MULTI_LEVEL_CHANGED: "nestedChildRatio" = 'nestedChildRatio'

`Static` `Readonly` EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = 'removeColumn'

`Static` `Readonly` EVENT_RENDERER_TYPE_CHANGED

EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = 'rendererTypeChanged'

`Static` `Readonly` EVENT_SUMMARY_RENDERER_TYPE_CHANGED

EVENT_SUMMARY_RENDERER_TYPE_CHANGED: "summaryRendererChanged" = 'summaryRendererChanged'

`Static` `Readonly` EVENT_VISIBILITY_CHANGED

EVENT_VISIBILITY_CHANGED: "visibilityChanged" = 'visibilityChanged'

`Static` `Readonly` EVENT_WEIGHTS_CHANGED

EVENT_WEIGHTS_CHANGED: "weightsChanged" = 'weightsChanged'

`Static` `Readonly` EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = 'widthChanged'

`Static` `Readonly` FLAT_ALL_COLUMNS

FLAT_ALL_COLUMNS: -1 = -1

magic variable for showing all columns

Accessors

canJustAddNumbers

get canJustAddNumbers(): boolean
Returns boolean
Implementation of IMultiLevelColumn.canJustAddNumbers

Overrides CompositeNumberColumn.canJustAddNumbers
- Defined in model/StackColumn.ts:159

children

get children(): Column[]
Returns Column[]
Implementation of IMultiLevelColumn.children

Inherited from CompositeNumberColumn.children
- Defined in model/CompositeColumn.ts:97

description

get description(): string
Returns string
Implementation of IMultiLevelColumn.description

Inherited from CompositeNumberColumn.description
- Defined in model/Column.ts:183

fixed

get fixed(): boolean
Returns boolean
Implementation of IMultiLevelColumn.fixed

Inherited from CompositeNumberColumn.fixed
- Defined in model/Column.ts:163

fqid

get fqid(): string
returns the fully qualified id i.e. path the parent

Returns

Returns string
Implementation of IMultiLevelColumn.fqid

Inherited from CompositeNumberColumn.fqid
- Defined in model/Column.ts:191

fqpath

get fqpath(): string
Returns string
Implementation of IMultiLevelColumn.fqpath

Inherited from CompositeNumberColumn.fqpath
- Defined in model/Column.ts:195

frozen

get frozen(): boolean
Returns boolean
Implementation of IMultiLevelColumn.frozen

Inherited from CompositeNumberColumn.frozen
- Defined in model/Column.ts:167

id

get id(): string
Returns string
Implementation of IMultiLevelColumn.id

Inherited from CompositeNumberColumn.id
- Defined in model/Column.ts:171

label

get label(): string
Returns string
Implementation of IMultiLevelColumn.label

Overrides CompositeNumberColumn.label
- Defined in model/StackColumn.ts:97

length

get length(): number
Returns number
Implementation of IMultiLevelColumn.length

Inherited from CompositeNumberColumn.length
- Defined in model/CompositeColumn.ts:101

Methods

assignNewId

assignNewId(idGenerator: (() => string)): void
Parameters
- idGenerator: (() => string)
  - - (): string
    - Returns string
Returns void
Implementation of IMultiLevelColumn.assignNewId

Inherited from CompositeNumberColumn.assignNewId
- Defined in model/CompositeColumn.ts:92

at

at(index: number): Column
Parameters
- index: number
Returns Column
Implementation of IMultiLevelColumn.at

Inherited from CompositeNumberColumn.at
- Defined in model/CompositeColumn.ts:225

attach

attach(parent: IColumnParent): void
called when the columns added to a ranking
Parameters
- parent: IColumnParent
Returns void
Implementation of IMultiLevelColumn.attach

Inherited from CompositeNumberColumn.attach
- Defined in model/Column.ts:426

clearFilter

clearFilter(): boolean
clear the filter

Returns
whether the filtered needed to be reset

Returns boolean
Implementation of IMultiLevelColumn.clearFilter

Inherited from CompositeNumberColumn.clearFilter
- Defined in model/CompositeColumn.ts:305

`Protected` compute

compute(row: IDataRow): number
Parameters
- row: IDataRow
Returns number
Overrides CompositeNumberColumn.compute
- Defined in model/StackColumn.ts:326

`Protected` createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns
by default no events

Returns string[]
Implementation of IMultiLevelColumn.createEventList

Overrides CompositeNumberColumn.createEventList
- Defined in model/StackColumn.ts:107

detach

detach(): void
called when the column is removed from the ranking

Returns void
Implementation of IMultiLevelColumn.detach

Inherited from CompositeNumberColumn.detach
- Defined in model/Column.ts:433

dump

dump(toDescRef: ((desc: any) => any)): any
dumps this column to JSON compatible format

Returns
dump of this column
Parameters
- toDescRef: ((desc: any) => any)
  
  helper mapping function
  - - (desc: any): any
    - Parameters
      
      desc: any
      
      Returns any
Returns any
Implementation of IMultiLevelColumn.dump

Overrides CompositeNumberColumn.dump
- Defined in model/StackColumn.ts:190

filter

filter(row: IDataRow): boolean
predicate whether the current row should be included

Returns
Parameters
- row: IDataRow
Returns boolean
Implementation of IMultiLevelColumn.filter

Inherited from CompositeNumberColumn.filter
- Defined in model/CompositeColumn.ts:309

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

Returns
my current ranking

Returns Ranking
Implementation of IMultiLevelColumn.findMyRanker

Inherited from CompositeNumberColumn.findMyRanker
- Defined in model/Column.ts:489

`Protected` fire

fire(type: string | string[], ...args: any[]): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Implementation of IMultiLevelColumn.fire

Inherited from CompositeNumberColumn.fire
- Defined in internal/AEventDispatcher.ts:101

flatten

flatten(r: IFlatColumn[], offset: number, levelsToGo?: number, padding?: number): number
visitor pattern for flattening the columns

Returns
the used width by this column
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
Implementation of IMultiLevelColumn.flatten

Overrides CompositeNumberColumn.flatten
- Defined in model/StackColumn.ts:163

`Protected` forward

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
Implementation of IMultiLevelColumn.forward

Inherited from CompositeNumberColumn.forward
- Defined in internal/AEventDispatcher.ts:137

getCollapsed

getCollapsed(): boolean
Returns boolean
Implementation of IMultiLevelColumn.getCollapsed
- Defined in model/StackColumn.ts:151

getColor

getColor(_row: IDataRow): string
Parameters
- _row: IDataRow
Returns string
Implementation of IMultiLevelColumn.getColor

Inherited from CompositeNumberColumn.getColor
- Defined in model/Column.ts:576

getExportValue

getExportValue(row: IDataRow, format: "text" | "json"): any
returns the value to be used when exporting
Parameters
- row: IDataRow
- format: "text" | "json"
  
  format hint
Returns any
Implementation of IMultiLevelColumn.getExportValue

Overrides CompositeNumberColumn.getExportValue
- Defined in model/StackColumn.ts:342

getGroupRenderer

getGroupRenderer(): string
Returns string
Implementation of IMultiLevelColumn.getGroupRenderer

Inherited from CompositeNumberColumn.getGroupRenderer
- Defined in model/Column.ts:643

getLabel

getLabel(row: IDataRow): string
return the label of a given row for the current column

Returns
the label of this column at the specified row
Parameters
- row: IDataRow
  
  the current row
Returns string
Implementation of IMultiLevelColumn.getLabel

Inherited from CompositeNumberColumn.getLabel
- Defined in model/CompositeNumberColumn.ts:40

getMetaData

getMetaData(): Readonly<IColumnMetaData>
Returns Readonly<IColumnMetaData>
Implementation of IMultiLevelColumn.getMetaData

Inherited from CompositeNumberColumn.getMetaData
- Defined in model/Column.ts:316

getNumber

getNumber(row: IDataRow): number
Parameters
- row: IDataRow
Returns number
Inherited from CompositeNumberColumn.getNumber
- Defined in model/CompositeNumberColumn.ts:65

getNumberFormat

getNumberFormat(): ((n: number) => string)
Returns ((n: number) => string)
- - (n: number): string
  - Parameters
    - n: number
    Returns string
Inherited from CompositeNumberColumn.getNumberFormat
- Defined in model/CompositeNumberColumn.ts:36

getRawNumber

getRawNumber(row: IDataRow): number
Parameters
- row: IDataRow
Returns number
Inherited from CompositeNumberColumn.getRawNumber
- Defined in model/CompositeNumberColumn.ts:70

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

Returns string
Implementation of IMultiLevelColumn.getRenderer

Overrides CompositeNumberColumn.getRenderer
- Defined in model/StackColumn.ts:335

getSummaryRenderer

getSummaryRenderer(): string
Returns string
Implementation of IMultiLevelColumn.getSummaryRenderer

Inherited from CompositeNumberColumn.getSummaryRenderer
- Defined in model/Column.ts:647

getValue

getValue(row: IDataRow): number
return the value of a given row for the current column

Returns
the value of this column at the specified row
Parameters
- row: IDataRow
  
  the current row
Returns number
Implementation of IMultiLevelColumn.getValue

Inherited from CompositeNumberColumn.getValue
- Defined in model/CompositeNumberColumn.ts:49

getVisible

getVisible(): boolean
Returns boolean
Implementation of IMultiLevelColumn.getVisible

Inherited from CompositeNumberColumn.getVisible
- Defined in model/Column.ts:249

getWeights

getWeights(): number[]
Returns number[]
- Defined in model/StackColumn.ts:269

getWidth

getWidth(): number
Returns number
Implementation of IMultiLevelColumn.getWidth

Inherited from CompositeNumberColumn.getWidth
- Defined in model/Column.ts:233

group

group(_row: IDataRow, _valueCache?: any): IGroup
group the given row into a bin/group

Returns
Parameters
- _row: IDataRow
- Optional _valueCache: any
Returns IGroup
Implementation of IMultiLevelColumn.group

Inherited from CompositeNumberColumn.group
- Defined in model/Column.ts:593

groupByMe

groupByMe(): boolean
Returns boolean
Implementation of IMultiLevelColumn.groupByMe

Inherited from CompositeNumberColumn.groupByMe
- Defined in model/Column.ts:334

groupSortByMe

groupSortByMe(ascending?: boolean, priority?: number): boolean
Parameters
- ascending: boolean = ...
- priority: number = 0
Returns boolean
Implementation of IMultiLevelColumn.groupSortByMe

Inherited from CompositeNumberColumn.groupSortByMe
- Defined in model/Column.ts:389

hide

hide(): void
Returns void
Implementation of IMultiLevelColumn.hide

Inherited from CompositeNumberColumn.hide
- Defined in model/Column.ts:237

indexOf

indexOf(col: Column): number
Parameters
- col: Column
Returns number
Implementation of IMultiLevelColumn.indexOf

Inherited from CompositeNumberColumn.indexOf
- Defined in model/CompositeColumn.ts:229

insert

insert(col: Column, index: number, weight?: number): Column
inserts a column at a the given position
Parameters
- col: Column
- index: number
- weight: number = NaN
Returns Column
Implementation of IMultiLevelColumn.insert

Overrides CompositeNumberColumn.insert
- Defined in model/StackColumn.ts:204

insertAfter

insertAfter(col: Column, ref: Column, weight?: number): Column
Parameters
- col: Column
- ref: Column
- weight: number = NaN
Returns Column
Implementation of IMultiLevelColumn.insertAfter

Overrides CompositeNumberColumn.insertAfter
- Defined in model/StackColumn.ts:219

insertAfterMe

insertAfterMe(col: Column): boolean
inserts the given column after itself

Returns
was successful
Parameters
- col: Column
  
  the column to insert
Returns boolean
Implementation of IMultiLevelColumn.insertAfterMe

Inherited from CompositeNumberColumn.insertAfterMe
- Defined in model/Column.ts:442

insertBefore

insertBefore(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Implementation of IMultiLevelColumn.insertBefore

Inherited from CompositeNumberColumn.insertBefore
- Defined in model/CompositeColumn.ts:249

insertBeforeMe

insertBeforeMe(col: Column): boolean
inserts the given column before itself

Returns
was successful
Parameters
- col: Column
  
  the column to insert
Returns boolean
Implementation of IMultiLevelColumn.insertBeforeMe

Inherited from CompositeNumberColumn.insertBeforeMe
- Defined in model/Column.ts:454

`Protected` insertImpl

insertImpl(col: Column, index: number): Column
Parameters
- col: Column
- index: number
Returns Column
Implementation of IMultiLevelColumn.insertImpl

Inherited from CompositeNumberColumn.insertImpl
- Defined in model/CompositeColumn.ts:174

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns

Returns boolean
Implementation of IMultiLevelColumn.isFiltered

Inherited from CompositeNumberColumn.isFiltered
- Defined in model/CompositeColumn.ts:301

isGroupSortedByMe

isGroupSortedByMe(): { asc: "desc" | "asc"; priority: number }
Returns { asc: "desc" | "asc"; priority: number }
- asc: "desc" | "asc"
- priority: number
Implementation of IMultiLevelColumn.isGroupSortedByMe

Inherited from CompositeNumberColumn.isGroupSortedByMe
- Defined in model/Column.ts:405

isGroupedBy

isGroupedBy(): number
Returns

Returns number
Implementation of IMultiLevelColumn.isGroupedBy

Inherited from CompositeNumberColumn.isGroupedBy
- Defined in model/Column.ts:346

isLoaded

isLoaded(): boolean
Returns boolean
Implementation of IMultiLevelColumn.isLoaded

Inherited from CompositeNumberColumn.isLoaded
- Defined in model/CompositeColumn.ts:313

isShowNestedSummaries

isShowNestedSummaries(): boolean
whether to show nested summaries or not

Returns boolean
Implementation of IMultiLevelColumn.isShowNestedSummaries
- Defined in model/StackColumn.ts:155

isSortedByMe

isSortedByMe(): { asc: "desc" | "asc"; priority: number }
Returns { asc: "desc" | "asc"; priority: number }
- asc: "desc" | "asc"
- priority: number
Implementation of IMultiLevelColumn.isSortedByMe

Inherited from CompositeNumberColumn.isSortedByMe
- Defined in model/Column.ts:385

isVisible

isVisible(): boolean
Returns boolean
Implementation of IMultiLevelColumn.isVisible

Inherited from CompositeNumberColumn.isVisible
- Defined in model/Column.ts:245

iterNumber

iterNumber(row: IDataRow): number[]
Parameters
- row: IDataRow
Returns number[]
Inherited from CompositeNumberColumn.iterNumber
- Defined in model/CompositeNumberColumn.ts:74

iterRawNumber

iterRawNumber(row: IDataRow): number[]
Parameters
- row: IDataRow
Returns number[]
Inherited from CompositeNumberColumn.iterRawNumber
- Defined in model/CompositeNumberColumn.ts:78

`Protected` listenersChanged

listenersChanged(_type: string, _active: boolean): void
helper function that will be called upon a listener has changed
Parameters
- _type: string
  
  event type
- _active: boolean
  
  registered or de registered
Returns void
Implementation of IMultiLevelColumn.listenersChanged

Inherited from CompositeNumberColumn.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

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
Implementation of IMultiLevelColumn.markDirty

Inherited from CompositeNumberColumn.markDirty
- Defined in model/Column.ts:691

move

move(col: Column, index: number): Column
Parameters
- col: Column
- index: number
Returns Column
Implementation of IMultiLevelColumn.move

Inherited from CompositeNumberColumn.move
- Defined in model/CompositeColumn.ts:156

moveAfter

moveAfter(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Implementation of IMultiLevelColumn.moveAfter

Inherited from CompositeNumberColumn.moveAfter
- Defined in model/CompositeColumn.ts:241

moveBefore

moveBefore(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Implementation of IMultiLevelColumn.moveBefore

Inherited from CompositeNumberColumn.moveBefore
- Defined in model/CompositeColumn.ts:257

`Protected` moveImpl

moveImpl(col: Column, index: number, oldIndex: number): Column
Parameters
- col: Column
- index: number
- oldIndex: number
Returns Column
Implementation of IMultiLevelColumn.moveImpl

Inherited from CompositeNumberColumn.moveImpl
- Defined in model/CompositeColumn.ts:203

nextSibling

nextSibling(): Column
returns the next sibling

Returns

Returns Column
Implementation of IMultiLevelColumn.nextSibling

Inherited from CompositeNumberColumn.nextSibling
- Defined in model/Column.ts:465

on

on(type: "collapseChanged", listener: ((previous: boolean, current: boolean) => void)): StackColumn
Parameters
- type: "collapseChanged"
- listener: ((previous: boolean, current: boolean) => void)
  - - (previous: boolean, current: boolean): void
    - emitted when the collapse property changes
      
      As Member Of
      StackColumn
      
      Group
      Events
      
      Parameters
      
      previous: boolean
      
      current: boolean
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:117
on(type: "weightsChanged", listener: ((previous: number[], current: number[]) => void)): StackColumn
Parameters
- type: "weightsChanged"
- listener: ((previous: number[], current: number[]) => void)
  - - (previous: number[], current: number[]): void
    - emitted when the weights change
      
      As Member Of
      StackColumn
      
      Group
      Events
      
      Parameters
      
      previous: number[]
      
      current: number[]
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:118
on(type: "nestedChildRatio", listener: ((previous: number[], current: number[]) => void)): StackColumn
Parameters
- type: "nestedChildRatio"
- listener: ((previous: number[], current: number[]) => void)
  - - (previous: number[], current: number[]): void
    - emitted when the ratios between the children changes
      
      As Member Of
      StackColumn
      
      Group
      Events
      
      Parameters
      
      previous: number[]
      
      current: number[]
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:119
on(type: "filterChanged", listener: ((previous: any, current: any) => void)): StackColumn
Parameters
- type: "filterChanged"
- listener: ((previous: any, current: any) => void)
  - - (previous: any, current: any): void
    - emitted when the filter property changes
      
      As Member Of
      CompositeColumn
      
      Group
      Events
      
      Parameters
      
      previous: any
      
      current: any
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:120
on(type: "addColumn", listener: ((col: Column, index: number) => void)): StackColumn
Parameters
- type: "addColumn"
- listener: ((col: Column, index: number) => void)
  - - (col: Column, index: number): void
    - emitted when a column has been added
      
      As Member Of
      CompositeColumn
      
      Group
      Events
      
      Parameters
      
      col: Column
      
      index: number
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:121
on(type: "moveColumn", listener: ((col: Column, index: number, oldIndex: number) => void)): StackColumn
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
      
      As Member Of
      CompositeColumn
      
      Group
      Events
      
      Parameters
      
      col: Column
      
      index: number
      
      oldIndex: number
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:122
on(type: "removeColumn", listener: ((col: Column, index: number) => void)): StackColumn
Parameters
- type: "removeColumn"
- listener: ((col: Column, index: number) => void)
  - - (col: Column, index: number): void
    - emitted when a column has been removed
      
      As Member Of
      CompositeColumn
      
      Group
      Events
      
      Parameters
      
      col: Column
      
      index: number
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:123
on(type: "widthChanged", listener: ((previous: number, current: number) => void)): StackColumn
Parameters
- type: "widthChanged"
- listener: ((previous: number, current: number) => void)
  - - (previous: number, current: number): void
    - emitted when the width property changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: number
      
      current: number
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:124
on(type: "labelChanged", listener: ((previous: string, current: string) => void)): StackColumn
Parameters
- type: "labelChanged"
- listener: ((previous: string, current: string) => void)
  - - (previous: string, current: string): void
    - emitted when the label property changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: string
      
      current: string
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:125
on(type: "metaDataChanged", listener: ((previous: IColumnMetaData, current: IColumnMetaData) => void)): StackColumn
Parameters
- type: "metaDataChanged"
- listener: ((previous: IColumnMetaData, current: IColumnMetaData) => void)
  - - (previous: IColumnMetaData, current: IColumnMetaData): void
    - emitted when the meta data property changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: IColumnMetaData
      
      current: IColumnMetaData
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:126
on(type: "dirty", listener: (() => void)): StackColumn
Parameters
- type: "dirty"
- listener: (() => void)
  - - (): void
    - emitted when state of the column is dirty
      
      As Member Of
      Column
      
      Group
      Events
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:127
on(type: "dirtyHeader", listener: (() => void)): StackColumn
Parameters
- type: "dirtyHeader"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to its header is dirty
      
      As Member Of
      Column
      
      Group
      Events
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:128
on(type: "dirtyValues", listener: (() => void)): StackColumn
Parameters
- type: "dirtyValues"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to its values is dirty
      
      As Member Of
      Column
      
      Group
      Events
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:129
on(type: "dirtyCaches", listener: (() => void)): StackColumn
Parameters
- type: "dirtyCaches"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to cached values (hist, compare, ...) is dirty
      
      As Member Of
      Column
      
      Group
      Events
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:130
on(type: "rendererTypeChanged", listener: ((previous: string, current: string) => void)): StackColumn
Parameters
- type: "rendererTypeChanged"
- listener: ((previous: string, current: string) => void)
  - - (previous: string, current: string): void
    - emitted when the renderer type property changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: string
      
      current: string
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:131
on(type: "groupRendererChanged", listener: ((previous: string, current: string) => void)): StackColumn
Parameters
- type: "groupRendererChanged"
- listener: ((previous: string, current: string) => void)
  - - (previous: string, current: string): void
    - emitted when the group renderer property changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: string
      
      current: string
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:132
on(type: "summaryRendererChanged", listener: ((previous: string, current: string) => void)): StackColumn
Parameters
- type: "summaryRendererChanged"
- listener: ((previous: string, current: string) => void)
  - - (previous: string, current: string): void
    - emitted when the pattern property changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: string
      
      current: string
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:133
on(type: "visibilityChanged", listener: ((previous: boolean, current: boolean) => void)): StackColumn
Parameters
- type: "visibilityChanged"
- listener: ((previous: boolean, current: boolean) => void)
  - - (previous: boolean, current: boolean): void
    - emitted when the visibility of this column changes
      
      As Member Of
      Column
      
      Group
      Events
      
      Parameters
      
      previous: boolean
      
      current: boolean
      
      Returns void
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:134
on(type: string | string[], listener: IEventListener): StackColumn
Parameters
- type: string | string[]
- listener: IEventListener
Returns StackColumn
Implementation of IMultiLevelColumn.on

Overrides CompositeNumberColumn.on
- Defined in model/StackColumn.ts:135

previousSibling

previousSibling(): Column
returns the previous sibling

Returns

Returns Column
Implementation of IMultiLevelColumn.previousSibling

Inherited from CompositeNumberColumn.previousSibling
- Defined in model/Column.ts:477

push

push(col: Column, weight?: number): Column
Parameters
- col: Column
- weight: number = NaN
Returns Column
Implementation of IMultiLevelColumn.push

Overrides CompositeNumberColumn.push
- Defined in model/StackColumn.ts:215

remove

remove(col: Column): boolean
Parameters
- col: Column
Returns boolean
Implementation of IMultiLevelColumn.remove

Inherited from CompositeNumberColumn.remove
- Defined in model/CompositeColumn.ts:265

removeImpl

removeImpl(child: Column, index: number): boolean
Parameters
- child: Column
- index: number
Returns boolean
Implementation of IMultiLevelColumn.removeImpl

Overrides CompositeNumberColumn.removeImpl
- Defined in model/StackColumn.ts:311

removeMe

removeMe(): boolean
removes the column from the ranking

Returns
was successful

Returns boolean
Implementation of IMultiLevelColumn.removeMe

Inherited from CompositeNumberColumn.removeMe
- Defined in model/Column.ts:413

restore

restore(dump: any, factory: ITypeFactory): void
restore the column content from a dump
Parameters
- dump: any
  
  column dump
- factory: ITypeFactory
  
  helper for creating columns
Returns void
Implementation of IMultiLevelColumn.restore

Overrides CompositeNumberColumn.restore
- Defined in model/StackColumn.ts:196

setCollapsed

setCollapsed(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IMultiLevelColumn.setCollapsed
- Defined in model/StackColumn.ts:140

setGroupRenderer

setGroupRenderer(renderer: string): void
Parameters
- renderer: string
Returns void
Implementation of IMultiLevelColumn.setGroupRenderer

Inherited from CompositeNumberColumn.setGroupRenderer
- Defined in model/Column.ts:663

setMetaData

setMetaData(value: Readonly<IColumnMetaData>): void
Parameters
- value: Readonly<IColumnMetaData>
Returns void
Implementation of IMultiLevelColumn.setMetaData

Inherited from CompositeNumberColumn.setMetaData
- Defined in model/Column.ts:293

setRenderer

setRenderer(renderer: string): void
Parameters
- renderer: string
Returns void
Implementation of IMultiLevelColumn.setRenderer

Inherited from CompositeNumberColumn.setRenderer
- Defined in model/Column.ts:651

setSummaryRenderer

setSummaryRenderer(renderer: string): void
Parameters
- renderer: string
Returns void
Implementation of IMultiLevelColumn.setSummaryRenderer

Inherited from CompositeNumberColumn.setSummaryRenderer
- Defined in model/Column.ts:675

setVisible

setVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IMultiLevelColumn.setVisible

Inherited from CompositeNumberColumn.setVisible
- Defined in model/Column.ts:253

setWeights

setWeights(weights: number[]): void
Parameters
- weights: number[]
Returns void
- Defined in model/StackColumn.ts:274

setWidth

setWidth(value: number): void
Parameters
- value: number
Returns void
Implementation of IMultiLevelColumn.setWidth

Overrides CompositeNumberColumn.setWidth
- Defined in model/StackColumn.ts:317

setWidthImpl

setWidthImpl(value: number): void
Parameters
- value: number
Returns void
Implementation of IMultiLevelColumn.setWidthImpl

Inherited from CompositeNumberColumn.setWidthImpl
- Defined in model/Column.ts:289

show

show(): void
Returns void
Implementation of IMultiLevelColumn.show

Inherited from CompositeNumberColumn.show
- Defined in model/Column.ts:241

sortByMe

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

Returns
was successful
Parameters
- ascending: boolean = ...
  
  ascending order?
- priority: number = 0
  
  sorting priority
Returns boolean
Implementation of IMultiLevelColumn.sortByMe

Inherited from CompositeNumberColumn.sortByMe
- Defined in model/Column.ts:326

toCompareGroupValue

toCompareGroupValue(rows: ISequence<IDataRow>, group: IGroup): number
Parameters
- rows: ISequence<IDataRow>
- group: IGroup
Returns number
Implementation of IMultiLevelColumn.toCompareGroupValue

Inherited from CompositeNumberColumn.toCompareGroupValue
- Defined in model/CompositeNumberColumn.ts:100

toCompareGroupValueType

toCompareGroupValueType(): ECompareValueType
Returns ECompareValueType
Implementation of IMultiLevelColumn.toCompareGroupValueType

Inherited from CompositeNumberColumn.toCompareGroupValueType
- Defined in model/CompositeNumberColumn.ts:104

toCompareValue

toCompareValue(row: IDataRow): any
Parameters
- row: IDataRow
Returns any
Implementation of IMultiLevelColumn.toCompareValue

Inherited from CompositeNumberColumn.toCompareValue
- Defined in model/CompositeNumberColumn.ts:92

toCompareValueType

toCompareValueType(): ECompareValueType
Returns ECompareValueType
Implementation of IMultiLevelColumn.toCompareValueType

Inherited from CompositeNumberColumn.toCompareValueType
- Defined in model/CompositeNumberColumn.ts:96

toggleMyGroupSorting

toggleMyGroupSorting(): boolean
Returns boolean
Implementation of IMultiLevelColumn.toggleMyGroupSorting

Inherited from CompositeNumberColumn.toggleMyGroupSorting
- Defined in model/Column.ts:397

toggleMySorting

toggleMySorting(): boolean
toggles the sorting order of this column in the ranking

Returns
was successful

Returns boolean
Implementation of IMultiLevelColumn.toggleMySorting

Inherited from CompositeNumberColumn.toggleMySorting
- Defined in model/Column.ts:358

`Protected` unforward

unforward(from: IEventHandler, ...types: string[]): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  
  the originated dispatcher
- Rest ...types: string[]
  
  event types to forward
Returns void
Implementation of IMultiLevelColumn.unforward

Inherited from CompositeNumberColumn.unforward
- Defined in internal/AEventDispatcher.ts:146

Class StackColumn

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

desc: IStackColumnColumnDesc

Returns StackColumn

Properties

Protected Readonly _children

Readonly desc

parent

Static Readonly COLLAPSED_RENDERER

Static Readonly EVENT_ADD_COLUMN

Static Readonly EVENT_COLLAPSE_CHANGED

Static Readonly EVENT_DIRTY

Static Readonly EVENT_DIRTY_CACHES

Static Readonly EVENT_DIRTY_HEADER

Static Readonly EVENT_DIRTY_VALUES

Static Readonly EVENT_FILTER_CHANGED

Static Readonly EVENT_GROUP_RENDERER_TYPE_CHANGED

Static Readonly EVENT_LABEL_CHANGED

Static Readonly EVENT_METADATA_CHANGED

Static Readonly EVENT_MOVE_COLUMN

Static Readonly EVENT_MULTI_LEVEL_CHANGED

Static Readonly EVENT_REMOVE_COLUMN

Static Readonly EVENT_RENDERER_TYPE_CHANGED

Static Readonly EVENT_SUMMARY_RENDERER_TYPE_CHANGED

Static Readonly EVENT_VISIBILITY_CHANGED

Static Readonly EVENT_WEIGHTS_CHANGED

Static Readonly EVENT_WIDTH_CHANGED

Static Readonly FLAT_ALL_COLUMNS

Accessors

canJustAddNumbers

Returns boolean

children

Returns Column[]

description

Returns string

fixed

Returns boolean

fqid

Returns

Returns string

fqpath

Returns string

frozen

Returns boolean

id

Returns string

label

Returns string

length

Returns number

Methods

assignNewId

Parameters

idGenerator: (() => string)

Returns string

Returns void

at

Parameters

index: number

Returns Column

attach

Parameters

parent: IColumnParent

Returns void

clearFilter

Returns

Returns boolean

Protected compute

Parameters

row: IDataRow

`Protected` `Readonly` _children

`Readonly` desc

`Static` `Readonly` COLLAPSED_RENDERER

`Static` `Readonly` EVENT_ADD_COLUMN

`Static` `Readonly` EVENT_COLLAPSE_CHANGED

`Static` `Readonly` EVENT_DIRTY

`Static` `Readonly` EVENT_DIRTY_CACHES

`Static` `Readonly` EVENT_DIRTY_HEADER

`Static` `Readonly` EVENT_DIRTY_VALUES

`Static` `Readonly` EVENT_FILTER_CHANGED

`Static` `Readonly` EVENT_GROUP_RENDERER_TYPE_CHANGED

`Static` `Readonly` EVENT_LABEL_CHANGED

`Static` `Readonly` EVENT_METADATA_CHANGED

`Static` `Readonly` EVENT_MOVE_COLUMN

`Static` `Readonly` EVENT_MULTI_LEVEL_CHANGED

`Static` `Readonly` EVENT_REMOVE_COLUMN

`Static` `Readonly` EVENT_RENDERER_TYPE_CHANGED

`Static` `Readonly` EVENT_SUMMARY_RENDERER_TYPE_CHANGED

`Static` `Readonly` EVENT_VISIBILITY_CHANGED

`Static` `Readonly` EVENT_WEIGHTS_CHANGED

`Static` `Readonly` EVENT_WIDTH_CHANGED

`Static` `Readonly` FLAT_ALL_COLUMNS

`Protected` compute

`Protected` createEventList

`Protected` fire

`Rest` ...args: any[]

`Protected` forward

`Rest` ...types: string[]