Winter Cardinal UI - v0.457.0 / DTableDataListSelection

Class: DTableDataListSelection<ROW>

Type parameters

Name
ROW

Hierarchy

• EventEmitter

  ↳ DTableDataListSelection

Implements

• DTableDataSelection<ROW>

Table of contents

Constructors

• constructor

Properties

• _indices
• _parent
• _type

Accessors

• first
• indices
• last
• parent
• rows
• type

Methods

• add
• addAll
• addListener
• addRange
• addTo
• clear
• clearAndAdd
• clearAndAddAll
• contains
• each
• emit
• eventNames
• isEmpty
• listenerCount
• listeners
• off
• on
• onChange
• once
• remove
• removeAllListeners
• removeListener
• shift
• size
• toArray
• toMap
• toObject
• toSortedArray
• toggle

Constructors

constructor

• new DTableDataListSelection<ROW>(parent, options?): DTableDataListSelection<ROW>

Type parameters

Name
ROW

Parameters

Name	Type
parent	DTableDataSelectionParent<ROW>
options?	DTableDataSelectionOptions<any>

Returns

DTableDataListSelection<ROW>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:29

Properties

_indices

• Protected _indices: Set<number>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:27

---

_parent

• Protected _parent: DTableDataSelectionParent<ROW>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:25

---

_type

• Protected _type: DTableDataSelectionType

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:26

Accessors

first

• get first(): null | number

Returns

null | number

Implementation of

DTableDataSelection.first

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:81

---

indices

• get indices(): number[]

Returns a copy of an index array of selected rows. The order of indices is an insertion order.

Returns

number[]

Implementation of

DTableDataSelection.indices

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:229

---

last

• get last(): null | number

Returns

null | number

Implementation of

DTableDataSelection.last

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:95

---

parent

• get parent(): DTableData<ROW>

Returns

DTableData<ROW>

Implementation of

DTableDataSelection.parent

Defined in

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

---

rows

• get rows(): ROW[]

Returns a copy of an array of selected row value. The order is an insertion order.

Returns

ROW[]

Implementation of

DTableDataSelection.rows

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:241

---

type

• get type(): DTableDataSelectionType

Returns

DTableDataSelectionType

Implementation of

DTableDataSelection.type

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:52

Methods

add

▸ add(rowIndex): void

Parameters

Name	Type
rowIndex	number

Returns

void

Implementation of

DTableDataSelection.add

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:71

---

addAll

▸ addAll(rowIndices): void

Parameters

Name	Type
rowIndices	number[]

Returns

void

Implementation of

DTableDataSelection.addAll

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:136

---

addListener

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

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Implementation of

DTableDataSelection.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

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

---

addRange

▸ addRange(from, includeFrom, to, includeTo): void

Parameters

Name	Type
from	number
includeFrom	boolean
to	number
includeTo	boolean

Returns

void

Implementation of

DTableDataSelection.addRange

Defined in

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

---

addTo

▸ addTo(rowIndex): void

Parameters

Name	Type
rowIndex	number

Returns

void

Implementation of

DTableDataSelection.addTo

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:107

---

clear

▸ clear(): void

Returns

void

Implementation of

DTableDataSelection.clear

Defined in

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

---

clearAndAdd

▸ clearAndAdd(rowIndex): void

Parameters

Name	Type
rowIndex	number

Returns

void

Implementation of

DTableDataSelection.clearAndAdd

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:166

---

clearAndAddAll

▸ clearAndAddAll(rowIndices): void

Parameters

Name	Type
rowIndices	number[]

Returns

void

Implementation of

DTableDataSelection.clearAndAddAll

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:175

---

contains

▸ contains(rowIndex): boolean

Parameters

Name	Type
rowIndex	number

Returns

boolean

Implementation of

DTableDataSelection.contains

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:148

---

each

▸ each(iteratee): void

Calls the specified iteratee on each indices. If called iteratee explicitly returns false, stops an iteration.

Parameters

Name	Type	Description
iteratee	DTableDataSelectionEachIteratee	an function called on each indices

Returns

void

Implementation of

DTableDataSelection.each

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:214

---

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

DTableDataSelection.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

DTableDataSelection.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

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

---

isEmpty

▸ isEmpty(): boolean

Returns

boolean

Implementation of

DTableDataSelection.isEmpty

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:210

---

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

DTableDataSelection.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

DTableDataSelection.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

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

---

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

DTableDataSelection.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

DTableDataSelection.on

Inherited from

utils.EventEmitter.on

Defined in

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

---

onChange

▸ onChange(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:56

---

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

DTableDataSelection.once

Inherited from

utils.EventEmitter.once

Defined in

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

---

remove

▸ remove(rowIndex): void

Parameters

Name	Type
rowIndex	number

Returns

void

Implementation of

DTableDataSelection.remove

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:152

---

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

DTableDataSelection.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

DTableDataSelection.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

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

---

shift

▸ shift(rowIndex, amount): void

Parameters

Name	Type
rowIndex	number
amount	number

Returns

void

Implementation of

DTableDataSelection.shift

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:186

---

size

▸ size(): number

Returns

number

Implementation of

DTableDataSelection.size

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:206

---

toArray

▸ toArray(): [number, ROW][]

Returns an array of the (index, row value) pairs of selected rows. The order of pairs is an insertion order.

Returns

[number, ROW][]

Implementation of

DTableDataSelection.toArray

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:254

---

toMap

▸ toMap(): Map<number, ROW>

Returns

Map<number, ROW>

Implementation of

DTableDataSelection.toMap

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:279

---

toObject

▸ toObject(): Record<number, ROW>

Returns

Record<number, ROW>

Implementation of

DTableDataSelection.toObject

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:270

---

toSortedArray

▸ toSortedArray(): [number, ROW][]

Returns an sorted array of the (index, row value) pairs of selected rows.

Returns

[number, ROW][]

Implementation of

DTableDataSelection.toSortedArray

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:266

---

toggle

▸ toggle(rowIndex): void

Parameters

Name	Type
rowIndex	number

Returns

void

Implementation of

DTableDataSelection.toggle

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-selection.ts:61

Edit this page.