Class CategoricalsColumn

a string column with optional alignment

Hierarchy (view full)

Implements

Constructors

constructor

Properties

categories desc parent EVENT_COLOR_MAPPING_CHANGED EVENT_DATA_LOADED EVENT_DIRTY EVENT_DIRTY_CACHES EVENT_DIRTY_HEADER EVENT_DIRTY_VALUES EVENT_GROUP_RENDERER_TYPE_CHANGED EVENT_LABEL_CHANGED EVENT_METADATA_CHANGED EVENT_RENDERER_TYPE_CHANGED EVENT_SUMMARY_RENDERER_TYPE_CHANGED EVENT_VISIBILITY_CHANGED EVENT_WIDTH_CHANGED FLAT_ALL_COLUMNS RENDERER_LOADING

Accessors

dataLength description fixed fqid fqpath frozen id label labels

Methods

assignNewId attach clearFilter createEventList detach dump filter findMyRanker fire flatten forward getCategories getColor getColorMapping getColors getExportValue getGroupRenderer getHeaderLabel getLabel getLabels getMap getMapLabel getMetaData getRaw getRenderer getSummaryLabel getSummaryRenderer getValue getValues getVisible getWidth group groupByMe groupSortByMe hide insertAfterMe insertBeforeMe isFiltered isGroupSortedByMe isGroupedBy isLoaded isSortedByMe isVisible iterCategory listenersChanged markDirty nextSibling on onDataUpdate previousSibling removeMe restore setColorMapping setGroupRenderer setLoaded setMetaData setRenderer setSummaryRenderer setVisible setWidth setWidthImpl show sortByMe toCompareGroupValue toCompareGroupValueType toCompareValue toCompareValueType toggleMyGroupSorting toggleMySorting unforward

Constructors

constructor

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

dataLength

  • get dataLength(): number

  • Returns number

description

  • get description(): string

  • Returns string

fixed

  • get fixed(): boolean

  • Returns boolean

fqid

  • get fqid(): string

  • returns the fully qualified id i.e. path the parent

    Returns string

fqpath

  • get fqpath(): string

  • Returns string

frozen

  • get frozen(): boolean

  • Returns boolean

id

  • get id(): string

  • Returns string

label

  • get label(): string

  • Returns string

labels

  • get labels(): string[]

  • Returns string[]

Methods

assignNewId

  • assignNewId(idGenerator): void

  • Parameters

    • idGenerator: (() => string)
        • (): string

        • Returns string

    Returns void

attach

clearFilter

  • clearFilter(): boolean

  • clear the filter

    Returns boolean

    whether the filtered needed to be reset

Protected createEventList

detach

  • detach(): void

  • called when the column is removed from the ranking

    Returns void

dump

  • dump(toDescRef): any

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

    Parameters

    • toDescRef: ((desc) => any)
        • (desc): any

        • Parameters

          • desc: any

          Returns any

    Returns any

filter

  • filter(row, _valueCache?): boolean

  • predicate whether the current row should be included

    Parameters

    Returns boolean

findMyRanker

Protected fire

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

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

getCategories

getColor

getColorMapping

getColors

getExportValue

  • getExportValue(row, format): any

  • returns the value to be used when exporting

    Parameters

    • row: IDataRow
    • format: "text" | "json"

      format hint

    Returns any

getGroupRenderer

getHeaderLabel

  • getHeaderLabel(ctx): {
        asHTML: boolean;
        content: string;
    }

  • Parameters

    • ctx: "header" | "sidePanel" | "reorder"

    Returns {
        asHTML: boolean;
        content: string;
    }

    • asHTML: boolean
    • content: string

getLabel

  • getLabel(row): string

  • return the label of a given row for the current column

    Parameters

    Returns string

    the label of this column at the specified row

getLabels

getMap

  • getMap(row): {
        key: string;
        value: string;
    }[]

  • Parameters

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

getMapLabel

  • getMapLabel(row): {
        key: string;
        value: string;
    }[]

  • Parameters

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

getMetaData

getRaw

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

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

getSummaryRenderer

getValue

  • getValue(row): string[]

  • return the value of a given row for the current column

    Parameters

    Returns string[]

    the value of this column at the specified row

getValues

getVisible

getWidth

group

groupByMe

groupSortByMe

  • groupSortByMe(ascending?, priority?): boolean

  • Parameters

    • ascending: boolean = ...
    • priority: number = 0

    Returns boolean

hide

insertAfterMe

  • insertAfterMe(col): boolean

  • inserts the given column after itself

    Parameters

    • col: Column

      the column to insert

    Returns boolean

    was successful

insertBeforeMe

  • insertBeforeMe(col): boolean

  • inserts the given column before itself

    Parameters

    • col: Column

      the column to insert

    Returns boolean

    was successful

isFiltered

isGroupSortedByMe

  • isGroupSortedByMe(): {
        asc: "desc" | "asc";
        priority: number;
    }

  • Returns {
        asc: "desc" | "asc";
        priority: number;
    }

    • asc: "desc" | "asc"
    • priority: number

isGroupedBy

isLoaded

isSortedByMe

  • isSortedByMe(): {
        asc: "desc" | "asc";
        priority: number;
    }

  • Returns {
        asc: "desc" | "asc";
        priority: number;
    }

    • asc: "desc" | "asc"
    • priority: number

isVisible

iterCategory

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

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

nextSibling

on

  • on(type, listener): this

  • Parameters

    Returns this

  • 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

  • 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

  • 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

  • on(type, listener): this

  • Parameters

    • type: "metaDataChanged"
    • listener: ((previous, current) => void)
        • (previous, current): void

        • emitted when the meta data property changes

          Parameters

          Returns void

          As Member Of

          Column

          Group

          Events

    Returns this

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • on(type, listener): this

  • Parameters

    Returns this

onDataUpdate

previousSibling

removeMe

  • removeMe(): boolean

  • removes the column from the ranking

    Returns boolean

    was successful

restore

setColorMapping

setGroupRenderer

setLoaded

setMetaData

setRenderer

setSummaryRenderer

setVisible

setWidth

setWidthImpl

show

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

toCompareGroupValue

toCompareGroupValueType

toCompareValue

toCompareValueType

toggleMyGroupSorting

toggleMySorting

  • toggleMySorting(): boolean

  • toggles the sorting order of this column in the ranking

    Returns boolean

    was successful

Protected unforward

Settings

Member Visibility

Theme

On This Page

constructorcategoriesdescparentEVENT_COLOR_MAPPING_CHANGEDEVENT_DATA_LOADEDEVENT_DIRTYEVENT_DIRTY_CACHESEVENT_DIRTY_HEADEREVENT_DIRTY_VALUESEVENT_GROUP_RENDERER_TYPE_CHANGEDEVENT_LABEL_CHANGEDEVENT_METADATA_CHANGEDEVENT_RENDERER_TYPE_CHANGEDEVENT_SUMMARY_RENDERER_TYPE_CHANGEDEVENT_VISIBILITY_CHANGEDEVENT_WIDTH_CHANGEDFLAT_ALL_COLUMNSRENDERER_LOADINGdataLengthdescriptionfixedfqidfqpathfrozenidlabellabelsassignNewIdattachclearFiltercreateEventListdetachdumpfilterfindMyRankerfireflattenforwardgetCategoriesgetColorgetColorMappinggetColorsgetExportValuegetGroupRenderergetHeaderLabelgetLabelgetLabelsgetMapgetMapLabelgetMetaDatagetRawgetRenderergetSummaryLabelgetSummaryRenderergetValuegetValuesgetVisiblegetWidthgroupgroupByMegroupSortByMehideinsertAfterMeinsertBeforeMeisFilteredisGroupSortedByMeisGroupedByisLoadedisSortedByMeisVisibleiterCategorylistenersChangedmarkDirtynextSiblingononDataUpdatepreviousSiblingremoveMerestoresetColorMappingsetGroupRenderersetLoadedsetMetaDatasetRenderersetSummaryRenderersetVisiblesetWidthsetWidthImplshowsortByMetoCompareGroupValuetoCompareGroupValueTypetoCompareValuetoCompareValueTypetoggleMyGroupSortingtoggleMySortingunforward