CategoricalsColumn

a string column with optional alignment

Hierarchy

ArrayColumn<string | null>
- CategoricalsColumn

Implements

IEventHandler
IArrayColumn<string | null>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CategoricalsColumn(id: string, desc: Readonly<ICategoricalsColumnDesc>): CategoricalsColumn

Overrides ArrayColumn.constructor
- Defined in model/CategoricalsColumn.ts:15
Parameters
- id: string
- desc: Readonly<ICategoricalsColumnDesc>
Returns CategoricalsColumn

Properties

desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> | null = null

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

Static DEFAULT_COLOR

DEFAULT_COLOR: "#C1C1C1" = "#C1C1C1"

default color that should be used

type: {string}

Static EVENT_DATA_LOADED

EVENT_DATA_LOADED: "dataLoaded" = "dataLoaded"

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

EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = "rendererTypeChanged"

Static EVENT_SPLICE_CHANGED

EVENT_SPLICE_CHANGED: "spliceChanged" = "spliceChanged"

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

magic variable for showing all columns

type: {number}

Static RENDERER_LOADING

RENDERER_LOADING: "loading" = "loading"

Accessors

color

get color(): null | string

Inherited from Column.color
- Defined in model/Column.ts:210
Returns null | string

dataLength

get dataLength(): null | number

Inherited from ArrayColumn.dataLength
- Defined in model/ArrayColumn.ts:68
Returns null | number

description

get description(): string

Inherited from Column.description
- Defined in model/Column.ts:206
Returns string

fixed

get fixed(): boolean

Inherited from Column.fixed
- Defined in model/Column.ts:186
Returns boolean

fqid

get fqid(): string

Inherited from Column.fqid
- Defined in model/Column.ts:218
returns the fully qualified id i.e. path the parent

Returns string

fqpath

get fqpath(): string

Inherited from Column.fqpath
- Defined in model/Column.ts:222
Returns string

frozen

get frozen(): boolean

Inherited from Column.frozen
- Defined in model/Column.ts:190
Returns boolean

id

get id(): string

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

label

get label(): string

Inherited from Column.label
- Defined in model/Column.ts:202
Returns string

labels

get labels(): string[]

Inherited from ArrayColumn.labels
- Defined in model/ArrayColumn.ts:57
Returns string[]

Methods

assignNewId

assignNewId(idGenerator: function): void

Inherited from Column.assignNewId
- Defined in model/Column.ts:198
Parameters
- idGenerator: function
  - - (): string
    - Returns string
Returns void

attach

attach(parent: IColumnParent): void

Implementation of IArrayColumn.attach

Inherited from Column.attach
- Defined in model/Column.ts:425
called when the columns added to a ranking

Parameters
- parent: IColumnParent
Returns void

compare

compare(_a: IDataRow, _b: IDataRow): number

Implementation of IArrayColumn.compare

Inherited from Column.compare
- Defined in model/Column.ts:551
compare function used to determine the order according to the values of the current column

Parameters
- _a: IDataRow
  
  first element
- _b: IDataRow
  
  second element
Returns number

detach

detach(): void

Implementation of IArrayColumn.detach

Inherited from Column.detach
- Defined in model/Column.ts:432
called when the column is removed from the ranking

Returns void

dump

dump(toDescRef: function): any

Inherited from ValueColumn.dump

Overrides Column.dump
- Defined in model/ValueColumn.ts:115
patch the dump such that the loaded attribute is defined (for lazy loading columns)

Parameters
- toDescRef: function
  - - (desc: any): any
    - Parameters
      - desc: any
      Returns any
Returns any

filter

filter(row: IDataRow): boolean

Implementation of IArrayColumn.filter

Inherited from Column.filter
- Defined in model/Column.ts:587
predicate whether the current row should be included

Parameters
- row: IDataRow
Returns boolean

findMyRanker

findMyRanker(): Ranking | null

Implementation of IArrayColumn.findMyRanker

Inherited from Column.findMyRanker
- Defined in model/Column.ts:452
finds the underlying ranking column

Returns Ranking | null

my current ranking

flatten

flatten(r: IFlatColumn[], offset: number, _levelsToGo?: number, _padding?: number): number

Implementation of IArrayColumn.flatten

Inherited from Column.flatten
- Defined in model/Column.ts:283
visitor pattern for flattening the columns

Parameters
- r: IFlatColumn[]
  
  the result array
- offset: number
  
  left offset
- Default value _levelsToGo: number = 0
  
  how many levels down
- Default value _padding: number = 0
  
  padding between columns
Returns number

the used width by this column

getCategories

getCategories(row: IDataRow): (null | ICategory)[]

- Defined in model/CategoricalsColumn.ts:24
Parameters
- row: IDataRow
Returns (null | ICategory)[]

getColor

getColor(_row: IDataRow): null | string

Implementation of IArrayColumn.getColor

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

getExportValue

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

Implementation of IArrayColumn.getExportValue

Inherited from Column.getExportValue
- Defined in model/Column.ts:533
returns the value to be used when exporting

Parameters
- row: IDataRow
- format: "text" | "json"
  
  format hint
Returns any

getGroupRenderer

getGroupRenderer(): string

Implementation of IArrayColumn.getGroupRenderer

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

getLabel

getLabel(row: IDataRow): string

Implementation of IArrayColumn.getLabel

Inherited from ArrayColumn.getLabel

Overrides ValueColumn.getLabel
- Defined in model/ArrayColumn.ts:91
Parameters
- row: IDataRow
Returns string

getLabels

getLabels(row: IDataRow): string[]

Implementation of IArrayColumn.getLabels

Overrides ArrayColumn.getLabels
- Defined in model/CategoricalsColumn.ts:44
Parameters
- row: IDataRow
Returns string[]

getMap

getMap(row: IDataRow): object[]

Implementation of IArrayColumn.getMap

Inherited from ArrayColumn.getMap
- Defined in model/ArrayColumn.ts:99
Parameters
- row: IDataRow
Returns object[]

getMapLabel

getMapLabel(row: IDataRow): object[]

Implementation of IArrayColumn.getMapLabel

Inherited from ArrayColumn.getMapLabel
- Defined in model/ArrayColumn.ts:104
Parameters
- row: IDataRow
Returns object[]

getMetaData

getMetaData(): Readonly<IColumnMetaData>

Implementation of IArrayColumn.getMetaData

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

getRaw

getRaw(row: IDataRow): null | T

Inherited from ValueColumn.getRaw
- Defined in model/ValueColumn.ts:81
Parameters
- row: IDataRow
Returns null | T

getRenderer

getRenderer(): string

Implementation of IArrayColumn.getRenderer

Inherited from ValueColumn.getRenderer

Overrides Column.getRenderer
- Defined in model/ValueColumn.ts:103
Returns string

getSet

getSet(row: IDataRow): Set<null | ICategory>

- Defined in model/CategoricalsColumn.ts:34
Parameters
- row: IDataRow
Returns Set<null | ICategory>

getSplicer

getSplicer(): object

Inherited from ArrayColumn.getSplicer
- Defined in model/ArrayColumn.ts:64
Returns object

getSummaryRenderer

getSummaryRenderer(): string

Implementation of IArrayColumn.getSummaryRenderer

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

getValue

getValue(row: IDataRow): T[]

Implementation of IArrayColumn.getValue

Inherited from ArrayColumn.getValue

Overrides ValueColumn.getValue
- Defined in model/ArrayColumn.ts:75
Parameters
- row: IDataRow
Returns T[]

getValues

getValues(row: IDataRow): (null | string)[]

Implementation of IArrayColumn.getValues

Overrides ArrayColumn.getValues
- Defined in model/CategoricalsColumn.ts:40
Parameters
- row: IDataRow
Returns (null | string)[]

getVisible

getVisible(): boolean

Implementation of IArrayColumn.getVisible

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

getWidth

getWidth(): number

Implementation of IArrayColumn.getWidth

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

group

group(_row: IDataRow): IGroup

Implementation of IArrayColumn.group

Inherited from Column.group
- Defined in model/Column.ts:560
group the given row into a bin/group

Parameters
- _row: IDataRow
Returns IGroup

groupByMe

groupByMe(): boolean

Implementation of IArrayColumn.groupByMe

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

groupCompare

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

Implementation of IArrayColumn.groupCompare

Inherited from Column.groupCompare
- Defined in model/Column.ts:570
compares groups

Parameters
- a: IGroupData
- b: IGroupData
Returns number

groupSortByMe

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

Implementation of IArrayColumn.groupSortByMe

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

hide

hide(): void

Implementation of IArrayColumn.hide

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

insertAfterMe

insertAfterMe(col: Column): boolean

Implementation of IArrayColumn.insertAfterMe

Inherited from Column.insertAfterMe
- Defined in model/Column.ts:441
inserts the given column after itself

Parameters
- col: Column
  
  the column to insert
Returns boolean

was successful

isFiltered

isFiltered(): boolean

Implementation of IArrayColumn.isFiltered

Inherited from Column.isFiltered
- Defined in model/Column.ts:578
flag whether any filter is applied

Returns boolean

isGroupSortedByMe

isGroupSortedByMe(): object

Implementation of IArrayColumn.isGroupSortedByMe

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

isGroupedBy

isGroupedBy(): number

Implementation of IArrayColumn.isGroupedBy

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

isLoaded

isLoaded(): boolean

Inherited from ValueColumn.isLoaded
- Defined in model/ValueColumn.ts:92
Returns boolean

isMissing

isMissing(row: IDataRow): boolean

Implementation of IArrayColumn.isMissing

Inherited from Column.isMissing
- Defined in model/Column.ts:541
Parameters
- row: IDataRow
Returns boolean

isSortedByMe

isSortedByMe(): object

Implementation of IArrayColumn.isSortedByMe

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

isVisible

isVisible(): boolean

Implementation of IArrayColumn.isVisible

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

markDirty

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

Implementation of IArrayColumn.markDirty

Inherited from Column.markDirty
- Defined in model/Column.ts:663
marks the header, values, or both as dirty such that the values are reevaluated

Parameters
- Default value type: "header" | "values" | "all" = "all"
  
  specify in more detail what is dirty, by default whole column
Returns void

on

on(type: "spliceChanged", listener: spliceChanged | null): this
on(type: "dataLoaded", listener: dataLoaded | 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

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:113
Parameters
- type: "spliceChanged"
- listener: spliceChanged | null
Returns this
Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:114
Parameters
- type: "dataLoaded"
- listener: dataLoaded | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:115
Parameters
- type: "widthChanged"
- listener: widthChanged | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:116
Parameters
- type: "labelChanged"
- listener: labelChanged | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:117
Parameters
- type: "metaDataChanged"
- listener: metaDataChanged | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:118
Parameters
- type: "dirty"
- listener: dirty | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:119
Parameters
- type: "dirtyHeader"
- listener: dirtyHeader | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:120
Parameters
- type: "dirtyValues"
- listener: dirtyValues | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:121
Parameters
- type: "rendererTypeChanged"
- listener: rendererTypeChanged | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:122
Parameters
- type: "groupRendererChanged"
- listener: groupRendererChanged | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:123
Parameters
- type: "summaryRendererChanged"
- listener: summaryRendererChanged | null
Returns this
Implementation of IArrayColumn.on

Inherited from ArrayColumn.on

Overrides ValueColumn.on
- Defined in model/ArrayColumn.ts:124
Parameters
- type: "visibilityChanged"
- listener: visibilityChanged | null
Returns this

removeMe

removeMe(): boolean

Implementation of IArrayColumn.removeMe

Inherited from Column.removeMe
- Defined in model/Column.ts:412
removes the column from the ranking

Returns boolean

was successful

restore

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

Inherited from ValueColumn.restore

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

setGroupRenderer

setGroupRenderer(renderer: string): void

Implementation of IArrayColumn.setGroupRenderer

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

setLoaded

setLoaded(loaded: boolean): void

Inherited from ValueColumn.setLoaded
- Defined in model/ValueColumn.ts:96
Parameters
- loaded: boolean
Returns void

setMetaData

setMetaData(value: Readonly<IColumnMetaData>): void

Implementation of IArrayColumn.setMetaData

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

setRenderer

setRenderer(renderer: string): void

Implementation of IArrayColumn.setRenderer

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

setSplicer

setSplicer(splicer: Readonly<ISplicer>): void

Inherited from ArrayColumn.setSplicer
- Defined in model/ArrayColumn.ts:53
Parameters
- splicer: Readonly<ISplicer>
Returns void

setSummaryRenderer

setSummaryRenderer(renderer: string): void

Implementation of IArrayColumn.setSummaryRenderer

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

setVisible

setVisible(value: boolean): void

Implementation of IArrayColumn.setVisible

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

setWidth

setWidth(value: number): void

Implementation of IArrayColumn.setWidth

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

setWidthImpl

setWidthImpl(value: number): void

Implementation of IArrayColumn.setWidthImpl

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

show

show(): void

Implementation of IArrayColumn.show

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

sortByMe

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

Implementation of IArrayColumn.sortByMe

Inherited from Column.sortByMe
- Defined in model/Column.ts:328
triggers that the ranking is sorted by this column

Parameters
- Default value ascending: boolean = isSortingAscByDefault(this)
  
  ascending order?
- Default value priority: number = 0
  
  sorting priority
Returns boolean

was successful

toggleMyGroupSorting

toggleMyGroupSorting(): boolean

Implementation of IArrayColumn.toggleMyGroupSorting

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

toggleMySorting

toggleMySorting(): boolean

Implementation of IArrayColumn.toggleMySorting

Inherited from Column.toggleMySorting
- Defined in model/Column.ts:360
toggles the sorting order of this column in the ranking

Returns boolean

was successful

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

desc: Readonly<ICategoricalsColumnDesc>

Returns CategoricalsColumn

Properties

categories

desc

parent

Static DEFAULT_COLOR

Static EVENT_DATA_LOADED

Static EVENT_DIRTY

Static EVENT_DIRTY_HEADER

Static EVENT_DIRTY_VALUES

Static EVENT_GROUP_RENDERER_TYPE_CHANGED

Static EVENT_LABEL_CHANGED

Static EVENT_METADATA_CHANGED

Static EVENT_RENDERER_TYPE_CHANGED

Static EVENT_SPLICE_CHANGED

Static EVENT_SUMMARY_RENDERER_TYPE_CHANGED

Static EVENT_VISIBILITY_CHANGED

Static EVENT_WIDTH_CHANGED

Static FLAT_ALL_COLUMNS

Static RENDERER_LOADING

Accessors

color

Returns null | string

dataLength

Returns null | number

description

Returns string

fixed

Returns boolean

fqid

Returns string

fqpath

Returns string

frozen

Returns boolean

id

Returns string

label

Returns string

labels

Returns string[]

Methods

assignNewId

Parameters

idGenerator: function

Returns string

Returns void

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