NestedColumn | LineUpJS

Hierarchy

MultiLevelCompositeColumn
- NestedColumn

Implements

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new NestedColumn(id: string, desc: Readonly<IColumnDesc>): NestedColumn

Inherited from MultiLevelCompositeColumn.constructor

Overrides Column.constructor
- Defined in model/MultiLevelCompositeColumn.ts:38
Parameters
- id: string
- desc: Readonly<IColumnDesc>
Returns NestedColumn

Properties

desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> | null = null

Static DEFAULT_COLOR

DEFAULT_COLOR: "#C1C1C1" = "#C1C1C1"

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

Accessors

canJustAddNumbers

canJustAddNumbers:

children

children:

description

description:

fixed

fixed:

fqid

fqid:

fqpath

fqpath:

frozen

frozen:

id

id:

label

label:

length

length:

Methods

assignNewId

assignNewId(idGenerator: function): void

Inherited from CompositeColumn.assignNewId

Overrides Column.assignNewId
- Defined in model/CompositeColumn.ts:76
Parameters
- idGenerator: function
  - - (): string
    - Returns string
Returns void

at

at(index: number): Column

Implementation of IMultiLevelColumn.at

Inherited from CompositeColumn.at
- Defined in model/CompositeColumn.ts:172
Parameters
- index: number
Returns Column

attach

attach(parent: IColumnParent): void

Implementation of IMultiLevelColumn.attach

Inherited from Column.attach
- Defined in model/Column.ts:415
Parameters
- parent: IColumnParent
Returns void

compare

compare(a: IDataRow, b: IDataRow): number

Implementation of IMultiLevelColumn.compare

Overrides Column.compare
- Defined in model/NestedColumn.ts:19
Parameters
- a: IDataRow
- b: IDataRow
Returns number

detach

detach(): void

Implementation of IMultiLevelColumn.detach

Inherited from Column.detach
- Defined in model/Column.ts:422
Returns void

dump

dump(toDescRef: function): any

Inherited from MultiLevelCompositeColumn.dump

Overrides CompositeColumn.dump
- Defined in model/MultiLevelCompositeColumn.ts:84
Parameters
- toDescRef: function
  - - (desc: any): any
    - Parameters
      - desc: any
      Returns any
Returns any

filter

filter(row: IDataRow): boolean

Implementation of IMultiLevelColumn.filter

Inherited from CompositeColumn.filter

Overrides Column.filter
- Defined in model/CompositeColumn.ts:217
Parameters
- row: IDataRow
Returns boolean

findMyRanker

findMyRanker(): Ranking | null

Implementation of IMultiLevelColumn.findMyRanker

Inherited from Column.findMyRanker
- Defined in model/Column.ts:442
Returns Ranking | null

my current ranking

flatten

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

Implementation of IMultiLevelColumn.flatten

Inherited from MultiLevelCompositeColumn.flatten

Overrides CompositeColumn.flatten
- Defined in model/MultiLevelCompositeColumn.ts:95
Parameters
- r: IFlatColumn[]
- offset: number
- Default value levelsToGo: number = 0
- Default value padding: number = 0
Returns any

getCollapsed

getCollapsed(): boolean

Implementation of IMultiLevelColumn.getCollapsed

Inherited from MultiLevelCompositeColumn.getCollapsed
- Defined in model/MultiLevelCompositeColumn.ts:80
Returns boolean

getColor

getColor(_row: IDataRow): string

Implementation of IMultiLevelColumn.getColor

Inherited from Column.getColor
- Defined in model/Column.ts:523
Parameters
- _row: IDataRow
Returns string

getExportValue

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

Implementation of IMultiLevelColumn.getExportValue

Inherited from MultiLevelCompositeColumn.getExportValue

Overrides Column.getExportValue
- Defined in model/MultiLevelCompositeColumn.ts:160
Parameters
- row: IDataRow
- format: "text" | "json"
Returns any

getGroupRenderer

getGroupRenderer(): string

Implementation of IMultiLevelColumn.getGroupRenderer

Inherited from Column.getGroupRenderer
- Defined in model/Column.ts:585
Returns string

getLabel

getLabel(row: IDataRow): string

Implementation of IMultiLevelColumn.getLabel

Overrides Column.getLabel
- Defined in model/NestedColumn.ts:30
Parameters
- row: IDataRow
Returns string

getMetaData

getMetaData(): Readonly<IColumnMetaData>

Implementation of IMultiLevelColumn.getMetaData

Inherited from Column.getMetaData
- Defined in model/Column.ts:308
Returns Readonly<IColumnMetaData>

getRenderer

getRenderer(): string

Implementation of IMultiLevelColumn.getRenderer

Inherited from MultiLevelCompositeColumn.getRenderer

Overrides Column.getRenderer
- Defined in model/MultiLevelCompositeColumn.ts:146
Returns string

getSummaryRenderer

getSummaryRenderer(): string

Implementation of IMultiLevelColumn.getSummaryRenderer

Inherited from Column.getSummaryRenderer
- Defined in model/Column.ts:589
Returns string

getValue

getValue(row: IDataRow): string

Implementation of IMultiLevelColumn.getValue

Overrides Column.getValue
- Defined in model/NestedColumn.ts:34
Parameters
- row: IDataRow
Returns string

getVisible

getVisible(): boolean

Implementation of IMultiLevelColumn.getVisible

Inherited from Column.getVisible
- Defined in model/Column.ts:258
Returns boolean

getWidth

getWidth(): number

Implementation of IMultiLevelColumn.getWidth

Inherited from Column.getWidth
- Defined in model/Column.ts:242
Returns number

group

group(_row: IDataRow): IGroup

Implementation of IMultiLevelColumn.group

Inherited from Column.group
- Defined in model/Column.ts:546
Parameters
- _row: IDataRow
Returns IGroup

groupByMe

groupByMe(): boolean

Implementation of IMultiLevelColumn.groupByMe

Inherited from Column.groupByMe
- Defined in model/Column.ts:326
Returns boolean

groupCompare

groupCompare(a: IGroupData, b: IGroupData): number

Implementation of IMultiLevelColumn.groupCompare

Inherited from Column.groupCompare
- Defined in model/Column.ts:556
Parameters
- a: IGroupData
- b: IGroupData
Returns number

groupSortByMe

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

Implementation of IMultiLevelColumn.groupSortByMe

Inherited from Column.groupSortByMe
- Defined in model/Column.ts:378
Parameters
- Default value ascending: boolean = isSortingAscByDefault(this)
- Default value priority: number = 0
Returns boolean

hide

hide(): void

Implementation of IMultiLevelColumn.hide

Inherited from Column.hide
- Defined in model/Column.ts:246
Returns void

indexOf

indexOf(col: Column): number

Implementation of IMultiLevelColumn.indexOf

Inherited from CompositeColumn.indexOf
- Defined in model/CompositeColumn.ts:176
Parameters
- col: Column
Returns number

insert

insert(col: Column, index: number): null | Column

Implementation of IMultiLevelColumn.insert

Inherited from MultiLevelCompositeColumn.insert

Overrides CompositeColumn.insert
- Defined in model/MultiLevelCompositeColumn.ts:104
Parameters
- col: Column
- index: number
Returns null | Column

insertAfter

insertAfter(col: Column, ref: Column): null | Column

Implementation of IMultiLevelColumn.insertAfter

Inherited from CompositeColumn.insertAfter
- Defined in model/CompositeColumn.ts:180
Parameters
- col: Column
- ref: Column
Returns null | Column

insertAfterMe

insertAfterMe(col: Column): boolean

Implementation of IMultiLevelColumn.insertAfterMe

Inherited from Column.insertAfterMe
- Defined in model/Column.ts:431
Parameters
- col: Column
Returns boolean

was successful

isFiltered

isFiltered(): boolean

Implementation of IMultiLevelColumn.isFiltered

Inherited from CompositeColumn.isFiltered

Overrides Column.isFiltered
- Defined in model/CompositeColumn.ts:213
Returns boolean

isGroupSortedByMe

isGroupSortedByMe(): object

Implementation of IMultiLevelColumn.isGroupSortedByMe

Inherited from Column.isGroupSortedByMe
- Defined in model/Column.ts:394
Returns object

isGroupedBy

isGroupedBy(): number

Implementation of IMultiLevelColumn.isGroupedBy

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

isLoaded

isLoaded(): boolean

Implementation of IMultiLevelColumn.isLoaded

Inherited from CompositeColumn.isLoaded
- Defined in model/CompositeColumn.ts:221
Returns boolean

isMissing

isMissing(row: IDataRow): boolean

Implementation of IMultiLevelColumn.isMissing

Inherited from MultiLevelCompositeColumn.isMissing

Overrides Column.isMissing
- Defined in model/MultiLevelCompositeColumn.ts:153
Parameters
- row: IDataRow
Returns boolean

isSortedByMe

isSortedByMe(): object

Implementation of IMultiLevelColumn.isSortedByMe

Inherited from Column.isSortedByMe
- Defined in model/Column.ts:374
Returns object

isVisible

isVisible(): boolean

Implementation of IMultiLevelColumn.isVisible

Inherited from Column.isVisible
- Defined in model/Column.ts:254
Returns boolean

markDirty

markDirty(type?: "header" | "values" | "all"): void

Implementation of IMultiLevelColumn.markDirty

Inherited from Column.markDirty
- Defined in model/Column.ts:649
Parameters
- Default value type: "header" | "values" | "all" = "all"
Returns void

move

move(col: Column, index: number): Column | null

Implementation of IMultiLevelColumn.move

Inherited from CompositeColumn.move
- Defined in model/CompositeColumn.ts:139
Parameters
- col: Column
- index: number
Returns Column | null

moveAfter

moveAfter(col: Column, ref: Column): null | Column

Implementation of IMultiLevelColumn.moveAfter

Inherited from CompositeColumn.moveAfter
- Defined in model/CompositeColumn.ts:188
Parameters
- col: Column
- ref: Column
Returns null | Column

on

on(type: "collapseChanged", listener: collapseChanged | null): this
on(type: "nestedChildRatio", listener: nestedChildRatio | null): this
on(type: "filterChanged", listener: filterChanged | null): this
on(type: "addColumn", listener: addColumn | null): this
on(type: "moveColumn", listener: moveColumn | null): this
on(type: "removeColumn", listener: removeColumn | null): this
on(type: "widthChanged", listener: widthChanged | null): this
on(type: "labelChanged", listener: labelChanged | null): this
on(type: "metaDataChanged", listener: metaDataChanged | null): this
on(type: "dirty", listener: dirty | null): this
on(type: "dirtyHeader", listener: dirtyHeader | null): this
on(type: "dirtyValues", listener: dirtyValues | null): this
on(type: "rendererTypeChanged", listener: rendererTypeChanged | null): this
on(type: "groupRendererChanged", listener: groupRendererChanged | null): this
on(type: "summaryRendererChanged", listener: summaryRendererChanged | null): this
on(type: "visibilityChanged", listener: visibilityChanged | null): this
on(type: string | string[], listener: IEventListener | null): this

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:52
Parameters
- type: "collapseChanged"
- listener: collapseChanged | null
Returns this
Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:53
Parameters
- type: "nestedChildRatio"
- listener: nestedChildRatio | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:54
Parameters
- type: "filterChanged"
- listener: filterChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:55
Parameters
- type: "addColumn"
- listener: addColumn | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:56
Parameters
- type: "moveColumn"
- listener: moveColumn | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:57
Parameters
- type: "removeColumn"
- listener: removeColumn | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:58
Parameters
- type: "widthChanged"
- listener: widthChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:59
Parameters
- type: "labelChanged"
- listener: labelChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:60
Parameters
- type: "metaDataChanged"
- listener: metaDataChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:61
Parameters
- type: "dirty"
- listener: dirty | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:62
Parameters
- type: "dirtyHeader"
- listener: dirtyHeader | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:63
Parameters
- type: "dirtyValues"
- listener: dirtyValues | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:64
Parameters
- type: "rendererTypeChanged"
- listener: rendererTypeChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:65
Parameters
- type: "groupRendererChanged"
- listener: groupRendererChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:66
Parameters
- type: "summaryRendererChanged"
- listener: summaryRendererChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:67
Parameters
- type: "visibilityChanged"
- listener: visibilityChanged | null
Returns this
Implementation of IMultiLevelColumn.on

Inherited from MultiLevelCompositeColumn.on

Overrides CompositeColumn.on
- Defined in model/MultiLevelCompositeColumn.ts:68
Parameters
- type: string | string[]
- listener: IEventListener | null
Returns this

push

push(col: Column): null | Column

Implementation of IMultiLevelColumn.push

Inherited from CompositeColumn.push
- Defined in model/CompositeColumn.ts:168
Parameters
- col: Column
Returns null | Column

remove

remove(col: Column): boolean

Implementation of IMultiLevelColumn.remove

Inherited from CompositeColumn.remove
- Defined in model/CompositeColumn.ts:197
Parameters
- col: Column
Returns boolean

removeImpl

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

Inherited from MultiLevelCompositeColumn.removeImpl
- Defined in model/MultiLevelCompositeColumn.ts:127
Parameters
- child: Column
- index: number
Returns boolean

removeMe

removeMe(): boolean

Implementation of IMultiLevelColumn.removeMe

Inherited from Column.removeMe
- Defined in model/Column.ts:402
Returns boolean

was successful

restore

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

Inherited from MultiLevelCompositeColumn.restore

Overrides CompositeColumn.restore
- Defined in model/MultiLevelCompositeColumn.ts:90
Parameters
- dump: any
- factory: function
  - - (dump: any): Column | null
    - Parameters
      - dump: any
      Returns Column | null
Returns void

setCollapsed

setCollapsed(value: boolean): void

Implementation of IMultiLevelColumn.setCollapsed

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

setGroupRenderer

setGroupRenderer(renderer: string): void

Implementation of IMultiLevelColumn.setGroupRenderer

Inherited from Column.setGroupRenderer
- Defined in model/Column.ts:608
Parameters
- renderer: string
Returns void

setMetaData

setMetaData(value: Readonly<IColumnMetaData>): void

Implementation of IMultiLevelColumn.setMetaData

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

setRenderer

setRenderer(renderer: string): void

Implementation of IMultiLevelColumn.setRenderer

Inherited from Column.setRenderer
- Defined in model/Column.ts:593
Parameters
- renderer: string
Returns void

setSummaryRenderer

setSummaryRenderer(renderer: string): void

Implementation of IMultiLevelColumn.setSummaryRenderer

Inherited from Column.setSummaryRenderer
- Defined in model/Column.ts:623
Parameters
- renderer: string
Returns void

setVisible

setVisible(value: boolean): void

Implementation of IMultiLevelColumn.setVisible

Inherited from Column.setVisible
- Defined in model/Column.ts:262
Parameters
- value: boolean
Returns void

setWidth

setWidth(value: number): void

Implementation of IMultiLevelColumn.setWidth

Inherited from MultiLevelCompositeColumn.setWidth

Overrides Column.setWidth
- Defined in model/MultiLevelCompositeColumn.ts:133
Parameters
- value: number
Returns void

setWidthImpl

setWidthImpl(value: number): void

Implementation of IMultiLevelColumn.setWidthImpl

Inherited from Column.setWidthImpl
- Defined in model/Column.ts:290
Parameters
- value: number
Returns void

show

show(): void

Implementation of IMultiLevelColumn.show

Inherited from Column.show
- Defined in model/Column.ts:250
Returns void

sortByMe

sortByMe(ascending?: boolean, priority?: number): boolean

Implementation of IMultiLevelColumn.sortByMe

Inherited from Column.sortByMe
- Defined in model/Column.ts:318
Parameters
- Default value ascending: boolean = isSortingAscByDefault(this)
- Default value priority: number = 0
Returns boolean

was successful

toggleMyGroupSorting

toggleMyGroupSorting(): boolean

Implementation of IMultiLevelColumn.toggleMyGroupSorting

Inherited from Column.toggleMyGroupSorting
- Defined in model/Column.ts:386
Returns boolean

toggleMySorting

toggleMySorting(): boolean

Implementation of IMultiLevelColumn.toggleMySorting

Inherited from Column.toggleMySorting
- Defined in model/Column.ts:350
Returns boolean

was successful

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

desc: Readonly<IColumnDesc>

Returns NestedColumn

Properties

desc

parent

Static DEFAULT_COLOR

Static EVENT_ADD_COLUMN

Static EVENT_COLLAPSE_CHANGED

Static EVENT_DIRTY

Static EVENT_DIRTY_HEADER

Static EVENT_DIRTY_VALUES

Static EVENT_FILTER_CHANGED

Static EVENT_GROUP_RENDERER_TYPE_CHANGED

Static EVENT_LABEL_CHANGED

Static EVENT_METADATA_CHANGED

Static EVENT_MOVE_COLUMN

Static EVENT_MULTI_LEVEL_CHANGED

Static EVENT_REMOVE_COLUMN

Static EVENT_RENDERER_TYPE_CHANGED

Static EVENT_SUMMARY_RENDERER_TYPE_CHANGED

Static EVENT_VISIBILITY_CHANGED

Static EVENT_WIDTH_CHANGED

Static FLAT_ALL_COLUMNS

Accessors

canJustAddNumbers

children

description

fixed

fqid

fqpath

frozen

id

label

length

Methods

assignNewId

Parameters

idGenerator: function

Returns string

Returns void

at

Parameters

index: number

Returns Column

attach

Parameters

parent: IColumnParent

Returns void

compare

Parameters

a: IDataRow

b: IDataRow

Returns number

detach

Returns void

dump

Parameters

toDescRef: function

Parameters

desc: any

Returns any

Returns any

filter

Parameters

row: IDataRow

Returns boolean

findMyRanker

Returns Ranking | null

flatten