Class NumberColumn

a number column mapped from an original input scale to an output range

Hierarchy (view full)

ValueColumn<number>
- NumberColumn

Implements

Index

Constructors

constructor

new NumberColumn(id, desc, factory): NumberColumn
Parameters
- id: string
- desc: INumberColumnDesc
- factory: ITypeFactory
Returns NumberColumn
Overrides ValueColumn.constructor
- Defined in model/NumberColumn.ts:117

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_COLOR_MAPPING_CHANGED

EVENT_COLOR_MAPPING_CHANGED: "colorMappingChanged" = 'colorMappingChanged'

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

EVENT_FILTER_CHANGED: "filterChanged" = 'filterChanged'

`Static` `Readonly` EVENT_GROUPING_CHANGED

EVENT_GROUPING_CHANGED: "groupingChanged" = 'groupingChanged'

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

EVENT_MAPPING_CHANGED: "mappingChanged" = 'mappingChanged'

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

EVENT_SORTMETHOD_CHANGED: "sortMethodChanged" = 'sortMethodChanged'

`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 INumberColumn.description
Inherited from ValueColumn.description
- Defined in model/Column.ts:186

fixed

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

fqpath

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

frozen

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

id

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

label

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

Methods

assignNewId

assignNewId(idGenerator): void
Parameters
- idGenerator: (() => string)
  - - (): string
    - Returns string
Returns void
Implementation of IMapAbleColumn.assignNewId
Inherited from ValueColumn.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 IMapAbleColumn.attach
Inherited from ValueColumn.attach
- Defined in model/Column.ts:429

clearFilter

clearFilter(): boolean
clear the filter

Returns boolean
whether the filtered needed to be reset
Implementation of IMapAbleColumn.clearFilter
Overrides ValueColumn.clearFilter
- Defined in model/NumberColumn.ts:415

`Protected` createEventList

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

Returns string[]
by default no events
Implementation of IMapAbleColumn.createEventList
Overrides ValueColumn.createEventList
- Defined in model/NumberColumn.ts:214

detach

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

Returns void
Implementation of IMapAbleColumn.detach
Inherited from ValueColumn.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 IMapAbleColumn.dump
Overrides ValueColumn.dump
- Defined in model/NumberColumn.ts:180

filter

filter(row): boolean
filter the current row if any filter is set
Parameters
- row: IDataRow
Returns boolean
Implementation of IMapAbleColumn.filter
Overrides ValueColumn.filter
- Defined in model/NumberColumn.ts:411

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

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

`Protected` fire

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

getColor

getColor(row): string
Parameters
- row: IDataRow
Returns string
Implementation of IMapAbleColumn.getColor
Overrides ValueColumn.getColor
- Defined in model/NumberColumn.ts:354

getColorMapping

getColorMapping(): IColorMappingFunction
Returns IColorMappingFunction
Implementation of IMapAbleColumn.getColorMapping
- Defined in model/NumberColumn.ts:362

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 IMapAbleColumn.getExportValue
Overrides ValueColumn.getExportValue
- Defined in model/NumberColumn.ts:280

getFilter

getFilter(): INumberFilter
Returns INumberFilter
Implementation of IMapAbleColumn.getFilter
- Defined in model/NumberColumn.ts:386

getGroupRenderer

getGroupRenderer(): string
Returns string
Implementation of IMapAbleColumn.getGroupRenderer
Inherited from ValueColumn.getGroupRenderer
- Defined in model/Column.ts:646

getGroupThresholds

getGroupThresholds(): number[]
Returns number[]
- Defined in model/NumberColumn.ts:421

getHeaderLabel

getHeaderLabel(ctx): {
asHTML: boolean;
content: string;
}
Parameters
- ctx: "header" | "sidePanel" | "reorder"
Returns {
asHTML: boolean;
content: string;
}
- asHTML: boolean
- content: string
Implementation of IMapAbleColumn.getHeaderLabel
Inherited from ValueColumn.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 IMapAbleColumn.getLabel
Overrides ValueColumn.getLabel
- Defined in model/NumberColumn.ts:248

getMapping

getMapping(): IMappingFunction
Returns IMappingFunction
Implementation of IMapAbleColumn.getMapping
- Defined in model/NumberColumn.ts:332

getMetaData

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

getNumber

getNumber(row): number
Parameters
- row: IDataRow
Returns number
Implementation of IMapAbleColumn.getNumber
- Defined in model/NumberColumn.ts:292

getNumberFormat

getNumberFormat(): ((n) => string)
Returns ((n) => string)
- - (n): string
  - Parameters
    - n: number
    Returns string
Implementation of IMapAbleColumn.getNumberFormat
- Defined in model/NumberColumn.ts:141

getOriginalMapping

getOriginalMapping(): IMappingFunction
Returns IMappingFunction
Implementation of IMapAbleColumn.getOriginalMapping
- Defined in model/NumberColumn.ts:328

getRange

getRange(): [string, string]
Returns [string, string]
Implementation of IMapAbleColumn.getRange
- Defined in model/NumberColumn.ts:268

getRaw

getRaw(row): number
Parameters
- row: IDataRow
Returns number
Inherited from ValueColumn.getRaw
- Defined in model/ValueColumn.ts:80

getRawNumber

getRawNumber(row): number
Parameters
- row: IDataRow
Returns number
Implementation of IMapAbleColumn.getRawNumber
- Defined in model/NumberColumn.ts:308

getRawValue

getRawValue(row): number
Parameters
- row: IDataRow
Returns number
- Defined in model/NumberColumn.ts:272

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

getSortMethod

getSortMethod(): EAdvancedSortMethod
Returns EAdvancedSortMethod
- Defined in model/NumberColumn.ts:474

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 IMapAbleColumn.getSummaryLabel
Inherited from ValueColumn.getSummaryLabel
- Defined in model/Column.ts:728

getSummaryRenderer

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

getValue

getValue(row): number
return the value of a given row for the current column
Parameters
- row: IDataRow
  the current row
Returns number
the value of this column at the specified row
Implementation of IMapAbleColumn.getValue
Overrides ValueColumn.getValue
- Defined in model/NumberColumn.ts:284

getVisible

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

getWidth

getWidth(): number
Returns number
Implementation of IMapAbleColumn.getWidth
Inherited from ValueColumn.getWidth
- Defined in model/Column.ts:236

group

group(row): IGroup
group the given row into a bin/group
Parameters
- row: IDataRow
Returns IGroup
Implementation of IMapAbleColumn.group
Overrides ValueColumn.group
- Defined in model/NumberColumn.ts:434

groupByMe

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

groupSortByMe

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

hide

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

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns boolean
Implementation of IMapAbleColumn.isFiltered
Overrides ValueColumn.isFiltered
- Defined in model/NumberColumn.ts:382

isGroupSortedByMe

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

isGroupedBy

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

isLoaded

isLoaded(): boolean
Returns boolean
Inherited from ValueColumn.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 IMapAbleColumn.isSortedByMe
Inherited from ValueColumn.isSortedByMe
- Defined in model/Column.ts:388

isVisible

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

iterNumber

iterNumber(row): number[]
Parameters
- row: IDataRow
Returns number[]
Implementation of IMapAbleColumn.iterNumber
- Defined in model/NumberColumn.ts:300

iterRawNumber

iterRawNumber(row): number[]
Parameters
- row: IDataRow
Returns number[]
Implementation of IMapAbleColumn.iterRawNumber
- Defined in model/NumberColumn.ts:304

`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 IMapAbleColumn.listenersChanged
Inherited from ValueColumn.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 IMapAbleColumn.markDirty
Inherited from ValueColumn.markDirty
- Defined in model/Column.ts:694

nextSibling

nextSibling(): Column
returns the next sibling

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

on

on(type, listener): this
Parameters
- type: "mappingChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the mapping property changes
      
      Parameters
      previous: IMappingFunction
      current: IMappingFunction
      Returns void
      As Member Of
      NumberColumn
      
      Group
      Events
Returns this
Implementation of IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:226
on(type, listener): this
Parameters
- type: "colorMappingChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the color mapping property changes
      
      Parameters
      previous: IColorMappingFunction
      current: IColorMappingFunction
      Returns void
      As Member Of
      NumberColumn
      
      Group
      Events
Returns this
Implementation of IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:227
on(type, listener): this
Parameters
- type: "filterChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the filter property changes
      
      Parameters
      previous: INumberFilter
      current: INumberFilter
      Returns void
      As Member Of
      NumberColumn
      
      Group
      Events
Returns this
Implementation of IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:228
on(type, listener): this
Parameters
- type: "sortMethodChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the sort method property changes
      
      Parameters
      previous: EAdvancedSortMethod
      current: EAdvancedSortMethod
      Returns void
      As Member Of
      NumberColumn
      
      Group
      Events
Returns this
Implementation of IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:229
on(type, listener): this
Parameters
- type: "groupingChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the grouping property changes
      
      Parameters
      previous: number[]
      current: number[]
      Returns void
      As Member Of
      NumberColumn
      
      Group
      Events
Returns this
Implementation of IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:230
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:231
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:232
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:233
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:234
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:235
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:236
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 IMapAbleColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:237
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 INumberColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:238
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 INumberColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:239
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 INumberColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:240
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 INumberColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:241
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 INumberColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:242
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of INumberColumn.on
Overrides ValueColumn.on
- Defined in model/NumberColumn.ts:243

onDataUpdate

onDataUpdate(rows): void
Parameters
- rows: ISequence<IDataRow>
Returns void
Overrides ValueColumn.onDataUpdate
- Defined in model/NumberColumn.ts:145

previousSibling

previousSibling(): Column
returns the previous sibling

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

removeMe

removeMe(): boolean
removes the column from the ranking

Returns boolean
was successful
Implementation of IMapAbleColumn.removeMe
Inherited from ValueColumn.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 IMapAbleColumn.restore
Overrides ValueColumn.restore
- Defined in model/NumberColumn.ts:192

setColorMapping

setColorMapping(mapping): void
Parameters
- mapping: IColorMappingFunction
Returns void
Implementation of IMapAbleColumn.setColorMapping
- Defined in model/NumberColumn.ts:366

setFilter

setFilter(value): void
Parameters
- value: INumberFilter
Returns void
Implementation of IMapAbleColumn.setFilter
- Defined in model/NumberColumn.ts:390

setGroupRenderer

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

setGroupThresholds

setGroupThresholds(value): void
Parameters
- value: number[]
Returns void
- Defined in model/NumberColumn.ts:425

setLoaded

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

setMapping

setMapping(mapping): void
Parameters
- mapping: IMappingFunction
Returns void
Implementation of IMapAbleColumn.setMapping
- Defined in model/NumberColumn.ts:336

setMetaData

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

setRenderer

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

setSortMethod

setSortMethod(sortMethod): void
Parameters
- sortMethod: EAdvancedSortMethod
Returns void
- Defined in model/NumberColumn.ts:478

setSummaryRenderer

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

setVisible

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

setWidth

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

setWidthImpl

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

show

show(): void
Returns void
Implementation of IMapAbleColumn.show
Inherited from ValueColumn.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 IMapAbleColumn.sortByMe
Inherited from ValueColumn.sortByMe
- Defined in model/Column.ts:329

toCompareGroupValue

toCompareGroupValue(rows, _group, valueCache?): number
Parameters
- rows: ISequence<IDataRow>
- _group: IGroup
- Optional valueCache: ISequence<any>
Returns number
Implementation of IMapAbleColumn.toCompareGroupValue
Overrides ValueColumn.toCompareGroupValue
- Defined in model/NumberColumn.ts:320

toCompareGroupValueType

toCompareGroupValueType(): ECompareValueType
Returns ECompareValueType
Implementation of IMapAbleColumn.toCompareGroupValueType
Overrides ValueColumn.toCompareGroupValueType
- Defined in model/NumberColumn.ts:324

toCompareValue

toCompareValue(row, valueCache?): any
Parameters
- row: IDataRow
- Optional valueCache: any
Returns any
Implementation of IMapAbleColumn.toCompareValue
Overrides ValueColumn.toCompareValue
- Defined in model/NumberColumn.ts:312

toCompareValueType

toCompareValueType(): ECompareValueType
Returns ECompareValueType
Implementation of IMapAbleColumn.toCompareValueType
Overrides ValueColumn.toCompareValueType
- Defined in model/NumberColumn.ts:316

toggleMyGroupSorting

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

Class NumberColumn

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NumberColumn

Properties

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_FILTER_CHANGED

Static Readonly EVENT_GROUPING_CHANGED

Static Readonly EVENT_GROUP_RENDERER_TYPE_CHANGED

Static Readonly EVENT_LABEL_CHANGED

Static Readonly EVENT_MAPPING_CHANGED

Static Readonly EVENT_METADATA_CHANGED

Static Readonly EVENT_RENDERER_TYPE_CHANGED

Static Readonly EVENT_SORTMETHOD_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

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

`Static` `Readonly` EVENT_GROUPING_CHANGED

`Static` `Readonly` EVENT_GROUP_RENDERER_TYPE_CHANGED

`Static` `Readonly` EVENT_LABEL_CHANGED

`Static` `Readonly` EVENT_MAPPING_CHANGED

`Static` `Readonly` EVENT_METADATA_CHANGED

`Static` `Readonly` EVENT_RENDERER_TYPE_CHANGED

`Static` `Readonly` EVENT_SORTMETHOD_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 {
asHTML: boolean;
content: string;
}

Returns {
asHTML: boolean;
content: string;
}