Class NestedColumn

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

MultiLevelCompositeColumn
- NestedColumn

Index

Constructors

constructor

Accessors

canJustAddNumbers children description fixed fqid fqpath frozen id label length

Constructors

constructor

new NestedColumn(id: string, desc: Readonly<IMultiLevelCompositeColumnDesc>): NestedColumn
Parameters
- id: string
- desc: Readonly<IMultiLevelCompositeColumnDesc>
Returns NestedColumn
Inherited from MultiLevelCompositeColumn.constructor
- Defined in model/MultiLevelCompositeColumn.ts:59

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: "default" = 'default'

`Static` `Readonly` EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = 'addColumn'

`Static` `Readonly` EVENT_COLLAPSE_CHANGED

EVENT_COLLAPSE_CHANGED: "collapseChanged" = StackColumn.EVENT_COLLAPSE_CHANGED

`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" = StackColumn.EVENT_MULTI_LEVEL_CHANGED

`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_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
Inherited from MultiLevelCompositeColumn.canJustAddNumbers
- Defined in model/CompositeColumn.ts:321

children

get children(): Column[]
Returns Column[]
Inherited from MultiLevelCompositeColumn.children
- Defined in model/CompositeColumn.ts:97

description

get description(): string
Returns string
Inherited from MultiLevelCompositeColumn.description
- Defined in model/Column.ts:183

fixed

get fixed(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.fixed
- Defined in model/Column.ts:163

fqid

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

Returns

Returns string
Inherited from MultiLevelCompositeColumn.fqid
- Defined in model/Column.ts:191

fqpath

get fqpath(): string
Returns string
Inherited from MultiLevelCompositeColumn.fqpath
- Defined in model/Column.ts:195

frozen

get frozen(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.frozen
- Defined in model/Column.ts:167

id

get id(): string
Returns string
Inherited from MultiLevelCompositeColumn.id
- Defined in model/Column.ts:171

label

get label(): string
Returns string
Inherited from MultiLevelCompositeColumn.label
- Defined in model/Column.ts:179

length

get length(): number
Returns number
Inherited from MultiLevelCompositeColumn.length
- Defined in model/CompositeColumn.ts:101

Methods

assignNewId

assignNewId(idGenerator: (() => string)): void
Parameters
- idGenerator: (() => string)
  - - (): string
    - Returns string
Returns void
Inherited from MultiLevelCompositeColumn.assignNewId
- Defined in model/CompositeColumn.ts:92

at

at(index: number): Column
Parameters
- index: number
Returns Column
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.attach
- Defined in model/Column.ts:426

clearFilter

clearFilter(): boolean
clear the filter

Returns
whether the filtered needed to be reset

Returns boolean
Inherited from MultiLevelCompositeColumn.clearFilter
- Defined in model/CompositeColumn.ts:305

`Protected` createEventList

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

Returns
by default no events

Returns string[]
Inherited from MultiLevelCompositeColumn.createEventList
- Defined in model/MultiLevelCompositeColumn.ts:73

detach

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

Returns void
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.dump
- Defined in model/MultiLevelCompositeColumn.ts:123

filter

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

Returns
Parameters
- row: IDataRow
Returns boolean
Inherited from MultiLevelCompositeColumn.filter
- Defined in model/CompositeColumn.ts:309

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

Returns
my current ranking

Returns Ranking
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.flatten
- Defined in model/MultiLevelCompositeColumn.ts:134

`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
Inherited from MultiLevelCompositeColumn.forward
- Defined in internal/AEventDispatcher.ts:137

getCollapsed

getCollapsed(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.getCollapsed
- Defined in model/MultiLevelCompositeColumn.ts:115

getColor

getColor(_row: IDataRow): string
Parameters
- _row: IDataRow
Returns string
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.getExportValue
- Defined in model/MultiLevelCompositeColumn.ts:200

getGroupRenderer

getGroupRenderer(): string
Returns string
Inherited from MultiLevelCompositeColumn.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
Overrides MultiLevelCompositeColumn.getLabel
- Defined in model/NestedColumn.ts:29

getMetaData

getMetaData(): Readonly<IColumnMetaData>
Returns Readonly<IColumnMetaData>
Inherited from MultiLevelCompositeColumn.getMetaData
- Defined in model/Column.ts:316

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
Inherited from MultiLevelCompositeColumn.getRenderer
- Defined in model/MultiLevelCompositeColumn.ts:193

getSummaryRenderer

getSummaryRenderer(): string
Returns string
Inherited from MultiLevelCompositeColumn.getSummaryRenderer
- Defined in model/Column.ts:647

getValue

getValue(row: IDataRow): string
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 string
Overrides MultiLevelCompositeColumn.getValue
- Defined in model/NestedColumn.ts:33

getVisible

getVisible(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.getVisible
- Defined in model/Column.ts:249

getWidth

getWidth(): number
Returns number
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.group
- Defined in model/Column.ts:593

groupByMe

groupByMe(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.groupByMe
- Defined in model/Column.ts:334

groupSortByMe

groupSortByMe(ascending?: boolean, priority?: number): boolean
Parameters
- ascending: boolean = ...
- priority: number = 0
Returns boolean
Inherited from MultiLevelCompositeColumn.groupSortByMe
- Defined in model/Column.ts:389

hide

hide(): void
Returns void
Inherited from MultiLevelCompositeColumn.hide
- Defined in model/Column.ts:237

indexOf

indexOf(col: Column): number
Parameters
- col: Column
Returns number
Inherited from MultiLevelCompositeColumn.indexOf
- Defined in model/CompositeColumn.ts:229

insert

insert(col: Column, index: number): Column
inserts a column at a the given position
Parameters
- col: Column
- index: number
Returns Column
Inherited from MultiLevelCompositeColumn.insert
- Defined in model/MultiLevelCompositeColumn.ts:143

insertAfter

insertAfter(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Inherited from MultiLevelCompositeColumn.insertAfter
- Defined in model/CompositeColumn.ts:233

insertAfterMe

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

Returns
was successful
Parameters
- col: Column
  
  the column to insert
Returns boolean
Inherited from MultiLevelCompositeColumn.insertAfterMe
- Defined in model/Column.ts:442

insertBefore

insertBefore(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.insertBeforeMe
- Defined in model/Column.ts:454

`Protected` insertImpl

insertImpl(col: Column, index: number): Column
Parameters
- col: Column
- index: number
Returns Column
Inherited from MultiLevelCompositeColumn.insertImpl
- Defined in model/CompositeColumn.ts:174

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns

Returns boolean
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.isGroupSortedByMe
- Defined in model/Column.ts:405

isGroupedBy

isGroupedBy(): number
Returns

Returns number
Inherited from MultiLevelCompositeColumn.isGroupedBy
- Defined in model/Column.ts:346

isLoaded

isLoaded(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.isLoaded
- Defined in model/CompositeColumn.ts:313

isShowNestedSummaries

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

Returns boolean
Inherited from MultiLevelCompositeColumn.isShowNestedSummaries
- Defined in model/MultiLevelCompositeColumn.ts:119

isSortedByMe

isSortedByMe(): { asc: "desc" | "asc"; priority: number }
Returns { asc: "desc" | "asc"; priority: number }
- asc: "desc" | "asc"
- priority: number
Inherited from MultiLevelCompositeColumn.isSortedByMe
- Defined in model/Column.ts:385

isVisible

isVisible(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.isVisible
- Defined in model/Column.ts:245

`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
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.markDirty
- Defined in model/Column.ts:691

move

move(col: Column, index: number): Column
Parameters
- col: Column
- index: number
Returns Column
Inherited from MultiLevelCompositeColumn.move
- Defined in model/CompositeColumn.ts:156

moveAfter

moveAfter(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Inherited from MultiLevelCompositeColumn.moveAfter
- Defined in model/CompositeColumn.ts:241

moveBefore

moveBefore(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.moveImpl
- Defined in model/CompositeColumn.ts:203

nextSibling

nextSibling(): Column
returns the next sibling

Returns

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

on

on(type: "collapseChanged", listener: ((previous: boolean, current: boolean) => void)): NestedColumn
Parameters
- type: "collapseChanged"
- listener: ((previous: boolean, current: boolean) => void)
  - - (previous: boolean, current: boolean): void
    - emitted when the collapse property changes
      
      As Member Of
      MultiLevelCompositeColumn
      
      Group
      Events
      
      Parameters
      
      previous: boolean
      
      current: boolean
      
      Returns void
Returns NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:79
on(type: "nestedChildRatio", listener: ((previous: number, current: number) => void)): NestedColumn
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
      MultiLevelCompositeColumn
      
      Group
      Events
      
      Parameters
      
      previous: number
      
      current: number
      
      Returns void
Returns NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:80
on(type: "filterChanged", listener: ((previous: any, current: any) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:84
on(type: "addColumn", listener: ((col: Column, index: number) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:85
on(type: "moveColumn", listener: ((col: Column, index: number, oldIndex: number) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:86
on(type: "removeColumn", listener: ((col: Column, index: number) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:87
on(type: "widthChanged", listener: ((previous: number, current: number) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:88
on(type: "labelChanged", listener: ((previous: string, current: string) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:89
on(type: "metaDataChanged", listener: ((previous: IColumnMetaData, current: IColumnMetaData) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:90
on(type: "dirty", listener: (() => void)): NestedColumn
Parameters
- type: "dirty"
- listener: (() => void)
  - - (): void
    - emitted when state of the column is dirty
      
      As Member Of
      Column
      
      Group
      Events
      
      Returns void
Returns NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:91
on(type: "dirtyHeader", listener: (() => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:92
on(type: "dirtyValues", listener: (() => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:93
on(type: "dirtyCaches", listener: (() => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:94
on(type: "rendererTypeChanged", listener: ((previous: string, current: string) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:95
on(type: "groupRendererChanged", listener: ((previous: string, current: string) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:96
on(type: "summaryRendererChanged", listener: ((previous: string, current: string) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:97
on(type: "visibilityChanged", listener: ((previous: boolean, current: boolean) => void)): NestedColumn
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 NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:98
on(type: string | string[], listener: IEventListener): NestedColumn
Parameters
- type: string | string[]
- listener: IEventListener
Returns NestedColumn
Inherited from MultiLevelCompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:99

previousSibling

previousSibling(): Column
returns the previous sibling

Returns

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

push

push(col: Column): Column
Parameters
- col: Column
Returns Column
Inherited from MultiLevelCompositeColumn.push
- Defined in model/CompositeColumn.ts:221

remove

remove(col: Column): boolean
Parameters
- col: Column
Returns boolean
Inherited from MultiLevelCompositeColumn.remove
- Defined in model/CompositeColumn.ts:265

removeImpl

removeImpl(child: Column, index: number): boolean
Parameters
- child: Column
- index: number
Returns boolean
Inherited from MultiLevelCompositeColumn.removeImpl
- Defined in model/MultiLevelCompositeColumn.ts:170

removeMe

removeMe(): boolean
removes the column from the ranking

Returns
was successful

Returns boolean
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.restore
- Defined in model/MultiLevelCompositeColumn.ts:129

setCollapsed

setCollapsed(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from MultiLevelCompositeColumn.setCollapsed
- Defined in model/MultiLevelCompositeColumn.ts:104

setGroupRenderer

setGroupRenderer(renderer: string): void
Parameters
- renderer: string
Returns void
Inherited from MultiLevelCompositeColumn.setGroupRenderer
- Defined in model/Column.ts:663

setMetaData

setMetaData(value: Readonly<IColumnMetaData>): void
Parameters
- value: Readonly<IColumnMetaData>
Returns void
Inherited from MultiLevelCompositeColumn.setMetaData
- Defined in model/Column.ts:293

setRenderer

setRenderer(renderer: string): void
Parameters
- renderer: string
Returns void
Inherited from MultiLevelCompositeColumn.setRenderer
- Defined in model/Column.ts:651

setSummaryRenderer

setSummaryRenderer(renderer: string): void
Parameters
- renderer: string
Returns void
Inherited from MultiLevelCompositeColumn.setSummaryRenderer
- Defined in model/Column.ts:675

setVisible

setVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from MultiLevelCompositeColumn.setVisible
- Defined in model/Column.ts:253

setWidth

setWidth(value: number): void
Parameters
- value: number
Returns void
Inherited from MultiLevelCompositeColumn.setWidth
- Defined in model/MultiLevelCompositeColumn.ts:176

setWidthImpl

setWidthImpl(value: number): void
Parameters
- value: number
Returns void
Inherited from MultiLevelCompositeColumn.setWidthImpl
- Defined in model/Column.ts:289

show

show(): void
Returns void
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.sortByMe
- Defined in model/Column.ts:326

toCompareGroupValue

toCompareGroupValue(_rows: ISequence<IDataRow>, group: IGroup, _valueCache?: ISequence<any>): ICompareValue | ICompareValue[]
Parameters
- _rows: ISequence<IDataRow>
- group: IGroup
- Optional _valueCache: ISequence<any>
Returns ICompareValue | ICompareValue[]
Inherited from MultiLevelCompositeColumn.toCompareGroupValue
- Defined in model/Column.ts:597

toCompareGroupValueType

toCompareGroupValueType(): ECompareValueType | ECompareValueType[]
Returns ECompareValueType | ECompareValueType[]
Inherited from MultiLevelCompositeColumn.toCompareGroupValueType
- Defined in model/Column.ts:605

toCompareValue

toCompareValue(row: IDataRow): (string | number)[]
Parameters
- row: IDataRow
Returns (string | number)[]
Overrides MultiLevelCompositeColumn.toCompareValue
- Defined in model/NestedColumn.ts:21

toCompareValueType

toCompareValueType(): ECompareValueType[]
Returns ECompareValueType[]
Overrides MultiLevelCompositeColumn.toCompareValueType
- Defined in model/NestedColumn.ts:25

toggleMyGroupSorting

toggleMyGroupSorting(): boolean
Returns boolean
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.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
Inherited from MultiLevelCompositeColumn.unforward
- Defined in internal/AEventDispatcher.ts:146

Class NestedColumn

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

desc: Readonly<IMultiLevelCompositeColumnDesc>

Returns NestedColumn

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_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 createEventList

Returns

Returns string[]

detach

Returns void

`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_WIDTH_CHANGED

`Static` `Readonly` FLAT_ALL_COLUMNS

`Protected` createEventList

`Protected` fire

`Rest` ...args: any[]

`Protected` forward

`Rest` ...types: string[]