CategoricalsColumn

Hierarchy

ArrayColumn<string | null>
- CategoricalsColumn

Implements

IEventHandler
IArrayColumn<string | null>
ICategoricalLikeColumn<this> & IArrayColumn<null | string, this>

Index

Constructors

constructor

Events

colorMappingChanged_CCS

Properties

Accessors

Methods

Constructors

constructor

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

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

Events

colorMappingChanged_CCS

colorMappingChanged_CCS(previous: ICategoricalColorMappingFunction, current: ICategoricalColorMappingFunction): void

- Defined in model/CategoricalsColumn.ts:19
Parameters
- previous: ICategoricalColorMappingFunction
- current: ICategoricalColorMappingFunction
Returns void

Properties

desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> | null = null

Static EVENT_COLOR_MAPPING_CHANGED

EVENT_COLOR_MAPPING_CHANGED: "colorMappingChanged" = CategoricalColumn.EVENT_COLOR_MAPPING_CHANGED

Static EVENT_DATA_LOADED

EVENT_DATA_LOADED: "dataLoaded" = "dataLoaded"

Static EVENT_DIRTY

EVENT_DIRTY: "dirty" = "dirty"

Static EVENT_DIRTY_CACHES

EVENT_DIRTY_CACHES: "dirtyCaches" = "dirtyCaches"

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

Static RENDERER_LOADING

RENDERER_LOADING: "loading" = "loading"

Accessors

dataLength

dataLength:

description

description:

fixed

fixed:

fqid

fqid:

fqpath

fqpath:

frozen

frozen:

id

id:

label

label:

labels

labels:

Methods

assignNewId

assignNewId(idGenerator: function): void

Inherited from Column.assignNewId
- Defined in model/Column.ts:156
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:377
Parameters
- parent: IColumnParent
Returns void

clearFilter

clearFilter(): boolean

Implementation of IArrayColumn.clearFilter

Inherited from Column.clearFilter
- Defined in model/Column.ts:531
Returns boolean

whether the filtered needed to be reseted

detach

detach(): void

Implementation of IArrayColumn.detach

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

dump

dump(toDescRef: function): any

Overrides ValueColumn.dump
- Defined in model/CategoricalsColumn.ts:97
Parameters
- toDescRef: function
  - - (desc: any): any
    - Parameters
      - desc: any
      Returns any
Returns any

filter

filter(row: IDataRow, _valueCache: any): boolean

Implementation of IArrayColumn.filter

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

findMyRanker

findMyRanker(): Ranking | null

Implementation of IArrayColumn.findMyRanker

Inherited from Column.findMyRanker
- Defined in model/Column.ts:404
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:238
Parameters
- r: IFlatColumn[]
- offset: number
- Default value _levelsToGo: number = 0
- Default value _padding: number = 0
Returns number

the used width by this column

getCategories

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

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

getColor

getColor(_row: IDataRow): string

Implementation of IArrayColumn.getColor

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

getColorMapping

getColorMapping(): ICategoricalColorMappingFunction

- Defined in model/CategoricalsColumn.ts:89
Returns ICategoricalColorMappingFunction

getColors

getColors(row: IDataRow): string[]

- Defined in model/CategoricalsColumn.ts:73
Parameters
- row: IDataRow
Returns string[]

getExportValue

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

Implementation of IArrayColumn.getExportValue

Inherited from Column.getExportValue
- Defined in model/Column.ts:486
Parameters
- row: IDataRow
- format: "text" | "json"
Returns any

getGroupRenderer

getGroupRenderer(): string

Implementation of IArrayColumn.getGroupRenderer

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

getLabel

getLabel(row: IDataRow): string

Implementation of IArrayColumn.getLabel

Inherited from ArrayColumn.getLabel

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

getLabels

getLabels(row: IDataRow): string[]

Implementation of IArrayColumn.getLabels

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

getMap

getMap(row: IDataRow): object[]

Implementation of IArrayColumn.getMap

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

getMapLabel

getMapLabel(row: IDataRow): object[]

Implementation of IArrayColumn.getMapLabel

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

getMetaData

getMetaData(): Readonly<IColumnMetaData>

Implementation of IArrayColumn.getMetaData

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

getRaw

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

Inherited from ValueColumn.getRaw
- Defined in model/ValueColumn.ts:65
Parameters
- row: IDataRow
Returns (string | null)[] | null

getRenderer

getRenderer(): string

Implementation of IArrayColumn.getRenderer

Inherited from ValueColumn.getRenderer

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

getSummaryRenderer

getSummaryRenderer(): string

Implementation of IArrayColumn.getSummaryRenderer

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

getValue

getValue(row: IDataRow): null | T[]

Implementation of IArrayColumn.getValue

Inherited from ArrayColumn.getValue

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

getValues

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

Implementation of IArrayColumn.getValues

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

getVisible

getVisible(): boolean

Implementation of IArrayColumn.getVisible

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

getWidth

getWidth(): number

Implementation of IArrayColumn.getWidth

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

group

group(_row: IDataRow, _valueCache: any): IGroup

Implementation of IArrayColumn.group

Inherited from Column.group
- Defined in model/Column.ts:507
Parameters
- _row: IDataRow
- Optional _valueCache: any
Returns IGroup

groupByMe

groupByMe(): boolean

Implementation of IArrayColumn.groupByMe

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

groupSortByMe

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

Implementation of IArrayColumn.groupSortByMe

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

insertAfterMe

insertAfterMe(col: Column): boolean

Implementation of IArrayColumn.insertAfterMe

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

was successful

isFiltered

isFiltered(): boolean

Implementation of IArrayColumn.isFiltered

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

isGroupSortedByMe

isGroupSortedByMe(): object

Implementation of IArrayColumn.isGroupSortedByMe

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

isGroupedBy

isGroupedBy(): number

Implementation of IArrayColumn.isGroupedBy

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

isLoaded

isLoaded(): boolean

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

isSortedByMe

isSortedByMe(): object

Implementation of IArrayColumn.isSortedByMe

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

isVisible

isVisible(): boolean

Implementation of IArrayColumn.isVisible

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

iterCategory

iterCategory(row: IDataRow): (null | object)[]

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

markDirty

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

Implementation of IArrayColumn.markDirty

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

on

on(type: "colorMappingChanged", listener: colorMappingChanged_CCS | 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: "dirtyCaches", listener: dirtyCaches | 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

Overrides ValueColumn.on
- Defined in model/CategoricalsColumn.ts:45
Parameters
- type: "colorMappingChanged"
- listener: colorMappingChanged_CCS | null
Returns this
Overrides ValueColumn.on
- Defined in model/CategoricalsColumn.ts:46
Parameters
- type: "dataLoaded"
- listener: dataLoaded | null
Returns this
Implementation of IArrayColumn.on

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

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

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

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

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

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

Overrides ValueColumn.on
- Defined in model/CategoricalsColumn.ts:53
Parameters
- type: "dirtyCaches"
- listener: dirtyCaches | null
Returns this
Implementation of IArrayColumn.on

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

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

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

Overrides ValueColumn.on
- Defined in model/CategoricalsColumn.ts:57
Parameters
- type: "visibilityChanged"
- listener: visibilityChanged | null
Returns this
Implementation of IArrayColumn.on

Overrides ValueColumn.on
- Defined in model/CategoricalsColumn.ts:58
Parameters
- type: string | string[]
- listener: IEventListener | null
Returns this

removeMe

removeMe(): boolean

Implementation of IArrayColumn.removeMe

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

was successful

restore

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

Overrides ValueColumn.restore
- Defined in model/CategoricalsColumn.ts:103
Parameters
- dump: any
- factory: ITypeFactory
Returns void

setColorMapping

setColorMapping(mapping: ICategoricalColorMappingFunction): void

- Defined in model/CategoricalsColumn.ts:93
Parameters
- mapping: ICategoricalColorMappingFunction
Returns void

setGroupRenderer

setGroupRenderer(renderer: string): void

Implementation of IArrayColumn.setGroupRenderer

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

setLoaded

setLoaded(loaded: boolean): void

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

setMetaData

setMetaData(value: Readonly<IColumnMetaData>): void

Implementation of IArrayColumn.setMetaData

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

setRenderer

setRenderer(renderer: string): void

Implementation of IArrayColumn.setRenderer

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

setSummaryRenderer

setSummaryRenderer(renderer: string): void

Implementation of IArrayColumn.setSummaryRenderer

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

setVisible

setVisible(value: boolean): void

Implementation of IArrayColumn.setVisible

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

setWidth

setWidth(value: number): void

Implementation of IArrayColumn.setWidth

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

setWidthImpl

setWidthImpl(value: number): void

Implementation of IArrayColumn.setWidthImpl

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

show

show(): void

Implementation of IArrayColumn.show

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

sortByMe

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

Implementation of IArrayColumn.sortByMe

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

was successful

toCompareGroupValue

toCompareGroupValue(_rows: ISequence<IDataRow>, group: IGroup, _valueCache: ISequence<any>): ICompareValue | ICompareValue[]

Implementation of IArrayColumn.toCompareGroupValue

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

toCompareGroupValueType

toCompareGroupValueType(): ECompareValueType | ECompareValueType[]

Implementation of IArrayColumn.toCompareGroupValueType

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

toCompareValue

toCompareValue(_row: IDataRow, _valueCache: any): ICompareValue | ICompareValue[]

Implementation of IArrayColumn.toCompareValue

Inherited from Column.toCompareValue
- Defined in model/Column.ts:494
Parameters
- _row: IDataRow
- Optional _valueCache: any
Returns ICompareValue | ICompareValue[]

toCompareValueType

toCompareValueType(): ECompareValueType | ECompareValueType[]

Implementation of IArrayColumn.toCompareValueType

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

toggleMyGroupSorting

toggleMyGroupSorting(): boolean

Implementation of IArrayColumn.toggleMyGroupSorting

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

toggleMySorting

toggleMySorting(): boolean

Implementation of IArrayColumn.toggleMySorting

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

was successful

Hierarchy

Implements

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

desc: Readonly<ICategoricalsColumnDesc>

Returns CategoricalsColumn

Events

colorMappingChanged_CCS

Parameters

previous: ICategoricalColorMappingFunction

current: ICategoricalColorMappingFunction

Returns void

Properties

categories

desc

parent

Static EVENT_COLOR_MAPPING_CHANGED

Static EVENT_DATA_LOADED

Static EVENT_DIRTY

Static EVENT_DIRTY_CACHES

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_SUMMARY_RENDERER_TYPE_CHANGED

Static EVENT_VISIBILITY_CHANGED

Static EVENT_WIDTH_CHANGED

Static FLAT_ALL_COLUMNS

Static RENDERER_LOADING

Accessors

dataLength

description

fixed

fqid

fqpath

frozen

id

label

labels

Methods

assignNewId

Parameters

idGenerator: function

Returns string

Returns void

attach

Parameters

parent: IColumnParent

Returns void

clearFilter

Returns boolean

detach

Returns void

dump

Parameters

toDescRef: function

Parameters

desc: any

Returns any

Returns any

filter

Parameters

row: IDataRow

Optional _valueCache: any

Returns boolean

findMyRanker

Returns Ranking | null

flatten

Parameters

r: IFlatColumn[]