Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ValueColumn<T>

a column having an accessor to get the cell value

Type parameters

  • T

Hierarchy

Implements

Index

Constructors

constructor

Events

dataLoaded

  • dataLoaded(previous: boolean, current: boolean): void
  • emitted when the data of this column has been loaded

    asmemberof

    ValueColumn

    Parameters

    • previous: boolean
    • current: boolean

    Returns void

Properties

desc

desc: Readonly<IColumnDesc>

parent

parent: Readonly<IColumnParent> | null = null

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

Static DEFAULT_COLOR

DEFAULT_COLOR: "#C1C1C1" = "#C1C1C1"

default color that should be used

type

{string}

Static EVENT_DATA_LOADED

EVENT_DATA_LOADED: "dataLoaded" = "dataLoaded"

Static EVENT_DIRTY

EVENT_DIRTY: "dirty" = "dirty"

Static EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = "dirtyHeader"

Static EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = "dirtyValues"

Static EVENT_GROUP_RENDERER_TYPE_CHANGED

EVENT_GROUP_RENDERER_TYPE_CHANGED: "groupRendererChanged" = "groupRendererChanged"

Static EVENT_LABEL_CHANGED

EVENT_LABEL_CHANGED: "labelChanged" = "labelChanged"

Static EVENT_METADATA_CHANGED

EVENT_METADATA_CHANGED: "metaDataChanged" = "metaDataChanged"

Static EVENT_RENDERER_TYPE_CHANGED

EVENT_RENDERER_TYPE_CHANGED: "rendererTypeChanged" = "rendererTypeChanged"

Static EVENT_SUMMARY_RENDERER_TYPE_CHANGED

EVENT_SUMMARY_RENDERER_TYPE_CHANGED: "summaryRendererChanged" = "summaryRendererChanged"

Static EVENT_VISIBILITY_CHANGED

EVENT_VISIBILITY_CHANGED: "visibilityChanged" = "visibilityChanged"

Static EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = "widthChanged"

Static FLAT_ALL_COLUMNS

FLAT_ALL_COLUMNS: -1 = -1

magic variable for showing all columns

type

{number}

Static RENDERER_LOADING

RENDERER_LOADING: "loading" = "loading"

Accessors

color

  • get color(): null | string

description

  • get description(): string

fixed

  • get fixed(): boolean

fqid

  • get fqid(): string

fqpath

  • get fqpath(): string

frozen

  • get frozen(): boolean

id

  • get id(): string

label

  • get label(): string

Methods

assignNewId

  • assignNewId(idGenerator: function): void

attach

compare

detach

  • detach(): void

dump

  • dump(toDescRef: function): any
  • patch the dump such that the loaded attribute is defined (for lazy loading columns)

    Parameters

    • toDescRef: function
        • (desc: any): any
        • Parameters

          • desc: any

          Returns any

    Returns any

filter

findMyRanker

flatten

  • flatten(r: IFlatColumn[], offset: number, _levelsToGo?: number, _padding?: number): number
  • visitor pattern for flattening the columns

    Parameters

    • r: IFlatColumn[]

      the result array

    • offset: number

      left offset

    • Default value _levelsToGo: number = 0

      how many levels down

    • Default value _padding: number = 0

      padding between columns

    Returns number

    the used width by this column

getColor

  • getColor(_row: IDataRow): null | string

getExportValue

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

getGroupRenderer

  • getGroupRenderer(): string

getLabel

getMetaData

getRaw

getRenderer

  • getRenderer(): string

getSummaryRenderer

  • getSummaryRenderer(): string

getValue

getVisible

  • getVisible(): boolean

getWidth

  • getWidth(): number

group

groupByMe

  • groupByMe(): boolean

groupCompare

groupSortByMe

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

    • Default value ascending: boolean = isSortingAscByDefault(this)
    • Default value priority: number = 0

    Returns boolean

hide

  • hide(): void

insertAfterMe

  • insertAfterMe(col: Column): boolean

isFiltered

  • isFiltered(): boolean

isGroupSortedByMe

  • isGroupSortedByMe(): object

isGroupedBy

  • isGroupedBy(): number

isLoaded

  • isLoaded(): boolean

isMissing

isSortedByMe

  • isSortedByMe(): object

isVisible

  • isVisible(): boolean

markDirty

  • markDirty(type?: "header" | "values" | "all"): void
  • marks the header, values, or both as dirty such that the values are reevaluated

    Parameters

    • Default value type: "header" | "values" | "all" = "all"

      specify in more detail what is dirty, by default whole column

    Returns void

on

removeMe

  • removeMe(): boolean

restore

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

setGroupRenderer

  • setGroupRenderer(renderer: string): void

setLoaded

  • setLoaded(loaded: boolean): void

setMetaData

setRenderer

  • setRenderer(renderer: string): void

setSummaryRenderer

  • setSummaryRenderer(renderer: string): void

setVisible

  • setVisible(value: boolean): void

setWidth

  • setWidth(value: number): void

setWidthImpl

  • setWidthImpl(value: number): void

show

  • show(): void

sortByMe

  • sortByMe(ascending?: boolean, priority?: number): boolean
  • triggers that the ranking is sorted by this column

    Parameters

    • Default value ascending: boolean = isSortingAscByDefault(this)

      ascending order?

    • Default value priority: number = 0

      sorting priority

    Returns boolean

    was successful

toggleMyGroupSorting

  • toggleMyGroupSorting(): boolean

toggleMySorting

  • toggleMySorting(): boolean