Winter Cardinal UI - v0.457.0 / DTableDataListSorter

Class: DTableDataListSorter<ROW>

Table data sorter.

Type parameters

Name
ROW

Hierarchy

• EventEmitter

  ↳ DTableDataListSorter

Implements

• DTableDataSorter<ROW>

Table of contents

Constructors

• constructor

Properties

• _comparator
• _id
• _idUpdated
• _isApplied
• _order
• _parent
• _sorted

Accessors

• id
• indices
• order

Methods

• addListener
• apply
• emit
• eventNames
• get
• isApplied
• listenerCount
• listeners
• map
• newSorted
• off
• on
• once
• removeAllListeners
• removeListener
• set
• toComparator
• toDirty
• unapply
• unmap
• update

Constructors

constructor

• new DTableDataListSorter<ROW>(parent): DTableDataListSorter<ROW>

Type parameters

Name
ROW

Parameters

Name	Type
parent	DTableDataListSorterParent<ROW>

Returns

DTableDataListSorter<ROW>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:24

Properties

_comparator

• Protected _comparator: null | DTableDataComparator<ROW>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:20

---

_id

• Protected _id: number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:16

---

_idUpdated

• Protected _idUpdated: number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:17

---

_isApplied

• Protected _isApplied: boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:18

---

_order

• Protected _order: DTableDataOrder

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:22

---

_parent

• Protected _parent: DTableDataListSorterParent<ROW>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:19

---

_sorted

• Protected _sorted: null | number[]

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:21

Accessors

id

• get id(): number

Returns

number

Implementation of

DTableDataSorter.id

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:36

---

indices

• get indices(): null | number[]

An indices of sorted rows. Must not change this indices directly.

Returns

null | number[]

Implementation of

DTableDataSorter.indices

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:137

---

order

• get order(): DTableDataOrder

A sort order.

Returns

DTableDataOrder

Implementation of

DTableDataSorter.order

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:40

• set order(order): void

A sort order.

Parameters

Name	Type
order	DTableDataOrder

Returns

void

Implementation of

DTableDataSorter.order

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:44

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Implementation of

DTableDataSorter.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

---

apply

▸ apply(): void

Applys a sorting.

Returns

void

Implementation of

DTableDataSorter.apply

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:48

---

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
...args	any[]	Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Implementation of

DTableDataSorter.emit

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Implementation of

DTableDataSorter.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

---

get

▸ get(): null | DTableDataComparator<ROW>

Returns a current comparator.

Returns

null | DTableDataComparator<ROW>

Implementation of

DTableDataSorter.get

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:110

---

isApplied

▸ isApplied(): boolean

Returns true if a sorting is applied.

Returns

boolean

Implementation of

DTableDataSorter.isApplied

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:62

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

number

Implementation of

DTableDataSorter.listenerCount

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

---

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

Function[]

Implementation of

DTableDataSorter.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

---

map

▸ map(unmappedIndex): null | number

Returns a sorted index of the specified unmapped index.

Parameters

Name	Type	Description
unmappedIndex	number	an unmapped index

Returns

null | number

Implementation of

DTableDataSorter.map

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:142

---

newSorted

▸ newSorted(): null | number[]

Returns

null | number[]

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:66

---

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name	Type
event	string | symbol
fn?	Function
context?	any
once?	boolean

Returns

this

Implementation of

DTableDataSorter.off

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

---

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DTableDataSorter.on

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

---

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DTableDataSorter.once

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Implementation of

DTableDataSorter.removeAllListeners

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

---

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Implementation of

DTableDataSorter.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

---

set

▸ set(comparator): void

Sets to the given comparator.

Parameters

Name	Type	Description
comparator	null | DTableDataComparator<ROW>	A comparator

Returns

void

Implementation of

DTableDataSorter.set

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:114

---

toComparator

▸ toComparator(rows, comparator): (indexA: number, indexB: number) => number

Parameters

Name	Type
rows	ROW[]
comparator	DTableDataComparator<ROW>

Returns

fn

▸ (indexA, indexB): number

Parameters

Name	Type
indexA	number
indexB	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:82

---

toDirty

▸ toDirty(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:120

---

unapply

▸ unapply(): void

Unapplys a sorting.

Returns

void

Implementation of

DTableDataSorter.unapply

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:54

---

unmap

▸ unmap(index): number

Returns an unmapped index of the specified sorted index.

Parameters

Name	Type	Description
index	number	a mapped index

Returns

number

Implementation of

DTableDataSorter.unmap

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:158

---

update

▸ update(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-sorter.ts:124

Edit this page.