Options
All
  • Public
  • Public/Protected
  • All
Menu

a ranking

Hierarchy

Implements

Index

Constructors

constructor

  • new Ranking(id: string, maxSortCriteria?: number, maxGroupColumns?: number): Ranking

Events

addColumn

  • addColumn(col: Column, index: number): void
  • emitted when a column has been added

    asmemberof

    Ranking

    Parameters

    Returns void

dirtyOrder

  • dirtyOrder(): void
  • emitted when the sort criteria propery changes

    asmemberof

    Ranking

    Returns void

groupCriteriaChanged

  • groupCriteriaChanged(previous: Column[], current: Column[]): void
  • emitted when the sort criteria propery changes

    asmemberof

    Ranking

    Parameters

    Returns void

groupSortCriteriaChanged

groupsChanged

moveColumn

  • moveColumn(col: Column, index: number, oldIndex: number): void
  • emitted when a column has been moved within this composite columm

    asmemberof

    Ranking

    Parameters

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

    Returns void

orderChanged

removeColumn

  • removeColumn(col: Column, index: number): void
  • emitted when a column has been removed

    asmemberof

    Ranking

    Parameters

    Returns void

sortCriteriaChanged

Properties

id

id: string

Static EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = CompositeColumn.EVENT_ADD_COLUMN

Static EVENT_COLUMN_VISIBILITY_CHANGED

EVENT_COLUMN_VISIBILITY_CHANGED: "visibilityChanged" = Column.EVENT_VISIBILITY_CHANGED

Static EVENT_DIRTY

EVENT_DIRTY: "dirty" = Column.EVENT_DIRTY

Static EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = Column.EVENT_DIRTY_HEADER

Static EVENT_DIRTY_ORDER

EVENT_DIRTY_ORDER: "dirtyOrder" = "dirtyOrder"

Static EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = Column.EVENT_DIRTY_VALUES

Static EVENT_FILTER_CHANGED

EVENT_FILTER_CHANGED: "filterChanged" = NumberColumn.EVENT_FILTER_CHANGED

Static EVENT_GROUPS_CHANGED

EVENT_GROUPS_CHANGED: "groupsChanged" = "groupsChanged"

Static EVENT_GROUP_CRITERIA_CHANGED

EVENT_GROUP_CRITERIA_CHANGED: "groupCriteriaChanged" = "groupCriteriaChanged"

Static EVENT_GROUP_SORT_CRITERIA_CHANGED

EVENT_GROUP_SORT_CRITERIA_CHANGED: "groupSortCriteriaChanged" = "groupSortCriteriaChanged"

Static EVENT_LABEL_CHANGED

EVENT_LABEL_CHANGED: "labelChanged" = Column.EVENT_LABEL_CHANGED

Static EVENT_MOVE_COLUMN

EVENT_MOVE_COLUMN: "moveColumn" = CompositeColumn.EVENT_MOVE_COLUMN

Static EVENT_ORDER_CHANGED

EVENT_ORDER_CHANGED: "orderChanged" = "orderChanged"

Static EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = CompositeColumn.EVENT_REMOVE_COLUMN

Static EVENT_SORT_CRITERIA_CHANGED

EVENT_SORT_CRITERIA_CHANGED: "sortCriteriaChanged" = "sortCriteriaChanged"

Static EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = Column.EVENT_WIDTH_CHANGED

Accessors

children

flatColumns

fqid

  • get fqid(): string

fqpath

  • get fqpath(): string

length

  • get length(): number

Methods

assignNewId

  • assignNewId(idGenerator: function): void
  • Parameters

    • idGenerator: function
        • (): string
        • Returns string

    Returns void

at

clear

  • clear(): void

comparator

dirtyOrder

  • dirtyOrder(): void

dump

  • dump(toDescRef: function): any
  • Parameters

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

          • desc: any

          Returns any

    Returns any

filter

find

  • find(idOrFilter: string | function): null | Column

findByPath

  • findByPath(fqpath: string): Column

findMyRanker

  • findMyRanker(): this

flatten

  • flatten(r: IFlatColumn[], offset: number, levelsToGo?: number, padding?: number): number
  • Parameters

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

    Returns number

getGroupCriteria

  • getGroupCriteria(): Column[]

getGroupSortCriteria

getGroups

getLabel

  • getLabel(): string

getMaxGroupColumns

  • getMaxGroupColumns(): number

getMaxSortCriteria

  • getMaxSortCriteria(): number

getOrder

  • getOrder(): number[]

getPrimarySortCriteria

getSortCriteria

groupBy

  • groupBy(col: Column, priority?: number): boolean
  • replaces, moves, or remove the given column in the grouping hierarchy

    Parameters

    • col: Column
    • Default value priority: number = 0

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

    Returns boolean

groupComparator

groupSortBy

  • groupSortBy(col: Column, ascending?: boolean, priority?: number): boolean
  • replaces, moves, or remove the given column in the group sorting hierarchy

    Parameters

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

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

    Returns boolean

grouper

indexOf

  • indexOf(col: Column): number

insert

insertAfter

isFiltered

  • isFiltered(): 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

move

moveAfter

on

push

remove

  • remove(col: Column): boolean

restore

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

setGroupCriteria

setGroupSortCriteria

setGroups

setLabel

  • setLabel(value: string): void

setMaxGroupColumns

  • setMaxGroupColumns(maxGroupColumns: number): void

setMaxSortCriteria

  • setMaxSortCriteria(maxSortCriteria: number): void

setOrder

  • setOrder(order: number[]): void

setSortCriteria

sortBy

  • sortBy(col: Column, ascending?: boolean, priority?: number): boolean
  • replaces, moves, or remove the given column in the sorting hierarchy

    Parameters

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

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

    Returns boolean

toggleGroupSorting

  • toggleGroupSorting(col: Column): boolean

toggleGrouping

  • toggleGrouping(col: Column): boolean

toggleSorting

  • toggleSorting(col: Column): boolean