Interface ICategoricalLikeColumn

a column in LineUp

Hierarchy

Column
- ICategoricalLikeColumn
  - ISetColumn

Implemented by

CategoricalMapColumn

Properties

`Readonly` categories

categories: ICategory[]

`Readonly` desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> = null

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

Accessors

description

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

fixed

get fixed(): boolean
Returns boolean
Inherited from Column.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 Column.fqid
- Defined in model/Column.ts:191

fqpath

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

frozen

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

id

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

label

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

Methods

assignNewId

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

attach

attach(parent: IColumnParent): void
called when the columns added to a ranking
Parameters
- parent: IColumnParent
Returns void
Inherited from Column.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 Column.clearFilter
- Defined in model/Column.ts:621

`Protected` createEventList

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

Returns
by default no events

Returns string[]
Inherited from Column.createEventList
- Defined in model/Column.ts:199

detach

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

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

filter

filter(row: IDataRow, _valueCache?: any): boolean
predicate whether the current row should be included

Returns
Parameters
- row: IDataRow
- Optional _valueCache: any
Returns boolean
Inherited from Column.filter
- Defined in model/Column.ts:631

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

Returns
my current ranking

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

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

getCategories

getCategories(row: IDataRow): ICategory[]
Parameters
- row: IDataRow
Returns ICategory[]
- Defined in model/ICategoricalColumn.ts:38

getColor

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

getColorMapping

getColorMapping(): ICategoricalColorMappingFunction
Returns ICategoricalColorMappingFunction
- Defined in model/ICategoricalColumn.ts:33

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

getGroupRenderer

getGroupRenderer(): string
Returns string
Inherited from Column.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
Inherited from Column.getLabel
- Defined in model/Column.ts:554

getMetaData

getMetaData(): Readonly<IColumnMetaData>
Returns Readonly<IColumnMetaData>
Inherited from Column.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 Column.getRenderer
- Defined in model/Column.ts:639

getSummaryRenderer

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

getValue

getValue(_row: IDataRow): any
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 any
Inherited from Column.getValue
- Defined in model/Column.ts:564

getVisible

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

getWidth

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

groupByMe

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

groupSortByMe

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

hide

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

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

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

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns

Returns boolean
Inherited from Column.isFiltered
- Defined in model/Column.ts:613

isGroupSortedByMe

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

isGroupedBy

isGroupedBy(): number
Returns

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

isSortedByMe

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

isVisible

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

iterCategory

iterCategory(row: IDataRow): IForEachAble<ICategory>
Parameters
- row: IDataRow
Returns IForEachAble<ICategory>
- Defined in model/ICategoricalColumn.ts:36

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

nextSibling

nextSibling(): Column
returns the next sibling

Returns

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

on

on(type: "widthChanged", listener: ((previous: number, current: number) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:217
on(type: "labelChanged", listener: ((previous: string, current: string) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:218
on(type: "metaDataChanged", listener: ((previous: IColumnMetaData, current: IColumnMetaData) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:219
on(type: "dirty", listener: (() => void)): ICategoricalLikeColumn
Parameters
- type: "dirty"
- listener: (() => void)
  - - (): void
    - emitted when state of the column is dirty
      
      As Member Of
      Column
      
      Group
      Events
      
      Returns void
Returns ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:220
on(type: "dirtyHeader", listener: (() => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:221
on(type: "dirtyValues", listener: (() => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:222
on(type: "dirtyCaches", listener: (() => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:223
on(type: "rendererTypeChanged", listener: ((previous: string, current: string) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:224
on(type: "groupRendererChanged", listener: ((previous: string, current: string) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:225
on(type: "summaryRendererChanged", listener: ((previous: string, current: string) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:226
on(type: "visibilityChanged", listener: ((previous: boolean, current: boolean) => void)): ICategoricalLikeColumn
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 ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:227
on(type: string | string[], listener: IEventListener): ICategoricalLikeColumn
Parameters
- type: string | string[]
- listener: IEventListener
Returns ICategoricalLikeColumn
Inherited from Column.on
- Defined in model/Column.ts:228

previousSibling

previousSibling(): Column
returns the previous sibling

Returns

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

removeMe

removeMe(): boolean
removes the column from the ranking

Returns
was successful

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

restore

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

setColorMapping

setColorMapping(mapping: ICategoricalColorMappingFunction): void
Parameters
- mapping: ICategoricalColorMappingFunction
Returns void
- Defined in model/ICategoricalColumn.ts:34

setGroupRenderer

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

setMetaData

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

setRenderer

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

setSummaryRenderer

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

setVisible

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

setWidth

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

setWidthImpl

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

show

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

toCompareGroupValueType

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

toCompareValue

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

toCompareValueType

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

toggleMyGroupSorting

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

Interface ICategoricalLikeColumn

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

Readonly categories

Readonly desc

parent

Accessors

description

Returns string

fixed

Returns boolean

fqid

Returns

Returns string

fqpath

Returns string

frozen

Returns boolean

id

Returns string

label

Returns string

Methods

assignNewId

Parameters

idGenerator: (() => string)

Returns string

Returns void

attach

Parameters

parent: IColumnParent

Returns void

clearFilter

Returns

Returns boolean

Protected createEventList

Returns

Returns string[]

detach

Returns void

dump

Returns

Parameters

toDescRef: ((desc: any) => any)

Parameters

desc: any

Returns any

Returns any

filter

Returns

Parameters

row: IDataRow

Optional _valueCache: any

Returns boolean

findMyRanker

Returns

Returns Ranking

Protected fire

Parameters

type: string | string[]

Rest ...args: any[]

Returns void

flatten

Returns

Parameters

r: IFlatColumn[]

offset: number

_levelsToGo: number = 0

_padding: number = 0

Returns number

Protected forward

Parameters

from: IEventHandler

Rest ...types: string[]

Returns void

`Readonly` categories

`Readonly` desc

`Protected` createEventList

`Optional` _valueCache: any

`Protected` fire

`Rest` ...args: any[]

`Protected` forward

`Rest` ...types: string[]

`Optional` _valueCache: any