Winter Cardinal UI - v0.457.0 / DTableDataTree

Class: DTableDataTree<NODE>

Please note that this data class does not support the sorter.

Type parameters

Name	Type
NODE	extends DTableDataTreeNode<NODE, NODE>

Hierarchy

• EventEmitter

  ↳ DTableDataTree

Implements

• DTableData<NODE>

Table of contents

Constructors

• constructor

Properties

• _accessor
• _filter
• _flags
• _isRowsDirty
• _mapped
• _nodes
• _parent
• _reverse
• _rows
• _selection
• _sorter
• _supplimentals

Accessors

• accessor
• filter
• mapped
• nodes
• rows
• selection
• sorter
• supplimentals

Methods

• addListener
• bind
• close
• collapse
• each
• emit
• eventNames
• expand
• get
• isCollapsed
• isExpanded
• isOpened
• listenerCount
• listeners
• lock
• newRows
• newSelection
• off
• on
• once
• open
• removeAllListeners
• removeListener
• size
• toAccessor
• toSelection
• toSupplimental
• toggle
• unlock
• update
• updateRows

Constructors

constructor

• new DTableDataTree<NODE>(options?): DTableDataTree<NODE>

Type parameters

Name	Type
NODE	extends DTableDataTreeNode<NODE, NODE>

Parameters

Name	Type
options?	DTableDataTreeOptions<NODE, any>

Returns

DTableDataTree<NODE>

Overrides

utils.EventEmitter.constructor

Defined in

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

Properties

_accessor

• Protected _accessor: DTableDataTreeItemAccessor<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:117

---

_filter

• Protected _filter: DTableDataTreeFilter<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:113

---

_flags

• Protected _flags: WeakMap<NODE, number>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:112

---

_isRowsDirty

• Protected _isRowsDirty: boolean

Defined in

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

---

_mapped

• Protected _mapped: DTableDataMapped<NODE>

Defined in

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

---

_nodes

• Protected Optional _nodes: NODE[]

Defined in

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

---

_parent

• Protected _parent: null | DTableDataParent

Defined in

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

---

_reverse

• Protected _reverse: boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:118

---

_rows

• Protected _rows: NODE[]

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:109

---

_selection

• Protected _selection: DTableDataTreeSelection<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:115

---

_sorter

• Protected _sorter: DTableDataTreeSorter<NODE>

Defined in

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

---

_supplimentals

• Protected _supplimentals: number[]

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:111

Accessors

accessor

• get accessor(): DTableDataTreeItemAccessor<NODE>

Returns

DTableDataTreeItemAccessor<NODE>

Defined in

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

---

filter

• get filter(): DTableDataFilter<NODE>

A data filter.

Returns

DTableDataFilter<NODE>

Implementation of

DTableData.filter

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:402

---

mapped

• get mapped(): DTableDataMapped<NODE>

Sorted and filtered data.

Returns

DTableDataMapped<NODE>

Implementation of

DTableData.mapped

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:410

---

nodes

• get nodes(): undefined | NODE[]

Returns

undefined | NODE[]

Defined in

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

• set nodes(nodes): void

Parameters

Name	Type
nodes	undefined | NODE[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:190

---

rows

• get rows(): NODE[]

A list of rows.

Returns

NODE[]

Implementation of

DTableData.rows

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:198

---

selection

• get selection(): DTableDataSelection<NODE>

A data selection.

Returns

DTableDataSelection<NODE>

Implementation of

DTableData.selection

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:398

---

sorter

• get sorter(): DTableDataSorter<NODE>

A data sorter.

Returns

DTableDataSorter<NODE>

Implementation of

DTableData.sorter

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:406

---

supplimentals

• get supplimentals(): number[]

Returns

number[]

Defined in

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

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

DTableData.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

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

---

bind

▸ bind(parent): void

Parameters

Name	Type
parent	DTableDataParent

Returns

void

Implementation of

DTableData.bind

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:182

---

close

▸ close(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Deprecated

in favor of collapse.

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:373

---

collapse

▸ collapse(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:339

---

each

▸ each(iteratee, ifrom?, ito?): void

Calls the specified iteratee on each datum of the specified index range. If called iteratee explicitly returns false, stops an iteration.

Parameters

Name	Type	Description
iteratee	(node: NODE, index: number) => boolean | void	an function called on each datum
ifrom?	number	an index to start an iteration
ito?	number	an index before which an interation stops

Returns

void

Implementation of

DTableData.each

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:382

---

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

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

DTableData.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

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

---

expand

▸ expand(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:327

---

get

▸ get(index): null | NODE

Returns a row data at the specified index. The index is an index on rows filters and sorters are not applied.

Parameters

Name	Type	Description
index	number	an index on rows filters and sorters are not applied

Returns

null | NODE

Implementation of

DTableData.get

Defined in

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

---

isCollapsed

▸ isCollapsed(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:351

---

isExpanded

▸ isExpanded(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:355

---

isOpened

▸ isOpened(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Deprecated

in favor of isExpanded.

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:378

---

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

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

DTableData.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

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

---

lock

▸ lock(): void

Returns

void

Implementation of

DTableData.lock

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:301

---

newRows

▸ newRows(nodes, irows, ilevel, rows, supplimentals, flags, reverse, toChildren, hasChildren): number

Parameters

Name	Type
nodes	NODE[]
irows	number
ilevel	number
rows	NODE[]
supplimentals	number[]
flags	WeakMap<NODE, number>
reverse	boolean
toChildren	DTableDataTreeItemAccessorToChildren<NODE>
hasChildren	DTableDataTreeItemAccessorHasChildren<NODE>

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:249

---

newSelection

▸ newSelection(options?): DTableDataTreeSelection<NODE>

Parameters

Name	Type
options?	DTableDataTreeSelectionOptions

Returns

DTableDataTreeSelection<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:172

---

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

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

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

DTableData.once

Inherited from

utils.EventEmitter.once

Defined in

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

---

open

▸ open(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Deprecated

in favor of expand.

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:368

---

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

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

DTableData.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

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

---

size

▸ size(): number

Returns a size of rows.

Returns

number

Implementation of

DTableData.size

Defined in

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

---

toAccessor

▸ toAccessor(options?): DTableDataTreeItemAccessor<NODE>

Parameters

Name	Type
options?	DTableDataTreeOptions<NODE, any>

Returns

DTableDataTreeItemAccessor<NODE>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:178

---

toSelection

▸ toSelection(options?): DTableDataTreeSelection<NODE>

Parameters

Name	Type
options?	DTableDataTreeSelectionOptions | DTableDataTreeSelection<NODE> | DTableDataTreeSelectionCreator<NODE>

Returns

DTableDataTreeSelection<NODE>

Defined in

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

---

toSupplimental

▸ toSupplimental(ilevel, hasChildren, isOpened): number

Parameters

Name	Type
ilevel	number
hasChildren	boolean
isOpened	boolean

Returns

number

Defined in

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

---

toggle

▸ toggle(node): boolean

Parameters

Name	Type
node	NODE

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:359

---

unlock

▸ unlock(callIfNeeded): void

Parameters

Name	Type
callIfNeeded	boolean

Returns

void

Implementation of

DTableData.unlock

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:308

---

update

▸ update(forcibly?): void

Parameters

Name	Type
forcibly?	boolean

Returns

void

Implementation of

DTableData.update

Defined in

src/main/typescript/wcardinal/ui/d-table-data-tree.ts:294

---

updateRows

▸ updateRows(nodes): void

Parameters

Name	Type
nodes	undefined | NODE[]

Returns

void

Defined in

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

Edit this page.