Class Ranking

a ranking

Hierarchy (View Summary)

AEventDispatcher
- Ranking

Implements

IColumnParent

Index

Constructors

constructor

new Ranking(id: string): Ranking
Parameters
- id: string
Returns Ranking
Overrides AEventDispatcher.constructor
- Defined in model/Ranking.ts:184

Properties

id

id: string

`Static` `Readonly`EVENT_ADD_COLUMN

EVENT_ADD_COLUMN: "addColumn" = CompositeColumn.EVENT_ADD_COLUMN

`Static` `Readonly`EVENT_COLUMN_VISIBILITY_CHANGED

EVENT_COLUMN_VISIBILITY_CHANGED: "visibilityChanged" = Column.EVENT_VISIBILITY_CHANGED

`Static` `Readonly`EVENT_DIRTY

EVENT_DIRTY: "dirty" = Column.EVENT_DIRTY

`Static` `Readonly`EVENT_DIRTY_CACHES

EVENT_DIRTY_CACHES: "dirtyCaches" = Column.EVENT_DIRTY_CACHES

`Static` `Readonly`EVENT_DIRTY_HEADER

EVENT_DIRTY_HEADER: "dirtyHeader" = Column.EVENT_DIRTY_HEADER

`Static` `Readonly`EVENT_DIRTY_ORDER

EVENT_DIRTY_ORDER: "dirtyOrder" = 'dirtyOrder'

`Static` `Readonly`EVENT_DIRTY_VALUES

EVENT_DIRTY_VALUES: "dirtyValues" = Column.EVENT_DIRTY_VALUES

`Static` `Readonly`EVENT_FILTER_CHANGED

EVENT_FILTER_CHANGED: "filterChanged" = 'filterChanged'

`Static` `Readonly`EVENT_GROUP_CRITERIA_CHANGED

EVENT_GROUP_CRITERIA_CHANGED: "groupCriteriaChanged" = 'groupCriteriaChanged'

`Static` `Readonly`EVENT_GROUP_SORT_CRITERIA_CHANGED

EVENT_GROUP_SORT_CRITERIA_CHANGED: "groupSortCriteriaChanged" = 'groupSortCriteriaChanged'

`Static` `Readonly`EVENT_GROUPS_CHANGED

EVENT_GROUPS_CHANGED: "groupsChanged" = 'groupsChanged'

`Static` `Readonly`EVENT_LABEL_CHANGED

EVENT_LABEL_CHANGED: "labelChanged" = Column.EVENT_LABEL_CHANGED

`Static` `Readonly`EVENT_MOVE_COLUMN

EVENT_MOVE_COLUMN: "moveColumn" = CompositeColumn.EVENT_MOVE_COLUMN

`Static` `Readonly`EVENT_ORDER_CHANGED

EVENT_ORDER_CHANGED: "orderChanged" = 'orderChanged'

`Static` `Readonly`EVENT_REMOVE_COLUMN

EVENT_REMOVE_COLUMN: "removeColumn" = CompositeColumn.EVENT_REMOVE_COLUMN

`Static` `Readonly`EVENT_SORT_CRITERIA_CHANGED

EVENT_SORT_CRITERIA_CHANGED: "sortCriteriaChanged" = 'sortCriteriaChanged'

`Static` `Readonly`EVENT_WIDTH_CHANGED

EVENT_WIDTH_CHANGED: "widthChanged" = Column.EVENT_WIDTH_CHANGED

Accessors

children

get children(): Column[]
Returns Column[]
- Defined in model/Ranking.ts:653

flatColumns

get flatColumns(): Column[]
Returns Column[]
- Defined in model/Ranking.ts:860

fqid

get fqid(): string
Returns string
Implementation of IColumnParent.fqid
- Defined in model/Ranking.ts:893

fqpath

get fqpath(): string
Returns string
Implementation of IColumnParent.fqpath
- Defined in model/Ranking.ts:733

length

get length(): number
Returns number
- Defined in model/Ranking.ts:657

Methods

assignNewId

assignNewId(idGenerator: () => string): void
Parameters
- idGenerator: () => string
Returns void
- Defined in model/Ranking.ts:236

at

at(index: number): Column
Parameters
- index: number
Returns Column
Implementation of IColumnParent.at
- Defined in model/Ranking.ts:751

clear

clear(): void
Returns void
- Defined in model/Ranking.ts:825

clearFilters

clearFilters(): boolean
Returns boolean
- Defined in model/Ranking.ts:885

`Protected`createEventList

createEventList(): string[]
return the list of events to be able to dispatch

Returns string[]
by default no events
Overrides AEventDispatcher.createEventList
- Defined in model/Ranking.ts:190

`Readonly`dirtyOrder

dirtyOrder(reason?: EDirtyReason[]): void
Parameters
- Optionalreason: EDirtyReason[]
Returns void
- Defined in model/Ranking.ts:168

dump

dump(toDescRef: (desc: any) => any): IRankingDump
Parameters
- toDescRef: (desc: any) => any
Returns IRankingDump
- Defined in model/Ranking.ts:351

filter

filter(row: IDataRow): boolean
Parameters
- row: IDataRow
Returns boolean
- Defined in model/Ranking.ts:881

find

find(idOrFilter: string | (col: Column) => boolean): Column
Parameters
- idOrFilter: string | (col: Column) => boolean
Returns Column
- Defined in model/Ranking.ts:866

findByPath

findByPath(fqpath: string): Column
Parameters
- fqpath: string
Returns Column
- Defined in model/Ranking.ts:737

findMyRanker

findMyRanker(): Ranking
Returns Ranking
Implementation of IColumnParent.findMyRanker
- Defined in model/Ranking.ts:889

`Protected`fire

fire(type: string | string[], ...args: any[]): void
Parameters
- type: string | string[]
- ...args: any[]
Returns void
Inherited from AEventDispatcher.fire
- Defined in internal/AEventDispatcher.ts:101

flatten

flatten(
    r: IFlatColumn[],
    offset: number,
    levelsToGo?: number,
    padding?: number,
): number
Parameters
- r: IFlatColumn[]
- offset: number
- levelsToGo: number = 0
- padding: number = 0
Returns number
- Defined in model/Ranking.ts:402

`Protected`forward

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
- ...types: string[]
  the event types to forward
Returns void
Inherited from AEventDispatcher.forward
- Defined in internal/AEventDispatcher.ts:137

getFlatGroups

getFlatGroups(): Readonly<IGroup | IGroupParent>[]
Returns the flat group tree in depth first search (DFS).

Returns Readonly<IGroup | IGroupParent>[]
- Defined in model/Ranking.ts:343

getGroupCriteria

getGroupCriteria(): Column[]
Returns Column[]
- Defined in model/Ranking.ts:460

getGroups

getGroups(): IOrderedGroup[]
Returns IOrderedGroup[]
- Defined in model/Ranking.ts:336

getGroupSortCriteria

getGroupSortCriteria(): ISortCriteria[]
Returns ISortCriteria[]
- Defined in model/Ranking.ts:425

getLabel

getLabel(): string
Returns string
- Defined in model/Ranking.ts:241

getOrder

getOrder(): IndicesArray
Returns IndicesArray
- Defined in model/Ranking.ts:328

getOrderLength

getOrderLength(): number
Returns number
- Defined in model/Ranking.ts:332

getPrimarySortCriteria

getPrimarySortCriteria(): ISortCriteria
Returns ISortCriteria
- Defined in model/Ranking.ts:414

getRank

getRank(dataIndex: number): number
Parameters
- dataIndex: number
Returns number
- Defined in model/Ranking.ts:320

getSortCriteria

getSortCriteria(): ISortCriteria[]
Returns ISortCriteria[]
- Defined in model/Ranking.ts:421

groupBy

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
- Defined in model/Ranking.ts:521

groupSortBy

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
- Defined in model/Ranking.ts:488

indexOf

indexOf(col: Column): number
Parameters
- col: Column
Returns number
Implementation of IColumnParent.indexOf
- Defined in model/Ranking.ts:747

insert

insert(col: Column, index?: number): Column
Parameters
- col: Column
- index: number = ...
Returns Column
Implementation of IColumnParent.insert
- Defined in model/Ranking.ts:661

insertAfter

insertAfter(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Implementation of IColumnParent.insertAfter
- Defined in model/Ranking.ts:755

insertBefore

insertBefore(col: Column, ref: Column): Column
Parameters
- col: Column
- ref: Column
Returns Column
Implementation of IColumnParent.insertBefore
- Defined in model/Ranking.ts:763

isFiltered

isFiltered(): boolean
Returns boolean
- Defined in model/Ranking.ts:877

`Protected`listenersChanged

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
Inherited from AEventDispatcher.listenersChanged
- Defined in internal/AEventDispatcher.ts:89

markDirty

markDirty(type?: "values" | "all" | "header"): 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
- Defined in model/Ranking.ts:901

move

move(col: Column, index?: number): Column
Parameters
- col: Column
- index: number = ...
Returns Column
Implementation of IColumnParent.move
- Defined in model/Ranking.ts:692

moveAfter

moveAfter(col: Column, reference: Column): Column
Parameters
- col: Column
- reference: Column
Returns Column
Implementation of IColumnParent.moveAfter
- Defined in model/Ranking.ts:717

moveBefore

moveBefore(col: Column, reference: Column): Column
Parameters
- col: Column
- reference: Column
Returns Column
Implementation of IColumnParent.moveBefore
- Defined in model/Ranking.ts:725

on

on(
type: "widthChanged",
listener: (previous: number, current: number) => void,
): this
Parameters
- type: "widthChanged"
- listener: (previous: number, current: number) => void
  - - (previous: number, current: number): void
    - emitted when the width property changes
      
      Parameters
      previous: number
      current: number
      Returns void
      As Member Of
      Column
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:214
on(type: "filterChanged", listener: (previous: any, current: any) => void): this
Parameters
- type: "filterChanged"
- listener: (previous: any, current: any) => void
  - - (previous: any, current: any): void
    - emitted when the filter property changes
      
      Parameters
      previous: any
      current: any
      Returns void
      As Member Of
      NumberColumn
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:215
on(
type: "labelChanged",
listener: (previous: string, current: string) => void,
): this
Parameters
- type: "labelChanged"
- listener: (previous: string, current: string) => void
  - - (previous: string, current: string): void
    - emitted when the label property changes
      
      Parameters
      previous: string
      current: string
      Returns void
      As Member Of
      Column
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:216
on(type: "addColumn", listener: (col: Column, index: number) => void): this
Parameters
- type: "addColumn"
- listener: (col: Column, index: number) => void
  - - (col: Column, index: number): void
    - emitted when a column has been added
      
      Parameters
      col: Column
      index: number
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:217
on(
type: "moveColumn",
listener: (col: Column, index: number, oldIndex: number) => void,
): this
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
      
      Parameters
      col: Column
      index: number
      oldIndex: number
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:218
on(type: "removeColumn", listener: (col: Column, index: number) => void): this
Parameters
- type: "removeColumn"
- listener: (col: Column, index: number) => void
  - - (col: Column, index: number): void
    - emitted when a column has been removed
      
      Parameters
      col: Column
      index: number
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:219
on(type: "dirty", listener: () => void): this
Parameters
- type: "dirty"
- listener: () => void
  - - (): void
    - emitted when state of the column is dirty
      
      Returns void
      As Member Of
      Column
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:220
on(type: "dirtyHeader", listener: () => void): 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
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:221
on(type: "dirtyValues", listener: () => void): 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
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:222
on(type: "dirtyCaches", listener: () => void): 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
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:223
on(
type: "visibilityChanged",
listener: (previous: boolean, current: boolean) => void,
): this
Parameters
- type: "visibilityChanged"
- listener: (previous: boolean, current: boolean) => void
  - - (previous: boolean, current: boolean): void
    - emitted when the visibility of this column changes
      
      Parameters
      previous: boolean
      current: boolean
      Returns void
      As Member Of
      Column
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:224
on(
type: "sortCriteriaChanged",
listener: (previous: ISortCriteria[], current: ISortCriteria[]) => void,
): this
Parameters
- type: "sortCriteriaChanged"
- listener: (previous: ISortCriteria[], current: ISortCriteria[]) => void
  - - (previous: ISortCriteria[], current: ISortCriteria[]): void
    - emitted when the sort criteria property changes
      
      Parameters
      previous: ISortCriteria[]
      current: ISortCriteria[]
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:225
on(
type: "groupCriteriaChanged",
listener: (previous: Column[], current: Column[]) => void,
): this
Parameters
- type: "groupCriteriaChanged"
- listener: (previous: Column[], current: Column[]) => void
  - - (previous: Column[], current: Column[]): void
    - emitted when the sort criteria property changes
      
      Parameters
      previous: Column[]
      current: Column[]
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:226
on(
type: "groupSortCriteriaChanged",
listener: (previous: ISortCriteria[], current: ISortCriteria[]) => void,
): this
Parameters
- type: "groupSortCriteriaChanged"
- listener: (previous: ISortCriteria[], current: ISortCriteria[]) => void
  - - (previous: ISortCriteria[], current: ISortCriteria[]): void
    - emitted when the sort criteria property changes
      
      Parameters
      previous: ISortCriteria[]
      current: ISortCriteria[]
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:227
on(type: "dirtyOrder", listener: (reason?: EDirtyReason[]) => void): this
Parameters
- type: "dirtyOrder"
- listener: (reason?: EDirtyReason[]) => void
  - - (reason?: EDirtyReason[]): void
    - emitted when the sort criteria property changes
      
      Parameters
      Optionalreason: EDirtyReason[]
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:228
on(
    type: "orderChanged",
    listener: (
        previous: number[],
        current: number[],
        previousGroups: IOrderedGroup[],
        currentGroups: IOrderedGroup[],
        dirtyReason: EDirtyReason[],
    ) => void,
): this
Parameters
- type: "orderChanged"
- listener: (
      previous: number[],
      current: number[],
      previousGroups: IOrderedGroup[],
      currentGroups: IOrderedGroup[],
      dirtyReason: EDirtyReason[],
  ) => void
  - - (
          previous: number[],
          current: number[],
          previousGroups: IOrderedGroup[],
          currentGroups: IOrderedGroup[],
          dirtyReason: EDirtyReason[],
      ): void
    - Parameters
      previous: number[]
      current: number[]
      previousGroups: IOrderedGroup[]
      currentGroups: IOrderedGroup[]
      dirtyReason: EDirtyReason[]
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:229
on(
    type: "groupsChanged",
    listener: (
        previous: number[],
        current: number[],
        previousGroups: IOrderedGroup[],
        currentGroups: IOrderedGroup[],
    ) => void,
): this
Parameters
- type: "groupsChanged"
- listener: (
      previous: number[],
      current: number[],
      previousGroups: IOrderedGroup[],
      currentGroups: IOrderedGroup[],
  ) => void
  - - (
          previous: number[],
          current: number[],
          previousGroups: IOrderedGroup[],
          currentGroups: IOrderedGroup[],
      ): void
    - Parameters
      previous: number[]
      current: number[]
      previousGroups: IOrderedGroup[]
      currentGroups: IOrderedGroup[]
      Returns void
      As Member Of
      Ranking
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:230
on(type: string | string[], listener: IEventListener): this
Parameters
- type: string | string[]
- listener: IEventListener
Returns this
Overrides AEventDispatcher.on
- Defined in model/Ranking.ts:231

push

push(col: Column): Column
Parameters
- col: Column
Returns Column
- Defined in model/Ranking.ts:771

remove

remove(col: Column): boolean
Parameters
- col: Column
Returns boolean
Implementation of IColumnParent.remove
- Defined in model/Ranking.ts:775

restore

restore(dump: IRankingDump, factory: ITypeFactory): void
Parameters
- dump: IRankingDump
- factory: ITypeFactory
Returns void
- Defined in model/Ranking.ts:360

setGroupCriteria

setGroupCriteria(column: Column | Column[]): boolean
Parameters
- column: Column | Column[]
Returns boolean
- Defined in model/Ranking.ts:549

setGroups

setGroups(
    groups: IOrderedGroup[],
    index2pos: IndicesArray,
    dirtyReason: EDirtyReason[],
): void
Parameters
- groups: IOrderedGroup[]
- index2pos: IndicesArray
- dirtyReason: EDirtyReason[]
Returns void
- Defined in model/Ranking.ts:252

setGroupSortCriteria

setGroupSortCriteria(value: ISortCriteria | ISortCriteria[]): boolean
Parameters
- value: ISortCriteria | ISortCriteria[]
Returns boolean
- Defined in model/Ranking.ts:601

setLabel

setLabel(value: string): void
Parameters
- value: string
Returns void
- Defined in model/Ranking.ts:245

setSortCriteria

setSortCriteria(value: ISortCriteria | ISortCriteria[]): boolean
Parameters
- value: ISortCriteria | ISortCriteria[]
Returns boolean
- Defined in model/Ranking.ts:528

sortBy

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
- Defined in model/Ranking.ts:469

toggleGrouping

toggleGrouping(col: Column): boolean
Parameters
- col: Column
Returns boolean
- Defined in model/Ranking.ts:450

toggleGroupSorting

toggleGroupSorting(col: Column): boolean
Parameters
- col: Column
Returns boolean
- Defined in model/Ranking.ts:597

toggleSorting

toggleSorting(col: Column): boolean
Parameters
- col: Column
Returns boolean
- Defined in model/Ranking.ts:429

`Protected`unforward

unforward(from: IEventHandler, ...types: string[]): void
removes the forwarding declarations
Parameters
- from: IEventHandler
  the originated dispatcher
- ...types: string[]
  event types to forward
Returns void
Inherited from AEventDispatcher.unforward
- Defined in internal/AEventDispatcher.ts:146

Class Ranking

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Ranking

Properties

id

Static ReadonlyEVENT_ADD_COLUMN

Static ReadonlyEVENT_COLUMN_VISIBILITY_CHANGED

Static ReadonlyEVENT_DIRTY

Static ReadonlyEVENT_DIRTY_CACHES

Static ReadonlyEVENT_DIRTY_HEADER

Static ReadonlyEVENT_DIRTY_ORDER

Static ReadonlyEVENT_DIRTY_VALUES

Static ReadonlyEVENT_FILTER_CHANGED

Static ReadonlyEVENT_GROUP_CRITERIA_CHANGED

Static ReadonlyEVENT_GROUP_SORT_CRITERIA_CHANGED

Static ReadonlyEVENT_GROUPS_CHANGED

Static ReadonlyEVENT_LABEL_CHANGED

Static ReadonlyEVENT_MOVE_COLUMN

Static ReadonlyEVENT_ORDER_CHANGED

Static ReadonlyEVENT_REMOVE_COLUMN

Static ReadonlyEVENT_SORT_CRITERIA_CHANGED

Static ReadonlyEVENT_WIDTH_CHANGED

Accessors

children

Returns Column[]

flatColumns

Returns Column[]

fqid

Returns string

fqpath

Returns string

length

Returns number

Methods

assignNewId

Parameters

Returns void

at

Parameters

Returns Column

clear

Returns void

clearFilters

Returns boolean

ProtectedcreateEventList

Returns string[]

ReadonlydirtyOrder

Parameters

Returns void

dump

Parameters

Returns IRankingDump

filter

Parameters

Returns boolean

find

Parameters

Returns Column

findByPath

Parameters

Returns Column

findMyRanker

Returns Ranking

Protectedfire

Parameters

Returns void

flatten

Parameters

Returns number

Protectedforward

Parameters

`Static` `Readonly`EVENT_ADD_COLUMN

`Static` `Readonly`EVENT_COLUMN_VISIBILITY_CHANGED

`Static` `Readonly`EVENT_DIRTY

`Static` `Readonly`EVENT_DIRTY_CACHES

`Static` `Readonly`EVENT_DIRTY_HEADER

`Static` `Readonly`EVENT_DIRTY_ORDER

`Static` `Readonly`EVENT_DIRTY_VALUES

`Static` `Readonly`EVENT_FILTER_CHANGED

`Static` `Readonly`EVENT_GROUP_CRITERIA_CHANGED

`Static` `Readonly`EVENT_GROUP_SORT_CRITERIA_CHANGED

`Static` `Readonly`EVENT_GROUPS_CHANGED

`Static` `Readonly`EVENT_LABEL_CHANGED

`Static` `Readonly`EVENT_MOVE_COLUMN

`Static` `Readonly`EVENT_ORDER_CHANGED

`Static` `Readonly`EVENT_REMOVE_COLUMN

`Static` `Readonly`EVENT_SORT_CRITERIA_CHANGED

`Static` `Readonly`EVENT_WIDTH_CHANGED

`Protected`createEventList

`Readonly`dirtyOrder

`Protected`fire

`Protected`forward

`Protected`listenersChanged