Winter Cardinal UI - v0.442.0 / DTableDataTree
Please note that this data class does not support the sorter.
Name | Type |
---|---|
NODE |
extends DTableDataTreeNode <NODE , NODE > |
EventEmitter
↳ DTableDataTree
DTableData
<NODE
>• new DTableDataTree<NODE
>(options?
): DTableDataTree
<NODE
>
Name | Type |
---|---|
NODE |
extends DTableDataTreeNode <NODE , NODE > |
Name | Type |
---|---|
options? |
DTableDataTreeOptions <NODE , any > |
DTableDataTree
<NODE
>
utils.EventEmitter.constructor
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:120
• Protected
_accessor: DTableDataTreeItemAccessor
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:117
• Protected
_filter: DTableDataTreeFilter
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:113
• Protected
_flags: WeakMap
<NODE
, number
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:112
• Protected
_isRowsDirty: boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:110
• Protected
_mapped: DTableDataMapped
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:116
• Protected
Optional
_nodes: NODE
[]
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:108
• Protected
_parent: null
| DTableDataParent
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:107
• Protected
_reverse: boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:118
• Protected
_rows: NODE
[]
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:109
• Protected
_selection: DTableDataTreeSelection
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:115
• Protected
_sorter: DTableDataTreeSorter
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:114
• Protected
_supplimentals: number
[]
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:111
• get
accessor(): DTableDataTreeItemAccessor
<NODE
>
DTableDataTreeItemAccessor
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:210
• get
filter(): DTableDataFilter
<NODE
>
A data filter.
DTableDataFilter
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:402
• get
mapped(): DTableDataMapped
<NODE
>
Sorted and filtered data.
DTableDataMapped
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:410
• get
nodes(): undefined
| NODE
[]
undefined
| NODE
[]
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:186
• set
nodes(nodes
): void
Name | Type |
---|---|
nodes |
undefined | NODE [] |
void
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:190
• get
rows(): NODE
[]
A list of rows.
NODE
[]
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:198
• get
selection(): DTableDataSelection
<NODE
>
A data selection.
DTableDataSelection
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:398
• get
sorter(): DTableDataSorter
<NODE
>
A data sorter.
DTableDataSorter
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:406
• get
supplimentals(): number
[]
number
[]
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:206
▸ addListener(event
, fn
, context?
): this
Alias method for on
Name | Type |
---|---|
event |
string | symbol |
fn |
Function |
context? |
any |
this
utils.EventEmitter.addListener
node_modules/pixi.js/pixi.js.d.ts:25495
▸ bind(parent
): void
Name | Type |
---|---|
parent |
DTableDataParent |
void
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:182
▸ close(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
Deprecated
in favor of collapse.
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:373
▸ collapse(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:339
▸ 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.
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 |
void
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:382
▸ emit(event
, ...args
): boolean
Calls each of the listeners registered for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
...args |
any [] |
Arguments that are passed to registered listeners |
boolean
true
if the event had listeners, else false
.
utils.EventEmitter.emit
node_modules/pixi.js/pixi.js.d.ts:25441
▸ eventNames(): (string
| symbol
)[]
Return an array listing the events for which the emitter has registered listeners.
(string
| symbol
)[]
utils.EventEmitter.eventNames
node_modules/pixi.js/pixi.js.d.ts:25415
▸ expand(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:327
▸ 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.
Name | Type | Description |
---|---|---|
index |
number |
an index on rows filters and sorters are not applied |
null
| NODE
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:319
▸ isCollapsed(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:351
▸ isExpanded(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:355
▸ isOpened(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
Deprecated
in favor of isExpanded.
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:378
▸ listenerCount(event
): number
Return the number of listeners listening to a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
number
utils.EventEmitter.listenerCount
node_modules/pixi.js/pixi.js.d.ts:25432
▸ listeners(event
): Function
[]
Return the listeners registered for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
Function
[]
utils.EventEmitter.listeners
node_modules/pixi.js/pixi.js.d.ts:25424
▸ lock(): void
void
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:301
▸ newRows(nodes
, irows
, ilevel
, rows
, supplimentals
, flags
, reverse
, toChildren
, hasChildren
): number
Name | Type |
---|---|
nodes |
NODE [] |
irows |
number |
ilevel |
number |
rows |
NODE [] |
supplimentals |
number [] |
flags |
WeakMap <NODE , number > |
reverse |
boolean |
toChildren |
DTableDataTreeItemAccessorToChildren <NODE > |
hasChildren |
DTableDataTreeItemAccessorHasChildren <NODE > |
number
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:249
▸ newSelection(options?
): DTableDataTreeSelection
<NODE
>
Name | Type |
---|---|
options? |
DTableDataTreeSelectionOptions |
DTableDataTreeSelection
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:172
▸ off(event
, fn?
, context?
, once?
): this
Alias method for removeListener
Name | Type |
---|---|
event |
string | symbol |
fn? |
Function |
context? |
any |
once? |
boolean |
this
utils.EventEmitter.off
node_modules/pixi.js/pixi.js.d.ts:25489
▸ on(event
, fn
, context?
): this
Add a listener for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
fn |
Function |
The listener function. |
context? |
any |
The context to invoke the listener with. |
this
this
.
utils.EventEmitter.on
node_modules/pixi.js/pixi.js.d.ts:25452
▸ once(event
, fn
, context?
): this
Add a one-time listener for a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
fn |
Function |
The listener function. |
context? |
any |
The context to invoke the listener with. |
this
this
.
utils.EventEmitter.once
node_modules/pixi.js/pixi.js.d.ts:25463
▸ open(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
Deprecated
in favor of expand.
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:368
▸ removeAllListeners(event?
): this
Remove all listeners, or those of the specified event.
Name | Type | Description |
---|---|---|
event? |
string | symbol |
The event name. |
this
this
.
utils.EventEmitter.removeAllListeners
node_modules/pixi.js/pixi.js.d.ts:25483
▸ removeListener(event
, fn?
, context?
, once?
): this
Remove the listeners of a given event.
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. |
this
this
.
utils.EventEmitter.removeListener
node_modules/pixi.js/pixi.js.d.ts:25475
▸ size(): number
Returns a size of rows.
number
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:315
▸ toAccessor(options?
): DTableDataTreeItemAccessor
<NODE
>
Name | Type |
---|---|
options? |
DTableDataTreeOptions <NODE , any > |
DTableDataTreeItemAccessor
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:178
▸ toSelection(options?
): DTableDataTreeSelection
<NODE
>
Name | Type |
---|---|
options? |
DTableDataTreeSelectionOptions | DTableDataTreeSelection <NODE > | DTableDataTreeSelectionCreator <NODE > |
DTableDataTreeSelection
<NODE
>
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:158
▸ toSupplimental(ilevel
, hasChildren
, isOpened
): number
Name | Type |
---|---|
ilevel |
number |
hasChildren |
boolean |
isOpened |
boolean |
number
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:241
▸ toggle(node
): boolean
Name | Type |
---|---|
node |
NODE |
boolean
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:359
▸ unlock(callIfNeeded
): void
Name | Type |
---|---|
callIfNeeded |
boolean |
void
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:308
▸ update(forcibly?
): void
Name | Type |
---|---|
forcibly? |
boolean |
void
src/main/typescript/wcardinal/ui/d-table-data-tree.ts:294
▸ updateRows(nodes
): void
Name | Type |
---|---|
nodes |
undefined | NODE [] |
void