TreeViewGroup

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

Extends

• TreeViewNode

Constructors

new TreeViewGroup()

new TreeViewGroup(dart): TreeViewGroup

Parameters

Parameter	Type
dart	any

Returns

TreeViewGroup

Inherited from

TreeViewNode . constructor

Constructs

from the Dart object

Source

src/widgets/tree.ts:86

Properties

Property	Type	Inherited from
dart	any	TreeViewNode.dart

Accessors

autoCheckChildren

get autoCheckChildren(): boolean

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

set autoCheckChildren(auto): void

Parameters

Parameter	Type
auto	boolean

Returns

boolean

Source

src/widgets/tree.ts:218

---

captionLabel

get captionLabel(): HTMLElement

Caption label

Returns

HTMLElement

Source

src/widgets/tree.ts:107

---

checkBox

get checkBox(): null | HTMLElement

Check box element

Returns

null | HTMLElement

Source

src/widgets/tree.ts:110

---

checked

get checked(): boolean

Returns true if checked

set checked(checked): void

Parameters

Parameter	Type
checked	boolean

Returns

boolean

Source

src/widgets/tree.ts:113

---

children

get children(): TreeViewNode<any>[]

Gets the node's children

Returns

TreeViewNode<any>[]

Source

src/widgets/tree.ts:197

---

currentItem

get currentItem(): TreeViewNode<any>

Currently selected node.

set currentItem(node): void

Parameters

Parameter	Type
node	TreeViewNode<any>

Returns

TreeViewNode<any>

Source

src/widgets/tree.ts:222

---

expanded

get expanded(): boolean

Controls expanded state.

set expanded(isExpanded): void

Parameters

Parameter	Type
isExpanded	boolean

Returns

boolean

Source

src/widgets/tree.ts:214

---

icon

get icon(): Element

Node icon

set icon(value): void

Parameters

Parameter	Type
value	Element

Returns

Element

Source

src/widgets/tree.ts:121

---

items

get items(): TreeViewNode<any>[]

Gets all node items

Returns

TreeViewNode<any>[]

Source

src/widgets/tree.ts:192

---

onChildNodeExpandedChanged

get onChildNodeExpandedChanged(): Observable <TreeViewGroup>

Returns

Observable <TreeViewGroup>

Source

src/widgets/tree.ts:251

---

onChildNodeExpanding

get onChildNodeExpanding(): Observable <TreeViewGroup>

Returns

Observable <TreeViewGroup>

Source

src/widgets/tree.ts:252

---

onNodeAdded

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:249

---

onNodeCheckBoxToggled

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:250

---

onNodeContextMenu

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:254

---

onNodeEnter

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:258

---

onNodeExpanding

get onNodeExpanding(): Observable <TreeViewGroup>

Returns

Observable <TreeViewGroup>

Source

src/widgets/tree.ts:248

---

onNodeMouseEnter

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:256

---

onNodeMouseLeave

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:257

---

onSelected

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

Occurs when the selected node is changed.

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:138

---

onSelectedNodeChanged

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

Returns

Observable <TreeViewNode<any>>

Source

src/widgets/tree.ts:255

---

parent

get parent(): TreeViewNode<any>

Node's parent

Returns

TreeViewNode<any>

Source

src/widgets/tree.ts:104

---

root

get root(): HTMLElement

Visual root

Returns

HTMLElement

Source

src/widgets/tree.ts:91

---

rootNode

get rootNode(): TreeViewGroup

Top-most node.

Returns

TreeViewGroup

Source

src/widgets/tree.ts:96

---

tag

get tag(): any

Auxiliary information associated with the node.

set tag(t): void

Parameters

Parameter	Type
t	any

Returns

any

Source

src/widgets/tree.ts:125

---

text

get text(): string

Node text

set text(value): void

Parameters

Parameter	Type
value	string

Returns

string

Source

src/widgets/tree.ts:117

---

value

get value(): T

Node value. Normally, when you click on the node, the context panel shows this object.

set value(v): void

Parameters

Parameter	Type
v	T

Returns

T

Source

src/widgets/tree.ts:129

Methods

addItems()

addItems(items): TreeViewNode<any>

Adds new items to group

Parameters

Parameter	Type
items	any[]

Returns

TreeViewNode<any>

Source

src/widgets/tree.ts:241

---

enableCheckBox()

enableCheckBox(checked): void

Enables checkbox

Parameters

Parameter	Type	Default value
checked	boolean	false

Returns

void

Inherited from

TreeViewNode . enableCheckBox

Source

src/widgets/tree.ts:133

---

getOrCreateGroup()

getOrCreateGroup(text, value, expanded): TreeViewGroup

Returns existing, or creates a new node group

Parameters

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

Returns

TreeViewGroup

Source

src/widgets/tree.ts:231

---

group()

group(text, value, expanded, index): TreeViewGroup

Adds new group and returns it

Parameters

Parameter	Type	Default value
text	string | Element	undefined
value	null | object	null
expanded	boolean	true
index	null | number	null

Returns

TreeViewGroup

Source

src/widgets/tree.ts:226

---

item()

item(text, value): TreeViewNode<any>

Adds new item to group

Parameters

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

Returns

TreeViewNode<any>

Source

src/widgets/tree.ts:236

---

loadSources()

loadSources(source): Promise<void>

Parameters

Parameter	Type
source	HttpDataSource<any>

Returns

Promise<void>

Source

src/widgets/tree.ts:260

---

remove()

remove(): void

Removes the node and its children from the parent

Returns

void

Inherited from

TreeViewNode . remove

Source

src/widgets/tree.ts:141

---

removeChildrenWhere()

removeChildrenWhere(predicate): void

Removes all children (going down recursively) that satisfy the predicate

Parameters

Parameter	Type
predicate	(node) => boolean

Returns

void

Source

src/widgets/tree.ts:202

---

fromItemCategories()

static fromItemCategories(items, props, options?): TreeViewGroup

Parameters

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

Returns

TreeViewGroup

Source

src/widgets/tree.ts:152

---

tree()

static tree(): TreeViewGroup

Creates new tree

Returns

TreeViewGroup

Source

src/widgets/tree.ts:148