Winter Cardinal UI - v0.442.0 / DTableDataSelection

Interface: DTableDataSelection<ROW>

Type parameters

Name
ROW

Hierarchy

Implemented by

Table of contents

Properties

Methods

Properties

first

Readonly first: null | number

Defined in

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


indices

Readonly indices: number[]

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

Defined in

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


last

Readonly last: null | number

Defined in

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


parent

Readonly parent: DTableData<ROW>

Defined in

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


rows

Readonly rows: ROW[]

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

Defined in

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


type

Readonly type: DTableDataSelectionType

Defined in

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

Methods

add

add(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Defined in

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


addAll

addAll(rowIndices): void

Parameters

Name Type
rowIndices number[]

Returns

void

Defined in

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


addListener

addListener(event, fn, context?): this

Alias method for on

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

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

Defined in

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


addTo

addTo(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Defined in

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


clear

clear(): void

Returns

void

Defined in

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


clearAndAdd

clearAndAdd(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Defined in

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


clearAndAddAll

clearAndAddAll(rowIndices): void

Parameters

Name Type
rowIndices number[]

Returns

void

Defined in

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


contains

contains(rowIndex): boolean

Parameters

Name Type
rowIndex number

Returns

boolean

Defined in

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


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

Defined in

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


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.

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)[]

Inherited from

utils.EventEmitter.eventNames

Defined in

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


isEmpty

isEmpty(): boolean

Returns

boolean

Defined in

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


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

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[]

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

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.

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.

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

Defined in

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


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.

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.

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

Defined in

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


size

size(): number

Returns

number

Defined in

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


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][]

Defined in

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


toMap

toMap(): Map<number, ROW>

Returns

Map<number, ROW>

Defined in

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


toObject

toObject(): Record<number, ROW>

Returns

Record<number, ROW>

Defined in

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


toSortedArray

toSortedArray(): [number, ROW][]

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

Returns

[number, ROW][]

Defined in

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


toggle

toggle(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Defined in

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