Class: TreeViewGroup

dg.TreeViewGroup

Tree view node. Sample: https://public.datagrok.ai/js/samples/ui/tree-view

Hierarchy

• TreeViewNode

  ↳ TreeViewGroup

Constructors

constructor

• new TreeViewGroup(dart)

Constructs

from the Dart object

Parameters

Name	Type
dart	any

Inherited from

TreeViewNode.constructor

Defined in

src/widgets.ts:1641

Properties

dart

• dart: any

Inherited from

TreeViewNode.dart

Defined in

src/widgets.ts:1638

Accessors

autoCheckChildren

• get autoCheckChildren(): boolean

Indicates whether check or uncheck is applied to a node only or to all node's children

Returns

boolean

Defined in

src/widgets.ts:1760

• set autoCheckChildren(auto): void

Parameters

Name	Type
auto	boolean

Returns

void

Defined in

src/widgets.ts:1761

---

captionLabel

• get captionLabel(): HTMLElement

Caption label

Returns

HTMLElement

Inherited from

TreeViewNode.captionLabel

Defined in

src/widgets.ts:1663

---

checkBox

• get checkBox(): null | HTMLElement

Check box element

Returns

null | HTMLElement

Inherited from

TreeViewNode.checkBox

Defined in

src/widgets.ts:1668

---

checked

• get checked(): boolean

Returns true if checked

Returns

boolean

Inherited from

TreeViewNode.checked

Defined in

src/widgets.ts:1673

• set checked(checked): void

Parameters

Name	Type
checked	boolean

Returns

void

Inherited from

TreeViewNode.checked

Defined in

src/widgets.ts:1674

---

children

• get children(): TreeViewNode<any>[]

Gets the node's children

Returns

TreeViewNode<any>[]

Defined in

src/widgets.ts:1751

---

expanded

• get expanded(): boolean

Returns

boolean

Defined in

src/widgets.ts:1755

• set expanded(isExpanded): void

Parameters

Name	Type
isExpanded	boolean

Returns

void

Defined in

src/widgets.ts:1757

---

items

• get items(): TreeViewNode<any>[]

Gets all node items

Returns

TreeViewNode<any>[]

Defined in

src/widgets.ts:1746

---

onChildNodeExpandedChanged

• get onChildNodeExpandedChanged(): Observable<TreeViewGroup>

Returns

Observable<TreeViewGroup>

Defined in

src/widgets.ts:1784

---

onChildNodeExpanding

• get onChildNodeExpanding(): Observable<TreeViewGroup>

Returns

Observable<TreeViewGroup>

Defined in

src/widgets.ts:1786

---

onNodeAdded

• get onNodeAdded(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1780

---

onNodeCheckBoxToggled

• get onNodeCheckBoxToggled(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1782

---

onNodeContextMenu

• get onNodeContextMenu(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1789

---

onNodeEnter

• get onNodeEnter(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1797

---

onNodeExpanding

• get onNodeExpanding(): Observable<TreeViewGroup>

Returns

Observable<TreeViewGroup>

Defined in

src/widgets.ts:1778

---

onNodeMouseEnter

• get onNodeMouseEnter(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1793

---

onNodeMouseLeave

• get onNodeMouseLeave(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1795

---

onSelected

• get onSelected(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Inherited from

TreeViewNode.onSelected

Defined in

src/widgets.ts:1692

---

onSelectedNodeChanged

• get onSelectedNodeChanged(): Observable<TreeViewNode<any>>

Returns

Observable<TreeViewNode<any>>

Defined in

src/widgets.ts:1791

---

parent

• get parent(): TreeViewNode<any>

Returns

TreeViewNode<any>

Inherited from

TreeViewNode.parent

Defined in

src/widgets.ts:1658

---

root

• get root(): HTMLElement

Visual root

Returns

HTMLElement

Inherited from

TreeViewNode.root

Defined in

src/widgets.ts:1646

---

rootNode

• get rootNode(): TreeViewGroup

Returns

TreeViewGroup

Inherited from

TreeViewNode.rootNode

Defined in

src/widgets.ts:1650

---

tag

• get tag(): any

Returns

any

Inherited from

TreeViewNode.tag

Defined in

src/widgets.ts:1679

• set tag(t): void

Parameters

Name	Type
t	any

Returns

void

Inherited from

TreeViewNode.tag

Defined in

src/widgets.ts:1680

---

text

• get text(): string

Node text

Returns

string

Inherited from

TreeViewNode.text

Defined in

src/widgets.ts:1677

---

value

• get value(): T

Node value

Returns

T

Inherited from

TreeViewNode.value

Defined in

src/widgets.ts:1683

• set value(v): void

Parameters

Name	Type
v	T

Returns

void

Inherited from

TreeViewNode.value

Defined in

src/widgets.ts:1684

Methods

enableCheckBox

▸ enableCheckBox(checked?): void

Enables checkbox

Parameters

Name	Type	Default value
checked	boolean	false

Returns

void

Inherited from

TreeViewNode.enableCheckBox

Defined in

src/widgets.ts:1687

---

getOrCreateGroup

▸ getOrCreateGroup(text, value?, expanded?): TreeViewGroup

Returns existing, or creates a new node group

Parameters

Name	Type	Default value
text	string	undefined
value	null | object	null
expanded	boolean	true

Returns

TreeViewGroup

Defined in

src/widgets.ts:1769

---

group

▸ group(text, value?, expanded?): TreeViewGroup

Adds new group

Parameters

Name	Type	Default value
text	string | Element	undefined
value	null | object	null
expanded	boolean	true

Returns

TreeViewGroup

Defined in

src/widgets.ts:1764

---

item

▸ item(text, value?): TreeViewNode<any>

Adds new item to group

Parameters

Name	Type	Default value
text	string | Element	undefined
value	null | object	null

Returns

TreeViewNode<any>

Defined in

src/widgets.ts:1774

---

remove

▸ remove(): void

Removes the node and its children from the parent

Returns

void

Inherited from

TreeViewNode.remove

Defined in

src/widgets.ts:1695

---

fromItemCategories

▸ Static fromItemCategories(items, props, options?): TreeViewGroup

Parameters

Name	Type
items	any[]
props	string[]
options?	Object
options.itemToElement?	(item: any) => Element
options.itemToString?	(item: any) => string
options.itemToValue?	(item: any) => any
options.removeEmpty	boolean

Returns

TreeViewGroup

Defined in

src/widgets.ts:1706

---

tree

▸ Static tree(): TreeViewGroup

Creates new tree

Returns

TreeViewGroup

Defined in

src/widgets.ts:1702