Options
All
  • Public
  • Public/Protected
  • All
Menu

a ranking

Hierarchy

  • default
    • Ranking

Implements

Index

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

  • get fqid(): string
  • get fqpath(): string
  • get length(): number

Methods

  • assignNewId(idGenerator: () => string): void
  • clear(): void
  • clearFilters(): boolean
  • createEventList(): string[]
  • find(idOrFilter: string | ((col: Column) => boolean)): Column
  • findByPath(fqpath: string): Column
  • fire(type: string | string[], ...args: any[]): void
  • flatten(r: IFlatColumn[], offset: number, levelsToGo?: number, padding?: number): number
  • forward(from: IEventHandler, ...types: string[]): 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

  • getLabel(): string
  • getOrderLength(): number
  • getRank(dataIndex: number): number
  • groupBy(col: Column, priority?: number): boolean
  • 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

  • groupSortBy(col: Column, ascending?: boolean, priority?: number): 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

  • isFiltered(): boolean
  • listenersChanged(_type: string, _active: boolean): 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(type?: "header" | "values" | "all"): void
  • marks the header, values, or both as dirty such that the values are reevaluated

    Parameters

    • type: "header" | "values" | "all" = 'all'

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

    Returns void

  • on(type: "widthChanged", listener: (previous: number, current: number) => void): Ranking
  • on(type: "filterChanged", listener: (previous: any, current: any) => void): Ranking
  • on(type: "labelChanged", listener: (previous: string, current: string) => void): Ranking
  • on(type: "addColumn", listener: (col: Column, index: number) => void): Ranking
  • on(type: "moveColumn", listener: (col: Column, index: number, oldIndex: number) => void): Ranking
  • on(type: "removeColumn", listener: (col: Column, index: number) => void): Ranking
  • on(type: "dirty", listener: () => void): Ranking
  • on(type: "dirtyHeader", listener: () => void): Ranking
  • on(type: "dirtyValues", listener: () => void): Ranking
  • on(type: "dirtyCaches", listener: () => void): Ranking
  • on(type: "visibilityChanged", listener: (previous: boolean, current: boolean) => void): Ranking
  • on(type: "sortCriteriaChanged", listener: (previous: ISortCriteria[], current: ISortCriteria[]) => void): Ranking
  • on(type: "groupCriteriaChanged", listener: (previous: Column[], current: Column[]) => void): Ranking
  • on(type: "groupSortCriteriaChanged", listener: (previous: ISortCriteria[], current: ISortCriteria[]) => void): Ranking
  • on(type: "dirtyOrder", listener: (reason?: EDirtyReason[]) => void): Ranking
  • on(type: "orderChanged", listener: (previous: number[], current: number[], previousGroups: IOrderedGroup[], currentGroups: IOrderedGroup[], dirtyReason: EDirtyReason[]) => void): Ranking
  • on(type: "groupsChanged", listener: (previous: number[], current: number[], previousGroups: IOrderedGroup[], currentGroups: IOrderedGroup[]) => void): Ranking
  • on(type: string | string[], listener: IEventListener): Ranking
  • Parameters

    • type: "widthChanged"
    • listener: (previous: number, current: number) => void
        • (previous: number, current: number): void
        • emitted when the width property changes

          asmemberof

          Column

          Parameters

          • previous: number
          • current: number

          Returns void

    Returns Ranking

  • Parameters

    • type: "filterChanged"
    • listener: (previous: any, current: any) => void
        • (previous: any, current: any): void
        • emitted when the filter property changes

          asmemberof

          NumberColumn

          Parameters

          • previous: any
          • current: any

          Returns void

    Returns Ranking

  • Parameters

    • type: "labelChanged"
    • listener: (previous: string, current: string) => void
        • (previous: string, current: string): void
        • emitted when the label property changes

          asmemberof

          Column

          Parameters

          • previous: string
          • current: string

          Returns void

    Returns Ranking

  • Parameters

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

          asmemberof

          Ranking

          Parameters

          Returns void

    Returns Ranking

  • Parameters

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

          asmemberof

          Ranking

          Parameters

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

          Returns void

    Returns Ranking

  • Parameters

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

          asmemberof

          Ranking

          Parameters

          Returns void

    Returns Ranking

  • Parameters

    • type: "dirty"
    • listener: () => void
        • (): void
        • emitted when state of the column is dirty

          asmemberof

          Column

          Returns void

    Returns Ranking

  • Parameters

    • type: "dirtyHeader"
    • listener: () => void
        • (): void
        • emitted when state of the column related to its header is dirty

          asmemberof

          Column

          Returns void

    Returns Ranking

  • Parameters

    • type: "dirtyValues"
    • listener: () => void
        • (): void
        • emitted when state of the column related to its values is dirty

          asmemberof

          Column

          Returns void

    Returns Ranking

  • Parameters

    • type: "dirtyCaches"
    • listener: () => void
        • (): void
        • emitted when state of the column related to cached values (hist, compare, ...) is dirty

          asmemberof

          Column

          Returns void

    Returns Ranking

  • Parameters

    • type: "visibilityChanged"
    • listener: (previous: boolean, current: boolean) => void
        • (previous: boolean, current: boolean): void
        • emitted when the visibility of this column changes

          asmemberof

          Column

          Parameters

          • previous: boolean
          • current: boolean

          Returns void

    Returns Ranking

  • Parameters

    Returns Ranking

  • Parameters

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

          asmemberof

          Ranking

          Parameters

          Returns void

    Returns Ranking

  • Parameters

    Returns Ranking

  • Parameters

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

          asmemberof

          Ranking

          Parameters

          Returns void

    Returns Ranking

  • Parameters

    Returns Ranking

  • Parameters

    Returns Ranking

  • Parameters

    • type: string | string[]
    • listener: IEventListener

    Returns Ranking

  • setLabel(value: string): void
  • sortBy(col: Column, ascending?: boolean, priority?: number): boolean
  • 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

  • toggleGroupSorting(col: Column): boolean
  • toggleGrouping(col: Column): boolean
  • toggleSorting(col: Column): boolean
  • unforward(from: IEventHandler, ...types: string[]): void
  • removes the forwarding declarations

    Parameters

    • from: IEventHandler

      the originated dispatcher

    • Rest ...types: string[]

      event types to forward

    Returns void