Winter Cardinal UI - v0.442.0 / DTableDataTreeSelectionImpl

Class: DTableDataTreeSelectionImpl<NODE>

Type parameters

Name
NODE

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DTableDataTreeSelectionImpl<NODE>(parent, options?): DTableDataTreeSelectionImpl<NODE>

Type parameters

Name
NODE

Parameters

Name Type
parent DTableDataTreeSelectionParent<NODE>
options? DTableDataSelectionOptions<any>

Returns

DTableDataTreeSelectionImpl<NODE>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:35

Properties

_parent

Protected _parent: DTableDataTreeSelectionParent<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:31


_rows

Protected _rows: Set<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:33


_type

Protected _type: DTableDataSelectionType

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:32

Accessors

first

get first(): null | number

Returns

null | number

Implementation of

DTableDataTreeSelection.first

Defined in

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


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

DTableDataTreeSelection.indices

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:97


last

get last(): null | number

Returns

null | number

Implementation of

DTableDataTreeSelection.last

Defined in

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


parent

get parent(): DTableData<NODE>

Returns

DTableData<NODE>

Implementation of

DTableDataTreeSelection.parent

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:53


rows

get rows(): NODE[]

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

Returns

NODE[]

Implementation of

DTableDataTreeSelection.rows

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:108


type

get type(): DTableDataSelectionType

Returns

DTableDataSelectionType

Implementation of

DTableDataTreeSelection.type

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:116

Methods

add

add(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Implementation of

DTableDataTreeSelection.add

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:192


addAll

addAll(rowIndices): void

Parameters

Name Type
rowIndices number[]

Returns

void

Implementation of

DTableDataTreeSelection.addAll

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:237


addListener

addListener(event, fn, context?): this

Alias method for on

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

Implementation of

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

DTableDataTreeSelection.addRange

Defined in

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


addTo

addTo(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Implementation of

DTableDataTreeSelection.addTo

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:203


clear

clear(): void

Returns

void

Implementation of

DTableDataTreeSelection.clear

Defined in

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


clearAndAdd

clearAndAdd(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Implementation of

DTableDataTreeSelection.clearAndAdd

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:278


clearAndAddAll

clearAndAddAll(rowIndices): void

Parameters

Name Type
rowIndices number[]

Returns

void

Implementation of

DTableDataTreeSelection.clearAndAddAll

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:296


contains

contains(rowIndex): boolean

Parameters

Name Type
rowIndex number

Returns

boolean

Implementation of

DTableDataTreeSelection.contains

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:251


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

DTableDataTreeSelection.each

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:323


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

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

DTableDataTreeSelection.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

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


getFirst

getFirst(): null | NODE

Returns

null | NODE

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:120


getLast

getLast(): null | NODE

Returns

null | NODE

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:134


isEmpty

isEmpty(): boolean

Returns

boolean

Implementation of

DTableDataTreeSelection.isEmpty

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:319


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

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

DTableDataTreeSelection.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

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


newRows

newRows(nodes, toChildren, hasChildren, rows, result): Set<NODE>

Parameters

Name Type
nodes NODE[]
toChildren DTableDataTreeItemAccessorToChildren<NODE>
hasChildren DTableDataTreeItemAccessorHasChildren<NODE>
rows Set<NODE>
result Set<NODE>

Returns

Set<NODE>

Defined in

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


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

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

DTableDataTreeSelection.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-tree-selection-impl.ts:174


onNodeChange

onNodeChange(nodes?): void

Parameters

Name Type
nodes? NODE[]

Returns

void

Implementation of

DTableDataTreeSelection.onNodeChange

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:57


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

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

DTableDataTreeSelection.remove

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:259


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

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

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

DTableDataTreeSelection.shift

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:311


size

size(): number

Returns

number

Implementation of

DTableDataTreeSelection.size

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:315


toArray

toArray(): [number, NODE][]

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

Returns

[number, NODE][]

Implementation of

DTableDataTreeSelection.toArray

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:335


toIndex

toIndex(target): null | number

Parameters

Name Type
target NODE

Returns

null | number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:146


toMap

toMap(): Map<number, NODE>

Returns

Map<number, NODE>

Implementation of

DTableDataTreeSelection.toMap

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:361


toObject

toObject(): Record<number, NODE>

Returns

Record<number, NODE>

Implementation of

DTableDataTreeSelection.toObject

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:350


toSortedArray

toSortedArray(): [number, NODE][]

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

Returns

[number, NODE][]

Implementation of

DTableDataTreeSelection.toSortedArray

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:346


toggle

toggle(rowIndex): void

Parameters

Name Type
rowIndex number

Returns

void

Implementation of

DTableDataTreeSelection.toggle

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree-selection-impl.ts:179