Class BoxPlotColumn

a column in LineUp

Hierarchy (view full)

ValueColumn<IBoxPlotData>
- BoxPlotColumn

Implements

IBoxPlotColumn

Index

Constructors

constructor

new BoxPlotColumn(id, desc, factory): BoxPlotColumn
Parameters
- id: string
- desc: Readonly<IBoxPlotColumnDesc>
- factory: ITypeFactory
Returns BoxPlotColumn
Overrides ValueColumn.constructor
- Defined in model/BoxPlotColumn.ts:99

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" = NumberColumn.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_FILTER_CHANGED

EVENT_FILTER_CHANGED: "filterChanged" = NumberColumn.EVENT_FILTER_CHANGED

`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" = NumberColumn.EVENT_MAPPING_CHANGED

`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" = NumberColumn.EVENT_SORTMETHOD_CHANGED

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

fixed

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

fqpath

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

frozen

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

id

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

label

get label(): string
Returns string
Implementation of IBoxPlotColumn.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 IBoxPlotColumn.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 IBoxPlotColumn.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 IBoxPlotColumn.clearFilter
Overrides ValueColumn.clearFilter
- Defined in model/BoxPlotColumn.ts:374

`Protected` createEventList

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

Returns string[]
by default no events
Implementation of IBoxPlotColumn.createEventList
Overrides ValueColumn.createEventList
- Defined in model/BoxPlotColumn.ts:275

detach

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

Returns void
Implementation of IBoxPlotColumn.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 IBoxPlotColumn.dump
Overrides ValueColumn.dump
- Defined in model/BoxPlotColumn.ts:250

filter

filter(row): boolean
predicate whether the current row should be included
Parameters
- row: IDataRow
Returns boolean
Implementation of IBoxPlotColumn.filter
Overrides ValueColumn.filter
- Defined in model/BoxPlotColumn.ts:370

findMyRanker

findMyRanker(): Ranking
finds the underlying ranking column

Returns Ranking
my current ranking
Implementation of IBoxPlotColumn.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 IBoxPlotColumn.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 IBoxPlotColumn.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 IBoxPlotColumn.forward
Inherited from ValueColumn.forward
- Defined in internal/AEventDispatcher.ts:137

getBoxPlotData

getBoxPlotData(row): IBoxPlotData
Parameters
- row: IDataRow
Returns IBoxPlotData
Implementation of IBoxPlotColumn.getBoxPlotData
- Defined in model/BoxPlotColumn.ts:160

getColor

getColor(row): string
Parameters
- row: IDataRow
Returns string
Implementation of IBoxPlotColumn.getColor
Overrides ValueColumn.getColor
- Defined in model/BoxPlotColumn.ts:333

getColorMapping

getColorMapping(): IColorMappingFunction
Returns IColorMappingFunction
Implementation of IBoxPlotColumn.getColorMapping
- Defined in model/BoxPlotColumn.ts:337

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 IBoxPlotColumn.getExportValue
Overrides ValueColumn.getExportValue
- Defined in model/BoxPlotColumn.ts:176

getFilter

getFilter(): INumberFilter
Returns INumberFilter
Implementation of IBoxPlotColumn.getFilter
- Defined in model/BoxPlotColumn.ts:362

getGroupRenderer

getGroupRenderer(): string
Returns string
Implementation of IBoxPlotColumn.getGroupRenderer
Inherited from ValueColumn.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 IBoxPlotColumn.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 IBoxPlotColumn.getLabel
Overrides ValueColumn.getLabel
- Defined in model/BoxPlotColumn.ts:226

getMapping

getMapping(): IMappingFunction
Returns IMappingFunction
Implementation of IBoxPlotColumn.getMapping
- Defined in model/BoxPlotColumn.ts:311

getMetaData

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

getNumber

getNumber(row): number
Parameters
- row: IDataRow
Returns number
Implementation of IBoxPlotColumn.getNumber
- Defined in model/BoxPlotColumn.ts:210

getNumberFormat

getNumberFormat(): ((n) => string)
Returns ((n) => string)
- - (n): string
  - Parameters
    - n: number
    Returns string
Implementation of IBoxPlotColumn.getNumberFormat
- Defined in model/BoxPlotColumn.ts:148

getOriginalMapping

getOriginalMapping(): IMappingFunction
Returns IMappingFunction
Implementation of IBoxPlotColumn.getOriginalMapping
- Defined in model/BoxPlotColumn.ts:307

getRange

getRange(): [string, string]
Returns [string, string]
Implementation of IBoxPlotColumn.getRange
- Defined in model/BoxPlotColumn.ts:164

getRaw

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

getRawBoxPlotData

getRawBoxPlotData(row): IBoxPlotData
Parameters
- row: IDataRow
Returns IBoxPlotData
Implementation of IBoxPlotColumn.getRawBoxPlotData
- Defined in model/BoxPlotColumn.ts:168

getRawNumber

getRawNumber(row): number
Parameters
- row: IDataRow
Returns number
Implementation of IBoxPlotColumn.getRawNumber
- Defined in model/BoxPlotColumn.ts:214

getRawValue

getRawValue(row): IBoxPlotData
Parameters
- row: IDataRow
Returns IBoxPlotData
- Defined in model/BoxPlotColumn.ts:172

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

getSortMethod

getSortMethod(): ESortMethod
Returns ESortMethod
Implementation of IBoxPlotColumn.getSortMethod
- Defined in model/BoxPlotColumn.ts:235

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

getSummaryRenderer

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

getValue

getValue(row): IBoxPlotData
return the value of a given row for the current column
Parameters
- row: IDataRow
  the current row
Returns IBoxPlotData
the value of this column at the specified row
Implementation of IBoxPlotColumn.getValue
Overrides ValueColumn.getValue
- Defined in model/BoxPlotColumn.ts:180

getVisible

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

getWidth

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

groupByMe

groupByMe(): boolean
Returns boolean
Implementation of IBoxPlotColumn.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 IBoxPlotColumn.groupSortByMe
Inherited from ValueColumn.groupSortByMe
- Defined in model/Column.ts:392

hide

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

isFiltered

isFiltered(): boolean
flag whether any filter is applied

Returns boolean
Implementation of IBoxPlotColumn.isFiltered
Overrides ValueColumn.isFiltered
- Defined in model/BoxPlotColumn.ts:358

isGroupSortedByMe

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

isGroupedBy

isGroupedBy(): number
Returns number
Implementation of IBoxPlotColumn.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 IBoxPlotColumn.isSortedByMe
Inherited from ValueColumn.isSortedByMe
- Defined in model/Column.ts:388

isVisible

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

iterNumber

iterNumber(row): number[]
Parameters
- row: IDataRow
Returns number[]
Implementation of IBoxPlotColumn.iterNumber
- Defined in model/BoxPlotColumn.ts:218

iterRawNumber

iterRawNumber(row): number[]
Parameters
- row: IDataRow
Returns number[]
Implementation of IBoxPlotColumn.iterRawNumber
- Defined in model/BoxPlotColumn.ts:222

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

nextSibling

nextSibling(): Column
returns the next sibling

Returns Column
Implementation of IBoxPlotColumn.nextSibling
Inherited from ValueColumn.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: IColorMappingFunction
      current: IColorMappingFunction
      Returns void
      As Member Of
      BoxPlotColumn
      
      Group
      Events
Returns this
Implementation of IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:286
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
      BoxPlotColumn
      
      Group
      Events
Returns this
Implementation of IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:287
on(type, listener): this
Parameters
- type: "sortMethodChanged"
- listener: ((previous, current) => void)
  - - (previous, current): void
    - emitted when the sort method property changes
      
      Parameters
      previous: ESortMethod
      current: ESortMethod
      Returns void
      As Member Of
      BoxPlotColumn
      
      Group
      Events
Returns this
Implementation of IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:288
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
      BoxPlotColumn
      
      Group
      Events
Returns this
Implementation of IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:289
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:290
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:291
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:292
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:293
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:294
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:295
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:296
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:297
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:298
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:299
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:300
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 IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:301
on(type, listener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Implementation of IBoxPlotColumn.on
Overrides ValueColumn.on
- Defined in model/BoxPlotColumn.ts:302

onDataUpdate

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

previousSibling

previousSibling(): Column
returns the previous sibling

Returns Column
Implementation of IBoxPlotColumn.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 IBoxPlotColumn.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 IBoxPlotColumn.restore
Overrides ValueColumn.restore
- Defined in model/BoxPlotColumn.ts:259

setColorMapping

setColorMapping(mapping): void
Parameters
- mapping: IColorMappingFunction
Returns void
Implementation of IBoxPlotColumn.setColorMapping
- Defined in model/BoxPlotColumn.ts:341

setFilter

setFilter(value): void
Parameters
- value: INumberFilter
Returns void
Implementation of IBoxPlotColumn.setFilter
- Defined in model/BoxPlotColumn.ts:366

setGroupRenderer

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

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 IBoxPlotColumn.setMapping
- Defined in model/BoxPlotColumn.ts:315

setMetaData

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

setRenderer

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

setSortMethod

setSortMethod(sort): void
Parameters
- sort: ESortMethod
Returns void
Implementation of IBoxPlotColumn.setSortMethod
- Defined in model/BoxPlotColumn.ts:239

setSummaryRenderer

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

setVisible

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

setWidth

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

setWidthImpl

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

show

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

toCompareGroupValueType

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

toCompareValue

toCompareValue(row): number
Parameters
- row: IDataRow
Returns number
Implementation of IBoxPlotColumn.toCompareValue
Overrides ValueColumn.toCompareValue
- Defined in model/BoxPlotColumn.ts:152

toCompareValueType

toCompareValueType(): ECompareValueType
Returns ECompareValueType
Implementation of IBoxPlotColumn.toCompareValueType
Overrides ValueColumn.toCompareValueType
- Defined in model/BoxPlotColumn.ts:156

toggleMyGroupSorting

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

Class BoxPlotColumn

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BoxPlotColumn

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

Parameters

`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_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;
}