Class Ranking

a ranking

Hierarchy (view full)

Implements

Constructors

Properties

id: string
EVENT_ADD_COLUMN: "addColumn" = CompositeColumn.EVENT_ADD_COLUMN
EVENT_COLUMN_VISIBILITY_CHANGED: "visibilityChanged" = Column.EVENT_VISIBILITY_CHANGED
EVENT_DIRTY: "dirty" = Column.EVENT_DIRTY
EVENT_DIRTY_CACHES: "dirtyCaches" = Column.EVENT_DIRTY_CACHES
EVENT_DIRTY_HEADER: "dirtyHeader" = Column.EVENT_DIRTY_HEADER
EVENT_DIRTY_ORDER: "dirtyOrder" = 'dirtyOrder'
EVENT_DIRTY_VALUES: "dirtyValues" = Column.EVENT_DIRTY_VALUES
EVENT_FILTER_CHANGED: "filterChanged" = 'filterChanged'
EVENT_GROUPS_CHANGED: "groupsChanged" = 'groupsChanged'
EVENT_GROUP_CRITERIA_CHANGED: "groupCriteriaChanged" = 'groupCriteriaChanged'
EVENT_GROUP_SORT_CRITERIA_CHANGED: "groupSortCriteriaChanged" = 'groupSortCriteriaChanged'
EVENT_LABEL_CHANGED: "labelChanged" = Column.EVENT_LABEL_CHANGED
EVENT_MOVE_COLUMN: "moveColumn" = CompositeColumn.EVENT_MOVE_COLUMN
EVENT_ORDER_CHANGED: "orderChanged" = 'orderChanged'
EVENT_REMOVE_COLUMN: "removeColumn" = CompositeColumn.EVENT_REMOVE_COLUMN
EVENT_SORT_CRITERIA_CHANGED: "sortCriteriaChanged" = 'sortCriteriaChanged'
EVENT_WIDTH_CHANGED: "widthChanged" = Column.EVENT_WIDTH_CHANGED

Accessors

Methods

  • Parameters

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

    Returns void

  • Parameters

    • r: IFlatColumn[]
    • offset: number
    • levelsToGo: number = 0
    • padding: number = 0

    Returns number

  • 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

  • replaces, moves, or remove the given column in the grouping hierarchy

    Parameters

    • col: Column
    • priority: number = 0

      when priority < 0 remove the column only else replace at the given priority

    Returns boolean

  • replaces, moves, or remove the given column in the group sorting hierarchy

    Parameters

    • col: Column
    • ascending: boolean = false
    • priority: number = 0

      when priority < 0 remove the column only else replace at the given priority

    Returns boolean

  • 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

  • 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

  • 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

          NumberColumn

          Group

          Events

    Returns 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

  • Parameters

    • type: "addColumn"
    • listener: ((col, index) => void)
        • (col, index): void
        • emitted when a column has been added

          Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "moveColumn"
    • listener: ((col, index, oldIndex) => void)
        • (col, index, oldIndex): void
        • emitted when a column has been moved within this composite column

          Parameters

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

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "removeColumn"
    • listener: ((col, index) => void)
        • (col, index): void
        • emitted when a column has been removed

          Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns 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

  • 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

  • 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

  • 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

  • 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

  • Parameters

    • type: "sortCriteriaChanged"
    • listener: ((previous, current) => void)
        • (previous, current): void
        • emitted when the sort criteria property changes

          Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "groupCriteriaChanged"
    • listener: ((previous, current) => void)
        • (previous, current): void
        • emitted when the sort criteria property changes

          Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "groupSortCriteriaChanged"
    • listener: ((previous, current) => void)
        • (previous, current): void
        • emitted when the sort criteria property changes

          Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "dirtyOrder"
    • listener: ((reason?) => void)
        • (reason?): void
        • emitted when the sort criteria property changes

          Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "orderChanged"
    • listener: ((previous, current, previousGroups, currentGroups, dirtyReason) => void)
        • (previous, current, previousGroups, currentGroups, dirtyReason): void
        • Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    • type: "groupsChanged"
    • listener: ((previous, current, previousGroups, currentGroups) => void)
        • (previous, current, previousGroups, currentGroups): void
        • Parameters

          Returns void

          As Member Of

          Ranking

          Group

          Events

    Returns this

  • Parameters

    Returns this

  • replaces, moves, or remove the given column in the sorting hierarchy

    Parameters

    • col: Column
    • ascending: boolean = false
    • priority: number = 0

      when priority < 0 remove the column only else replace at the given priority

    Returns boolean