Class Column

a column in LineUp

Hierarchy (view full)

AEventDispatcher
- Column

Index

Constructors

Properties

desc parent EVENT_DIRTY EVENT_DIRTY_CACHES EVENT_DIRTY_HEADER EVENT_DIRTY_VALUES EVENT_GROUP_RENDERER_TYPE_CHANGED EVENT_LABEL_CHANGED EVENT_METADATA_CHANGED EVENT_RENDERER_TYPE_CHANGED EVENT_SUMMARY_RENDERER_TYPE_CHANGED EVENT_VISIBILITY_CHANGED EVENT_WIDTH_CHANGED FLAT_ALL_COLUMNS

Accessors

description fixed fqid fqpath frozen id label

Constructors

constructor

new Column(id, desc): Column
Parameters
- id: string
- desc: Readonly<IColumnDesc>
Returns Column
Overrides AEventDispatcher.constructor
- Defined in model/Column.ts:147

Properties

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

description

get description(): string
Returns string
- Defined in model/Column.ts:186

fixed

get fixed(): boolean
Returns boolean
- Defined in model/Column.ts:166

fqid

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

Returns string
- Defined in model/Column.ts:194

fqpath

get fqpath(): string
Returns string
- Defined in model/Column.ts:198

frozen

get frozen(): boolean
Returns boolean
- Defined in model/Column.ts:170

id

get id(): string
Returns string
- Defined in model/Column.ts:174

label

get label(): string
Returns string
- Defined in model/Column.ts:182

Methods

assignNewId

assignNewId(idGenerator): void
Parameters
- idGenerator: (() => string)
  - - (): string
    - Returns string
Returns void
- Defined in model/Column.ts:178

attach

attach(parent): void
called when the columns added to a ranking
Parameters
- parent: IColumnParent
Returns void
- Defined in model/Column.ts:429

clearFilter

clearFilter(): boolean
clear the filter

Returns boolean
whether the filtered needed to be reset
- Defined in model/Column.ts:624

`Protected` createEventList

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

Returns string[]
by default no events
Overrides AEventDispatcher.createEventList
- Defined in model/Column.ts:202

detach

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

Returns void
- Defined in model/Column.ts:436

dump

dump(toDescRef): any
dumps this column to JSON compatible format
Parameters
- toDescRef: ((desc) => any)
  helper mapping function
  - - (desc): any
    - Parameters
      desc: any
      Returns any
Returns any
dump of this column
- Defined in model/Column.ts:504

filter

filter(row, _valueCache?): boolean
predicate whether the current row should be included
Parameters
- row: IDataRow
- Optional _valueCache: any
Returns boolean
- Defined in model/Column.ts:634

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

Returns Ranking
my current ranking
- Defined in model/Column.ts:492

`Protected` fire

fire(type, ...args): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

flatten

flatten(r, offset, _levelsToGo?, _padding?): number
visitor pattern for flattening the columns
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
the used width by this column
- Defined in model/Column.ts:275

`Protected` forward

forward(from, ...types): 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 AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

getColor

getColor(_row): string
Parameters
- _row: IDataRow
Returns string
- Defined in model/Column.ts:579

getExportValue

getExportValue(row, format): any
returns the value to be used when exporting
Parameters
- row: IDataRow
- format: "text" | "json"
  format hint
Returns any
- Defined in model/Column.ts:575

getGroupRenderer

getGroupRenderer(): string
Returns string
- Defined in model/Column.ts:646

getHeaderLabel

getHeaderLabel(ctx): {
asHTML: boolean;
content: string;
}
Parameters
- ctx: "header" | "sidePanel" | "reorder"
Returns {
asHTML: boolean;
content: string;
}
- asHTML: boolean
- content: string
- Defined in model/Column.ts:710

getLabel

getLabel(row): string
return the label of a given row for the current column
Parameters
- row: IDataRow
  the current row
Returns string
the label of this column at the specified row
- Defined in model/Column.ts:557

getMetaData

getMetaData(): Readonly<IColumnMetaData>
Returns Readonly<IColumnMetaData>
- Defined in model/Column.ts:319

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 string
- Defined in model/Column.ts:642

getSummaryLabel

getSummaryLabel(ctx, fallback?): {
asHTML: boolean;
content: string;
}
Parameters
- ctx: "header" | "sidePanel" | "reorder"
- fallback: boolean = false
Returns {
asHTML: boolean;
content: string;
}
- asHTML: boolean
- content: string
- Defined in model/Column.ts:728

getSummaryRenderer

getSummaryRenderer(): string
Returns string
- Defined in model/Column.ts:650

getValue

getValue(_row): any
return the value of a given row for the current column
Parameters
- _row: IDataRow
  the current row
Returns any
the value of this column at the specified row
- Defined in model/Column.ts:567

getVisible

getVisible(): boolean
Returns boolean
- Defined in model/Column.ts:252

getWidth

getWidth(): number
Returns number
- Defined in model/Column.ts:236

group

group(_row, _valueCache?): IGroup
group the given row into a bin/group
Parameters
- _row: IDataRow
- Optional _valueCache: any
Returns IGroup
- Defined in model/Column.ts:596

groupByMe

groupByMe(): boolean
Returns boolean
- Defined in model/Column.ts:337

groupSortByMe

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

hide

hide(): void
Returns void
- Defined in model/Column.ts:240

insertAfterMe

insertAfterMe(col): boolean
inserts the given column after itself
Parameters
- col: Column
  the column to insert
Returns boolean
was successful
- Defined in model/Column.ts:445

insertBeforeMe

insertBeforeMe(col): boolean
inserts the given column before itself
Parameters
- col: Column
  the column to insert
Returns boolean
was successful
- Defined in model/Column.ts:457

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns boolean
- Defined in model/Column.ts:616

isGroupSortedByMe

isGroupSortedByMe(): {
asc: "desc" | "asc";
priority: number;
}
Returns {
asc: "desc" | "asc";
priority: number;
}
- asc: "desc" | "asc"
- priority: number
- Defined in model/Column.ts:408

isGroupedBy

isGroupedBy(): number
Returns number
- Defined in model/Column.ts:349

isSortedByMe

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

isVisible

isVisible(): boolean
Returns boolean
- Defined in model/Column.ts:248

`Protected` listenersChanged

listenersChanged(_type, _active): 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 AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

markDirty

markDirty(type?): 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
- Defined in model/Column.ts:694

nextSibling

nextSibling(): Column
returns the next sibling

Returns Column
- Defined in model/Column.ts:468

on

on(type, listener): this
Parameters
- type: "widthChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the width property changes
      
      Parameters
      previous: number
      current: number
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:220
on(type, listener): this
Parameters
- type: "labelChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the label property changes
      
      Parameters
      previous: string
      current: string
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:221
on(type, listener): this
Parameters
- type: "metaDataChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the meta data property changes
      
      Parameters
      previous: IColumnMetaData
      current: IColumnMetaData
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:222
on(type, listener): this
Parameters
- type: "dirty"
- listener: (() => void)
  - - (): void
    - emitted when state of the column is dirty
      
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:223
on(type, listener): this
Parameters
- type: "dirtyHeader"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to its header is dirty
      
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:224
on(type, listener): this
Parameters
- type: "dirtyValues"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to its values is dirty
      
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:225
on(type, listener): this
Parameters
- type: "dirtyCaches"
- listener: (() => void)
  - - (): void
    - emitted when state of the column related to cached values (hist, compare, ...) is dirty
      
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:226
on(type, listener): this
Parameters
- type: "rendererTypeChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the renderer type property changes
      
      Parameters
      previous: string
      current: string
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:227
on(type, listener): this
Parameters
- type: "groupRendererChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the group renderer property changes
      
      Parameters
      previous: string
      current: string
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:228
on(type, listener): this
Parameters
- type: "summaryRendererChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the pattern property changes
      
      Parameters
      previous: string
      current: string
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:229
on(type, listener): this
Parameters
- type: "visibilityChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the visibility of this column changes
      
      Parameters
      previous: boolean
      current: boolean
      Returns void
      As Member Of
      Column
      
      Group
      Events
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:230
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Overrides AEventDispatcher.on
- Defined in model/Column.ts:231

previousSibling

previousSibling(): Column
returns the previous sibling

Returns Column
- Defined in model/Column.ts:480

removeMe

removeMe(): boolean
removes the column from the ranking

Returns boolean
was successful
- Defined in model/Column.ts:416

restore

restore(dump, _factory): void
restore the column content from a dump
Parameters
- dump: IColumnDump
  column dump
- _factory: ITypeFactory
  helper for creating columns
Returns void
- Defined in model/Column.ts:533

setGroupRenderer

setGroupRenderer(renderer): void
Parameters
- renderer: string
Returns void
- Defined in model/Column.ts:666

setMetaData

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

setRenderer

setRenderer(renderer): void
Parameters
- renderer: string
Returns void
- Defined in model/Column.ts:654

setSummaryRenderer

setSummaryRenderer(renderer): void
Parameters
- renderer: string
Returns void
- Defined in model/Column.ts:678

setVisible

setVisible(value): void
Parameters
- value: boolean
Returns void
- Defined in model/Column.ts:256

setWidth

setWidth(value): void
Parameters
- value: number
Returns void
- Defined in model/Column.ts:281

setWidthImpl

setWidthImpl(value): void
Parameters
- value: number
Returns void
- Defined in model/Column.ts:292

show

show(): void
Returns void
- Defined in model/Column.ts:244

sortByMe

sortByMe(ascending?, priority?): boolean
triggers that the ranking is sorted by this column
Parameters
- ascending: boolean = ...
  ascending order?
- priority: number = 0
  sorting priority
Returns boolean
was successful
- Defined in model/Column.ts:329

toCompareGroupValue

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

toCompareGroupValueType

toCompareGroupValueType(): ECompareValueType | ECompareValueType[]
Returns ECompareValueType | ECompareValueType[]
- Defined in model/Column.ts:608

toCompareValue

toCompareValue(_row, _valueCache?): ICompareValue | ICompareValue[]
Parameters
- _row: IDataRow
- Optional _valueCache: any
Returns ICompareValue | ICompareValue[]
- Defined in model/Column.ts:583

toCompareValueType

toCompareValueType(): ECompareValueType | ECompareValueType[]
Returns ECompareValueType | ECompareValueType[]
- Defined in model/Column.ts:587

toggleMyGroupSorting

toggleMyGroupSorting(): boolean
Returns boolean
- Defined in model/Column.ts:400

toggleMySorting

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

Returns boolean
was successful
- Defined in model/Column.ts:361

`Protected` unforward

unforward(from, ...types): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- Rest ...types: string[]
  event types to forward
Returns void
Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146

Class Column

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Column

Properties

Readonly desc

parent

Static Readonly EVENT_DIRTY

Static Readonly EVENT_DIRTY_CACHES

Static Readonly EVENT_DIRTY_HEADER

Static Readonly EVENT_DIRTY_VALUES

Static Readonly EVENT_GROUP_RENDERER_TYPE_CHANGED

Static Readonly EVENT_LABEL_CHANGED

Static Readonly EVENT_METADATA_CHANGED

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

description

Returns string

fixed

Returns boolean

fqid

Returns string

fqpath

Returns string

frozen

Returns boolean

id

Returns string

label

Returns string

Methods

assignNewId

Parameters

Returns string

Returns void

attach

Parameters

Returns void

clearFilter

Returns boolean

Protected createEventList

Returns string[]

detach

Returns void

dump

Parameters

Parameters

Returns any

Returns any

filter

Parameters

Returns boolean

findMyRanker

Returns Ranking

Protected fire

Parameters

Returns void

flatten

Parameters

Returns number

Protected forward

Parameters

Returns void

getColor

Parameters

Returns string

getExportValue

Parameters

Returns any

`Readonly` desc

`Static` `Readonly` EVENT_DIRTY

`Static` `Readonly` EVENT_DIRTY_CACHES

`Static` `Readonly` EVENT_DIRTY_HEADER

`Static` `Readonly` EVENT_DIRTY_VALUES

`Static` `Readonly` EVENT_GROUP_RENDERER_TYPE_CHANGED

`Static` `Readonly` EVENT_LABEL_CHANGED

`Static` `Readonly` EVENT_METADATA_CHANGED

`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

`Protected` forward

Returns {
asHTML: boolean;
content: string;
}

Returns {
asHTML: boolean;
content: string;
}

Returns {
asc: "desc" | "asc";
priority: number;
}

Returns {
asc: "desc" | "asc";
priority: number;
}

`Protected` listenersChanged