Class ReduceColumn

combines multiple columns by using the maximal value

Hierarchy (view full)

Constructors

constructor

Properties

_children desc parent EVENT_ADD_COLUMN EVENT_DIRTY EVENT_DIRTY_CACHES EVENT_DIRTY_HEADER EVENT_DIRTY_VALUES EVENT_FILTER_CHANGED EVENT_GROUP_RENDERER_TYPE_CHANGED EVENT_LABEL_CHANGED EVENT_METADATA_CHANGED EVENT_MOVE_COLUMN EVENT_REDUCE_CHANGED EVENT_REMOVE_COLUMN EVENT_RENDERER_TYPE_CHANGED EVENT_SUMMARY_RENDERER_TYPE_CHANGED EVENT_VISIBILITY_CHANGED EVENT_WIDTH_CHANGED FLAT_ALL_COLUMNS

Accessors

canJustAddNumbers children description fixed fqid fqpath frozen id label length

Methods

assignNewId at attach clearFilter compute createEventList detach dump filter findMyRanker fire flatten forward getColor getExportValue getGroupRenderer getHeaderLabel getLabel getMetaData getNumber getNumberFormat getRawNumber getReduce getRenderer getSummaryLabel getSummaryRenderer getValue getVisible getWidth group groupByMe groupSortByMe hide indexOf insert insertAfter insertAfterMe insertBefore insertBeforeMe insertImpl isFiltered isGroupSortedByMe isGroupedBy isLoaded isSortedByMe isVisible iterNumber iterRawNumber listenersChanged markDirty move moveAfter moveBefore moveImpl nextSibling on previousSibling push remove removeImpl removeMe restore setGroupRenderer setMetaData setReduce setRenderer setSummaryRenderer setVisible setWidth setWidthImpl show sortByMe toCompareGroupValue toCompareGroupValueType toCompareValue toCompareValueType toggleMyGroupSorting toggleMySorting unforward

Constructors

constructor

Properties

Protected Readonly _children

_children: Column[] = []

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_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = 'addColumn'

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

EVENT_MOVE_COLUMN: "moveColumn" = 'moveColumn'

Static Readonly EVENT_REDUCE_CHANGED

EVENT_REDUCE_CHANGED: "reduceChanged" = 'reduceChanged'

Static Readonly EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = 'removeColumn'

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

Accessors

canJustAddNumbers

  • get canJustAddNumbers(): boolean

  • Returns boolean

children

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

length

Methods

assignNewId

at

attach

clearFilter

Protected compute

Protected createEventList

detach

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

filter

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

getColor

getExportValue

getGroupRenderer

getHeaderLabel

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

  • Parameters

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

    Returns {
        asHTML: boolean;
        content: string;
    }

    • asHTML: boolean
    • content: string

getLabel

getMetaData

getNumber

getNumberFormat

getRawNumber

getReduce

getRenderer

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

getVisible

getWidth

group

groupByMe

groupSortByMe

hide

indexOf

insert

insertAfter

insertAfterMe

insertBefore

insertBeforeMe

Protected insertImpl

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

iterNumber

iterRawNumber

Protected listenersChanged

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

move

moveAfter

moveBefore

Protected moveImpl

nextSibling

on

  • on(type, listener): this

  • Parameters

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

    Returns this

  • on(type, listener): this

  • Parameters

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

        • emitted when the filter property changes

          Parameters

          • previous: any
          • current: any

          Returns void

          As Member Of

          CompositeColumn

          Group

          Events

    Returns this

  • on(type, listener): this

  • Parameters

    • type: "addColumn"
    • listener: ((col, index) => void)
        • (col, index): void

        • emitted when a column has been added

          Parameters

          Returns void

          As Member Of

          CompositeColumn

          Group

          Events

    Returns this

  • on(type, listener): this

  • Parameters

    • type: "moveColumn"
    • listener: ((col, index, oldIndex) => void)
        • (col, index, oldIndex): void

        • emitted when a column has been moved within this composite columm

          Parameters

          • col: Column
          • index: number
          • oldIndex: number

          Returns void

          As Member Of

          CompositeColumn

          Group

          Events

    Returns this

  • on(type, listener): this

  • Parameters

    • type: "removeColumn"
    • listener: ((col, index) => void)
        • (col, index): void

        • emitted when a column has been removed

          Parameters

          Returns void

          As Member Of

          CompositeColumn

          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

previousSibling

push

remove

Protected removeImpl

removeMe

restore

setGroupRenderer

setMetaData

setReduce

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

Protected unforward

Settings

Member Visibility

Theme

On This Page

constructor_childrendescparentEVENT_ADD_COLUMNEVENT_DIRTYEVENT_DIRTY_CACHESEVENT_DIRTY_HEADEREVENT_DIRTY_VALUESEVENT_FILTER_CHANGEDEVENT_GROUP_RENDERER_TYPE_CHANGEDEVENT_LABEL_CHANGEDEVENT_METADATA_CHANGEDEVENT_MOVE_COLUMNEVENT_REDUCE_CHANGEDEVENT_REMOVE_COLUMNEVENT_RENDERER_TYPE_CHANGEDEVENT_SUMMARY_RENDERER_TYPE_CHANGEDEVENT_VISIBILITY_CHANGEDEVENT_WIDTH_CHANGEDFLAT_ALL_COLUMNScanJustAddNumberschildrendescriptionfixedfqidfqpathfrozenidlabellengthassignNewIdatattachclearFiltercomputecreateEventListdetachdumpfilterfindMyRankerfireflattenforwardgetColorgetExportValuegetGroupRenderergetHeaderLabelgetLabelgetMetaDatagetNumbergetNumberFormatgetRawNumbergetReducegetRenderergetSummaryLabelgetSummaryRenderergetValuegetVisiblegetWidthgroupgroupByMegroupSortByMehideindexOfinsertinsertAfterinsertAfterMeinsertBeforeinsertBeforeMeinsertImplisFilteredisGroupSortedByMeisGroupedByisLoadedisSortedByMeisVisibleiterNumberiterRawNumberlistenersChangedmarkDirtymovemoveAftermoveBeforemoveImplnextSiblingonpreviousSiblingpushremoveremoveImplremoveMerestoresetGroupRenderersetMetaDatasetReducesetRenderersetSummaryRenderersetVisiblesetWidthsetWidthImplshowsortByMetoCompareGroupValuetoCompareGroupValueTypetoCompareValuetoCompareValueTypetoggleMyGroupSortingtoggleMySortingunforward