Class CategoricalMapColumn

a column in LineUp

Hierarchy (view full)

MapColumn<string | null>
- CategoricalMapColumn

Implements

ICategoricalLikeColumn

Index

Constructors

constructor

new CategoricalMapColumn(id, desc): CategoricalMapColumn
Parameters
- id: string
- desc: Readonly<ICategoricalMapColumnDesc>
Returns CategoricalMapColumn
Overrides MapColumn.constructor
- Defined in model/CategoricalMapColumn.ts:54

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

`Static` `Readonly` EVENT_COLOR_MAPPING_CHANGED

EVENT_COLOR_MAPPING_CHANGED: "colorMappingChanged" = CategoricalColumn.EVENT_COLOR_MAPPING_CHANGED

`Static` `Readonly` EVENT_DATA_LOADED

EVENT_DATA_LOADED: "dataLoaded" = 'dataLoaded'

`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

`Static` `Readonly` RENDERER_LOADING

RENDERER_LOADING: "loading" = 'loading'

Accessors

description

get description(): string
Returns string
Implementation of ICategoricalLikeColumn.description
Inherited from MapColumn.description
- Defined in model/Column.ts:186

fixed

get fixed(): boolean
Returns boolean
Implementation of ICategoricalLikeColumn.fixed
Inherited from MapColumn.fixed
- Defined in model/Column.ts:166

fqid

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

Returns string
Implementation of ICategoricalLikeColumn.fqid
Inherited from MapColumn.fqid
- Defined in model/Column.ts:194

fqpath

get fqpath(): string
Returns string
Implementation of ICategoricalLikeColumn.fqpath
Inherited from MapColumn.fqpath
- Defined in model/Column.ts:198

frozen

get frozen(): boolean
Returns boolean
Implementation of ICategoricalLikeColumn.frozen
Inherited from MapColumn.frozen
- Defined in model/Column.ts:170

id

get id(): string
Returns string
Implementation of ICategoricalLikeColumn.id
Inherited from MapColumn.id
- Defined in model/Column.ts:174

label

get label(): string
Returns string
Implementation of ICategoricalLikeColumn.label
Inherited from MapColumn.label
- Defined in model/Column.ts:182

Methods

assignNewId

assignNewId(idGenerator): void
Parameters
- idGenerator: (() => string)
  - - (): string
    - Returns string
Returns void
Implementation of ICategoricalLikeColumn.assignNewId
Inherited from MapColumn.assignNewId
- Defined in model/Column.ts:178

attach

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

clearFilter

clearFilter(): boolean
clear the filter

Returns boolean
whether the filtered needed to be reset
Implementation of ICategoricalLikeColumn.clearFilter
Inherited from MapColumn.clearFilter
- 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
Implementation of ICategoricalLikeColumn.createEventList
Overrides MapColumn.createEventList
- Defined in model/CategoricalMapColumn.ts:84

detach

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

Returns void
Implementation of ICategoricalLikeColumn.detach
Inherited from MapColumn.detach
- 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
Implementation of ICategoricalLikeColumn.dump
Overrides MapColumn.dump
- Defined in model/CategoricalMapColumn.ts:160

filter

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

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

Returns Ranking
my current ranking
Implementation of ICategoricalLikeColumn.findMyRanker
Inherited from MapColumn.findMyRanker
- Defined in model/Column.ts:492

`Protected` fire

fire(type, ...args): void
Parameters
- type: string | string[]
- Rest ...args: any[]
Returns void
Implementation of ICategoricalLikeColumn.fire
Inherited from MapColumn.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
Implementation of ICategoricalLikeColumn.flatten
Inherited from MapColumn.flatten
- 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
Implementation of ICategoricalLikeColumn.forward
Inherited from MapColumn.forward
- Defined in internal/AEventDispatcher.ts:137

getCategories

getCategories(row): Readonly<ICategory>[]
Parameters
- row: IDataRow
Returns Readonly<ICategory>[]
Implementation of ICategoricalLikeColumn.getCategories
- Defined in model/CategoricalMapColumn.ts:124

getCategoryMap

getCategoryMap(row): {
key: string;
value: Readonly<ICategory>;
}[]
Parameters
- row: IDataRow
Returns {
key: string;
value: Readonly<ICategory>;
}[]
- Defined in model/CategoricalMapColumn.ts:117

getColor

getColor(_row): string
Parameters
- _row: IDataRow
Returns string
Implementation of ICategoricalLikeColumn.getColor
Inherited from MapColumn.getColor
- Defined in model/Column.ts:579

getColorMapping

getColorMapping(): ICategoricalColorMappingFunction
Returns ICategoricalColorMappingFunction
Implementation of ICategoricalLikeColumn.getColorMapping
- Defined in model/CategoricalMapColumn.ts:152

getColors

getColors(row): {
key: string;
value: string;
}[]
Parameters
- row: IDataRow
Returns {
key: string;
value: string;
}[]
- Defined in model/CategoricalMapColumn.ts:128

getExportValue

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

getGroupRenderer

getGroupRenderer(): string
Returns string
Implementation of ICategoricalLikeColumn.getGroupRenderer
Inherited from MapColumn.getGroupRenderer
- 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
Implementation of ICategoricalLikeColumn.getHeaderLabel
Inherited from MapColumn.getHeaderLabel
- 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
Implementation of ICategoricalLikeColumn.getLabel
Inherited from MapColumn.getLabel
- Defined in model/MapColumn.ts:38

getLabels

getLabels(row): {
key: string;
value: string;
}[]
Parameters
- row: IDataRow
Returns {
key: string;
value: string;
}[]
Overrides MapColumn.getLabels
- Defined in model/CategoricalMapColumn.ts:145

getMap

getMap(row): IKeyValue<string>[]
Parameters
- row: IDataRow
Returns IKeyValue<string>[]
Inherited from MapColumn.getMap
- Defined in model/MapColumn.ts:30

getMapLabel

getMapLabel(row): IKeyValue<string>[]
Parameters
- row: IDataRow
Returns IKeyValue<string>[]
Inherited from MapColumn.getMapLabel
- Defined in model/MapColumn.ts:34

getMetaData

getMetaData(): Readonly<IColumnMetaData>
Returns Readonly<IColumnMetaData>
Implementation of ICategoricalLikeColumn.getMetaData
Inherited from MapColumn.getMetaData
- Defined in model/Column.ts:319

getRaw

getRaw(row): IKeyValue<string>[]
Parameters
- row: IDataRow
Returns IKeyValue<string>[]
Inherited from MapColumn.getRaw
- Defined in model/ValueColumn.ts:80

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
Implementation of ICategoricalLikeColumn.getRenderer
Inherited from MapColumn.getRenderer
- Defined in model/ValueColumn.ts:112

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
Implementation of ICategoricalLikeColumn.getSummaryLabel
Inherited from MapColumn.getSummaryLabel
- Defined in model/Column.ts:728

getSummaryRenderer

getSummaryRenderer(): string
Returns string
Implementation of ICategoricalLikeColumn.getSummaryRenderer
Inherited from MapColumn.getSummaryRenderer
- Defined in model/Column.ts:650

getValue

getValue(row): {
key: string;
value: string;
}[]
return the value of a given row for the current column
Parameters
- row: IDataRow
  the current row
Returns {
key: string;
value: string;
}[]
the value of this column at the specified row
Implementation of ICategoricalLikeColumn.getValue
Overrides MapColumn.getValue
- Defined in model/CategoricalMapColumn.ts:135

getVisible

getVisible(): boolean
Returns boolean
Implementation of ICategoricalLikeColumn.getVisible
Inherited from MapColumn.getVisible
- Defined in model/Column.ts:252

getWidth

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

groupByMe

groupByMe(): boolean
Returns boolean
Implementation of ICategoricalLikeColumn.groupByMe
Inherited from MapColumn.groupByMe
- Defined in model/Column.ts:337

groupSortByMe

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

hide

hide(): void
Returns void
Implementation of ICategoricalLikeColumn.hide
Inherited from MapColumn.hide
- 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
Implementation of ICategoricalLikeColumn.insertAfterMe
Inherited from MapColumn.insertAfterMe
- 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
Implementation of ICategoricalLikeColumn.insertBeforeMe
Inherited from MapColumn.insertBeforeMe
- Defined in model/Column.ts:457

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns boolean
Implementation of ICategoricalLikeColumn.isFiltered
Inherited from MapColumn.isFiltered
- Defined in model/Column.ts:616

isGroupSortedByMe

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

isGroupedBy

isGroupedBy(): number
Returns number
Implementation of ICategoricalLikeColumn.isGroupedBy
Inherited from MapColumn.isGroupedBy
- Defined in model/Column.ts:349

isLoaded

isLoaded(): boolean
Returns boolean
Inherited from MapColumn.isLoaded
- Defined in model/ValueColumn.ts:91

isSortedByMe

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

isVisible

isVisible(): boolean
Returns boolean
Implementation of ICategoricalLikeColumn.isVisible
Inherited from MapColumn.isVisible
- Defined in model/Column.ts:248

iterCategory

iterCategory(row): Readonly<ICategory>[]
Parameters
- row: IDataRow
Returns Readonly<ICategory>[]
Implementation of ICategoricalLikeColumn.iterCategory
- Defined in model/CategoricalMapColumn.ts:171

`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
Implementation of ICategoricalLikeColumn.listenersChanged
Inherited from MapColumn.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
Implementation of ICategoricalLikeColumn.markDirty
Inherited from MapColumn.markDirty
- Defined in model/Column.ts:694

nextSibling

nextSibling(): Column
returns the next sibling

Returns Column
Implementation of ICategoricalLikeColumn.nextSibling
Inherited from MapColumn.nextSibling
- Defined in model/Column.ts:468

on

on(type, listener): this
Parameters
- type: "colorMappingChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the color mapping property changes
      
      Parameters
      previous: ICategoricalColorMappingFunction
      current: ICategoricalColorMappingFunction
      Returns void
      As Member Of
      CategoricalMapColumn
      
      Group
      Events
Returns this
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:88
on(type, listener): this
Parameters
- type: "dataLoaded"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the data of this column has been loaded
      
      Parameters
      previous: boolean
      current: boolean
      Returns void
      As Member Of
      ValueColumn
      
      Group
      Events
Returns this
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:92
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:93
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:94
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:95
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:96
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:97
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:98
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:99
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:100
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:101
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:102
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
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:103
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of ICategoricalLikeColumn.on
Overrides MapColumn.on
- Defined in model/CategoricalMapColumn.ts:104

onDataUpdate

onDataUpdate(rows): void
Parameters
- rows: ISequence<IDataRow>
Returns void
Overrides MapColumn.onDataUpdate
- Defined in model/CategoricalMapColumn.ts:61

previousSibling

previousSibling(): Column
returns the previous sibling

Returns Column
Implementation of ICategoricalLikeColumn.previousSibling
Inherited from MapColumn.previousSibling
- Defined in model/Column.ts:480

removeMe

removeMe(): boolean
removes the column from the ranking

Returns boolean
was successful
Implementation of ICategoricalLikeColumn.removeMe
Inherited from MapColumn.removeMe
- Defined in model/Column.ts:416

restore

restore(dump, factory): void
restore the column content from a dump
Parameters
- dump: any
  column dump
- factory: ITypeFactory
  helper for creating columns
Returns void
Implementation of ICategoricalLikeColumn.restore
Overrides MapColumn.restore
- Defined in model/CategoricalMapColumn.ts:166

setColorMapping

setColorMapping(mapping): void
Parameters
- mapping: ICategoricalColorMappingFunction
Returns void
Implementation of ICategoricalLikeColumn.setColorMapping
- Defined in model/CategoricalMapColumn.ts:156

setGroupRenderer

setGroupRenderer(renderer): void
Parameters
- renderer: string
Returns void
Implementation of ICategoricalLikeColumn.setGroupRenderer
Inherited from MapColumn.setGroupRenderer
- Defined in model/Column.ts:666

setLoaded

setLoaded(loaded): void
Parameters
- loaded: boolean
Returns void
Inherited from MapColumn.setLoaded
- Defined in model/ValueColumn.ts:95

setMetaData

setMetaData(value): void
Parameters
- value: Readonly<IColumnMetaData>
Returns void
Implementation of ICategoricalLikeColumn.setMetaData
Inherited from MapColumn.setMetaData
- Defined in model/Column.ts:296

setRenderer

setRenderer(renderer): void
Parameters
- renderer: string
Returns void
Implementation of ICategoricalLikeColumn.setRenderer
Inherited from MapColumn.setRenderer
- Defined in model/Column.ts:654

setSummaryRenderer

setSummaryRenderer(renderer): void
Parameters
- renderer: string
Returns void
Implementation of ICategoricalLikeColumn.setSummaryRenderer
Inherited from MapColumn.setSummaryRenderer
- Defined in model/Column.ts:678

setVisible

setVisible(value): void
Parameters
- value: boolean
Returns void
Implementation of ICategoricalLikeColumn.setVisible
Inherited from MapColumn.setVisible
- Defined in model/Column.ts:256

setWidth

setWidth(value): void
Parameters
- value: number
Returns void
Implementation of ICategoricalLikeColumn.setWidth
Inherited from MapColumn.setWidth
- Defined in model/Column.ts:281

setWidthImpl

setWidthImpl(value): void
Parameters
- value: number
Returns void
Implementation of ICategoricalLikeColumn.setWidthImpl
Inherited from MapColumn.setWidthImpl
- Defined in model/Column.ts:292

show

show(): void
Returns void
Implementation of ICategoricalLikeColumn.show
Inherited from MapColumn.show
- 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
Implementation of ICategoricalLikeColumn.sortByMe
Inherited from MapColumn.sortByMe
- 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[]
Implementation of ICategoricalLikeColumn.toCompareGroupValue
Inherited from MapColumn.toCompareGroupValue
- Defined in model/Column.ts:600

toCompareGroupValueType

toCompareGroupValueType(): ECompareValueType | ECompareValueType[]
Returns ECompareValueType | ECompareValueType[]
Implementation of ICategoricalLikeColumn.toCompareGroupValueType
Inherited from MapColumn.toCompareGroupValueType
- Defined in model/Column.ts:608

toCompareValue

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

toCompareValueType

toCompareValueType(): ECompareValueType | ECompareValueType[]
Returns ECompareValueType | ECompareValueType[]
Implementation of ICategoricalLikeColumn.toCompareValueType
Inherited from MapColumn.toCompareValueType
- Defined in model/Column.ts:587

toggleMyGroupSorting

toggleMyGroupSorting(): boolean
Returns boolean
Implementation of ICategoricalLikeColumn.toggleMyGroupSorting
Inherited from MapColumn.toggleMyGroupSorting
- Defined in model/Column.ts:400

toggleMySorting

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

Returns boolean
was successful
Implementation of ICategoricalLikeColumn.toggleMySorting
Inherited from MapColumn.toggleMySorting
- 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
Implementation of ICategoricalLikeColumn.unforward
Inherited from MapColumn.unforward
- Defined in internal/AEventDispatcher.ts:146

Class CategoricalMapColumn

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CategoricalMapColumn

Properties

Readonly categories

Readonly desc

parent

Static Readonly EVENT_COLOR_MAPPING_CHANGED

Static Readonly EVENT_DATA_LOADED

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

Static Readonly RENDERER_LOADING

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

getCategories

`Readonly` categories

`Readonly` desc

`Static` `Readonly` EVENT_COLOR_MAPPING_CHANGED

`Static` `Readonly` EVENT_DATA_LOADED

`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

`Static` `Readonly` RENDERER_LOADING

`Protected` createEventList

`Protected` fire

`Protected` forward

Returns {
key: string;
value: Readonly<ICategory>;
}[]

Returns {
key: string;
value: string;
}[]

Returns {
asHTML: boolean;
content: string;
}

Returns {
key: string;
value: string;
}[]

Returns {
asHTML: boolean;
content: string;
}

Returns {
key: string;
value: string;
}[]