Winter Cardinal UI - v0.457.0 / DTreeDataLike

Interface: DTreeDataLike<NODE>

Type parameters

Name	Type
NODE	extends DTreeNode

Hierarchy

• DTreeDataLike

  ↳ DTreeData

Implemented by

• DTree

Table of contents

Properties

• selection

Methods

• add
• addAfter
• addBefore
• clear
• collapse
• collapseAll
• each
• expand
• expandAll
• isCollapsed
• isExpanded
• remove
• toggle
• update

Properties

selection

• Readonly selection: DTreeDataSelection<NODE>

A selection.

Defined in

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

Methods

add

▸ add(target, parent?): boolean

Inserts a node.

Parameters

Name	Type	Description
target	NODE	a new node
parent?	NODE	a parent node

Returns

boolean

true if the data is changed

Defined in

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

---

addAfter

▸ addAfter(target, sibling): boolean

Inserts the given node after the given sibling.

Parameters

Name	Type	Description
target	NODE	a new node
sibling	NODE	a sibling node

Returns

boolean

true if the data is changed

Defined in

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

---

addBefore

▸ addBefore(target, sibling): boolean

Inserts the given node before the given sibling.

Parameters

Name	Type	Description
target	NODE	a new node
sibling	NODE	a sibling node

Returns

boolean

true if the data is changed

Defined in

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

---

clear

▸ clear(): boolean

Clears all the nodes.

Returns

boolean

true if the data is changed

Defined in

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

---

collapse

▸ collapse(target): boolean

Collapses the given node.

Parameters

Name	Type	Description
target	NODE	a node to be collapsed

Returns

boolean

true if succeeded

Defined in

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

---

collapseAll

▸ collapseAll(): boolean

Collapses all the nodes.

Returns

boolean

true if the data is changed

Defined in

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

---

each

▸ each(iteratee): void

Iterates over all the nodes. If the iteratee explicitly returns false, stops an iteration.

Parameters

Name	Type	Description
iteratee	DTreeNodeIteratee<NODE>	an iteratee

Returns

void

Defined in

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

---

expand

▸ expand(target): boolean

Expands the given node.

Parameters

Name	Type	Description
target	NODE	a node to be expanded

Returns

boolean

true if succeeded

Defined in

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

---

expandAll

▸ expandAll(): boolean

Expands all the nodes.

Returns

boolean

true if the data is changed

Defined in

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

---

isCollapsed

▸ isCollapsed(target): boolean

Returns true if the given node is collapsed.

Parameters

Name	Type	Description
target	NODE	a node to be checked.

Returns

boolean

true if the given node is collapsed

Defined in

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

---

isExpanded

▸ isExpanded(target): boolean

Returns true if the given item is expanded.

Parameters

Name	Type	Description
target	NODE	an item to be checked

Returns

boolean

true if the given item is expanded

Defined in

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

---

remove

▸ remove(target): boolean

Removes the given node.

Parameters

Name	Type	Description
target	NODE	a node to be removed

Returns

boolean

true if succeeded

Defined in

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

---

toggle

▸ toggle(target): boolean

Toggles the given node,

Parameters

Name	Type	Description
target	NODE	a node

Returns

boolean

Retrn

true if succeeded

Defined in

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

---

update

▸ update(forcibly?): void

Parameters

Name	Type
forcibly?	boolean

Returns

void

Defined in

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

Edit this page.