Winter Cardinal UI - v0.442.0 / DTreeDataSelectionSingle
Name | Type |
---|---|
NODE |
extends DTreeNode |
EventEmitter
↳ DTreeDataSelectionSingle
DTreeDataSelection
<NODE
>• new DTreeDataSelectionSingle<NODE
>(parent
, options?
): DTreeDataSelectionSingle
<NODE
>
Name | Type |
---|---|
NODE |
extends DTreeNode |
Name | Type |
---|---|
parent |
DTreeDataSelectionParent <NODE > |
options? |
DTreeDataSelectionOptions <NODE , any > |
DTreeDataSelectionSingle
<NODE
>
utils.EventEmitter.constructor
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:22
• Protected
_node: null
| NODE
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:20
• Protected
_parent: DTreeDataSelectionParent
<NODE
>
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:19
• get
first(): null
| NODE
A first selected node or null.
null
| NODE
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:43
• get
last(): null
| NODE
A last selected node or null.
null
| NODE
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:47
• get
type(): DTreeDataSelectionType
A type.
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:39
▸ add(target
): boolean
Adds the given node
Name | Type | Description |
---|---|---|
target |
NODE |
a node |
boolean
true if succeeded.
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:58
▸ addListener(event
, fn
, context?
): this
Alias method for on
Name | Type |
---|---|
event |
string | symbol |
fn |
Function |
context? |
any |
this
DTreeDataSelection.addListener
utils.EventEmitter.addListener
node_modules/pixi.js/pixi.js.d.ts:25495
▸ clear(): boolean
Clears all the nodes.
boolean
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:86
▸ clearAndAdd(target
): boolean
Clears all the exisint nodes and adds the given node.
Name | Type | Description |
---|---|---|
target |
NODE |
a node to be added |
boolean
true if the selection is changed
DTreeDataSelection.clearAndAdd
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:95
▸ clearAndAddAll(targets
): boolean
Clears the exising nodes and add all the given nodes.
Name | Type | Description |
---|---|---|
targets |
NODE [] |
nodes to be added |
boolean
true if the selection is changed
DTreeDataSelection.clearAndAddAll
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:105
▸ contains(target
): boolean
Returns true if the given node is selected.
Name | Type | Description |
---|---|---|
target |
NODE |
a node to be checked |
boolean
true if the given node is selected
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:114
▸ each(iteratee
): void
Iterates over selected nodes.
Name | Type | Description |
---|---|---|
iteratee |
(node : NODE ) => boolean | void |
an iteratee |
void
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:126
▸ 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
▸ get(index
): null
| NODE
Returns a node at the given index or null.
Name | Type | Description |
---|---|---|
index |
number |
an index |
null
| NODE
a node at the given index or null
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:51
▸ isEmpty(): boolean
Returns true if the selection is empty.
boolean
true if the selection is empty
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:122
▸ listenerCount(event
): number
Return the number of listeners listening to a given event.
Name | Type | Description |
---|---|---|
event |
string | symbol |
The event name. |
number
DTreeDataSelection.listenerCount
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
▸ newNode(items
, existing
): null
| NODE
Name | Type |
---|---|
items |
NODE [] |
existing |
null | NODE |
null
| NODE
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:157
▸ 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
▸ onChange(): void
void
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:141
▸ onNodeChange(nodes
): void
Name | Type |
---|---|
nodes |
NODE [] |
void
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:146
▸ 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
▸ remove(target
): boolean
Removes the given node.
Name | Type | Description |
---|---|---|
target |
NODE |
a node |
boolean
true if succeeded
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:67
▸ removeAllListeners(event?
): this
Remove all listeners, or those of the specified event.
Name | Type | Description |
---|---|---|
event? |
string | symbol |
The event name. |
this
this
.
DTreeDataSelection.removeAllListeners
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
.
DTreeDataSelection.removeListener
utils.EventEmitter.removeListener
node_modules/pixi.js/pixi.js.d.ts:25475
▸ size(): number
Returns the number of selected nodes.
number
the number of selected nodes
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:118
▸ toArray(): NODE
[]
Returns an array of selected nodes.
NODE
[]
an array of selected nodes.
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:133
▸ toggle(target
): boolean
Toggles the given node.
Name | Type | Description |
---|---|---|
target |
NODE |
a node |
boolean
true if succeeded.
src/main/typescript/wcardinal/ui/d-tree-data-selection-single.ts:76