TreeViewGroup

Defined in: src/widgets/tree.ts:146

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

Extends

• TreeViewNode

Constructors

Constructor

new TreeViewGroup(dart): TreeViewGroup

Defined in: src/widgets/tree.ts:86

Parameters

Parameter	Type
dart	any

Returns

TreeViewGroup

Constructs

from the Dart object

Inherited from

TreeViewNode.constructor

Properties

Property	Type	Inherited from	Defined in
dart	any	TreeViewNode.dart	src/widgets/tree.ts:83

Accessors

autoCheckChildren

Get Signature

get autoCheckChildren(): boolean

Defined in: src/widgets/tree.ts:218

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

Returns

boolean

Set Signature

set autoCheckChildren(auto): void

Defined in: src/widgets/tree.ts:219

Parameters

Parameter	Type
auto	boolean

Returns

void

---

captionLabel

Get Signature

get captionLabel(): HTMLElement

Defined in: src/widgets/tree.ts:107

Caption label

Returns

HTMLElement

Inherited from

TreeViewNode.captionLabel

---

checkBox

Get Signature

get checkBox(): HTMLElement | null

Defined in: src/widgets/tree.ts:110

Check box element

Returns

HTMLElement | null

Inherited from

TreeViewNode.checkBox

---

checked

Get Signature

get checked(): boolean

Defined in: src/widgets/tree.ts:113

Returns true if checked

Returns

boolean

Set Signature

set checked(checked): void

Defined in: src/widgets/tree.ts:114

Parameters

Parameter	Type
checked	boolean

Returns

void

Inherited from

TreeViewNode.checked

---

children

Get Signature

get children(): TreeViewNode<any>[]

Defined in: src/widgets/tree.ts:197

Gets the node's children

Returns

TreeViewNode<any>[]

---

currentItem

Get Signature

get currentItem(): TreeViewNode

Defined in: src/widgets/tree.ts:222

Currently selected node.

Returns

TreeViewNode

Set Signature

set currentItem(node): void

Defined in: src/widgets/tree.ts:223

Parameters

Parameter	Type
node	TreeViewNode

Returns

void

---

expanded

Get Signature

get expanded(): boolean

Defined in: src/widgets/tree.ts:214

Controls expanded state.

Returns

boolean

Set Signature

set expanded(isExpanded): void

Defined in: src/widgets/tree.ts:215

Parameters

Parameter	Type
isExpanded	boolean

Returns

void

---

icon

Get Signature

get icon(): Element

Defined in: src/widgets/tree.ts:121

Node icon

Returns

Element

Set Signature

set icon(value): void

Defined in: src/widgets/tree.ts:122

Parameters

Parameter	Type
value	Element

Returns

void

Inherited from

TreeViewNode.icon

---

items

Get Signature

get items(): TreeViewNode<any>[]

Defined in: src/widgets/tree.ts:192

Gets all node items

Returns

TreeViewNode<any>[]

---

onChildNodeExpandedChanged

Get Signature

get onChildNodeExpandedChanged(): Observable<TreeViewGroup>

Defined in: src/widgets/tree.ts:251

Returns

Observable<TreeViewGroup>

---

onChildNodeExpanding

Get Signature

get onChildNodeExpanding(): Observable<TreeViewGroup>

Defined in: src/widgets/tree.ts:252

Returns

Observable<TreeViewGroup>

---

onNodeAdded

Get Signature

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

Defined in: src/widgets/tree.ts:249

Returns

Observable<TreeViewNode<any>>

---

onNodeCheckBoxToggled

Get Signature

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

Defined in: src/widgets/tree.ts:250

Returns

Observable<TreeViewNode<any>>

---

onNodeContextMenu

Get Signature

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

Defined in: src/widgets/tree.ts:254

Returns

Observable<TreeViewNode<any>>

---

onNodeEnter

Get Signature

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

Defined in: src/widgets/tree.ts:258

Returns

Observable<TreeViewNode<any>>

---

onNodeExpanding

Get Signature

get onNodeExpanding(): Observable<TreeViewGroup>

Defined in: src/widgets/tree.ts:248

Returns

Observable<TreeViewGroup>

---

onNodeMouseEnter

Get Signature

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

Defined in: src/widgets/tree.ts:256

Returns

Observable<TreeViewNode<any>>

---

onNodeMouseLeave

Get Signature

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

Defined in: src/widgets/tree.ts:257

Returns

Observable<TreeViewNode<any>>

---

onSelected

Get Signature

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

Defined in: src/widgets/tree.ts:138

Occurs when the selected node is changed.

Returns

Observable<TreeViewNode<any>>

Inherited from

TreeViewNode.onSelected

---

onSelectedNodeChanged

Get Signature

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

Defined in: src/widgets/tree.ts:255

Returns

Observable<TreeViewNode<any>>

---

parent

Get Signature

get parent(): TreeViewNode

Defined in: src/widgets/tree.ts:104

Node's parent

Returns

TreeViewNode

Inherited from

TreeViewNode.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: src/widgets/tree.ts:91

Visual root

Returns

HTMLElement

Inherited from

TreeViewNode.root

---

rootNode

Get Signature

get rootNode(): TreeViewGroup

Defined in: src/widgets/tree.ts:96

Top-most node.

Returns

TreeViewGroup

Inherited from

TreeViewNode.rootNode

---

tag

Get Signature

get tag(): any

Defined in: src/widgets/tree.ts:125

Auxiliary information associated with the node.

Returns

any

Set Signature

set tag(t): void

Defined in: src/widgets/tree.ts:126

Parameters

Parameter	Type
t	any

Returns

void

Inherited from

TreeViewNode.tag

---

text

Get Signature

get text(): string

Defined in: src/widgets/tree.ts:117

Node text

Returns

string

Set Signature

set text(value): void

Defined in: src/widgets/tree.ts:118

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

TreeViewNode.text

---

value

Get Signature

get value(): T

Defined in: src/widgets/tree.ts:129

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

Returns

T

Set Signature

set value(v): void

Defined in: src/widgets/tree.ts:130

Parameters

Parameter	Type
v	T

Returns

void

Inherited from

TreeViewNode.value

Methods

addItems()

addItems(items): TreeViewNode

Defined in: src/widgets/tree.ts:241

Adds new items to group

Parameters

Parameter	Type
items	any[]

Returns

TreeViewNode

---

enableCheckBox()

enableCheckBox(checked?): void

Defined in: src/widgets/tree.ts:133

Enables checkbox

Parameters

Parameter	Type	Default value
checked	boolean	false

Returns

void

Inherited from

TreeViewNode.enableCheckBox

---

getOrCreateGroup()

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

Defined in: src/widgets/tree.ts:231

Returns existing, or creates a new node group

Parameters

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

Returns

TreeViewGroup

---

group()

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

Defined in: src/widgets/tree.ts:226

Adds new group and returns it

Parameters

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

Returns

TreeViewGroup

---

item()

item(text, value?): TreeViewNode

Defined in: src/widgets/tree.ts:236

Adds new item to group

Parameters

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

Returns

TreeViewNode

---

loadSources()

loadSources(source): Promise<void>

Defined in: src/widgets/tree.ts:260

Parameters

Parameter	Type
source	HttpDataSource<any>

Returns

Promise<void>

---

remove()

remove(): void

Defined in: src/widgets/tree.ts:141

Removes the node and its children from the parent

Returns

void

Inherited from

TreeViewNode.remove

---

removeChildrenWhere()

removeChildrenWhere(predicate): void

Defined in: src/widgets/tree.ts:202

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

Parameters

Parameter	Type
predicate	(node) => boolean

Returns

void

---

fromItemCategories()

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

Defined in: src/widgets/tree.ts:152

Parameters

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

Returns

TreeViewGroup

---

tree()

static tree(): TreeViewGroup

Defined in: src/widgets/tree.ts:148

Creates new tree

Returns

TreeViewGroup