TreeViewGroup

Defined in: js-api/src/widgets/tree.ts:147

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

Extends

• TreeViewNode

Constructors

Constructor

new TreeViewGroup(dart): TreeViewGroup

Defined in: js-api/src/widgets/tree.ts:87

Parameters

Parameter	Type
dart	any

Returns

TreeViewGroup

Inherited from

TreeViewNode.constructor

Properties

Property	Type	Inherited from	Defined in
dart	any	TreeViewNode.dart	js-api/src/widgets/tree.ts:84

Accessors

autoCheckChildren

Get Signature

get autoCheckChildren(): boolean

Defined in: js-api/src/widgets/tree.ts:225

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: js-api/src/widgets/tree.ts:226

Parameters

Parameter	Type
auto	boolean

Returns

void

---

captionLabel

Get Signature

get captionLabel(): HTMLElement

Defined in: js-api/src/widgets/tree.ts:108

Caption label

Returns

HTMLElement

Inherited from

TreeViewNode.captionLabel

---

checkBox

Get Signature

get checkBox(): HTMLElement | null

Defined in: js-api/src/widgets/tree.ts:111

Check box element

Returns

HTMLElement | null

Inherited from

TreeViewNode.checkBox

---

checked

Get Signature

get checked(): boolean

Defined in: js-api/src/widgets/tree.ts:114

Returns true if checked

Returns

boolean

Set Signature

set checked(checked): void

Defined in: js-api/src/widgets/tree.ts:115

Parameters

Parameter	Type
checked	boolean

Returns

void

Inherited from

TreeViewNode.checked

---

children

Get Signature

get children(): TreeViewNode<any>[]

Defined in: js-api/src/widgets/tree.ts:199

Gets the node's children

Returns

TreeViewNode<any>[]

---

currentItem

Get Signature

get currentItem(): TreeViewNode

Defined in: js-api/src/widgets/tree.ts:229

Currently selected node.

Returns

TreeViewNode

Set Signature

set currentItem(node): void

Defined in: js-api/src/widgets/tree.ts:230

Parameters

Parameter	Type
node	TreeViewNode

Returns

void

---

expanded

Get Signature

get expanded(): boolean

Defined in: js-api/src/widgets/tree.ts:221

Controls expanded state.

Returns

boolean

Set Signature

set expanded(isExpanded): void

Defined in: js-api/src/widgets/tree.ts:222

Parameters

Parameter	Type
isExpanded	boolean

Returns

void

---

icon

Get Signature

get icon(): Element

Defined in: js-api/src/widgets/tree.ts:122

Node icon

Returns

Element

Set Signature

set icon(value): void

Defined in: js-api/src/widgets/tree.ts:123

Parameters

Parameter	Type
value	Element

Returns

void

Inherited from

TreeViewNode.icon

---

items

Get Signature

get items(): TreeViewNode<any>[]

Defined in: js-api/src/widgets/tree.ts:194

Gets all node items

Returns

TreeViewNode<any>[]

---

onChildNodeExpandedChanged

Get Signature

get onChildNodeExpandedChanged(): Observable<TreeViewGroup>

Defined in: js-api/src/widgets/tree.ts:262

Fires when a child group is expanded or collapsed.

Returns

Observable<TreeViewGroup>

---

onChildNodeExpanding

Get Signature

get onChildNodeExpanding(): Observable<TreeViewGroup>

Defined in: js-api/src/widgets/tree.ts:264

Fires before a child group expands.

Returns

Observable<TreeViewGroup>

---

onNodeAdded

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:258

Fires after a node is added anywhere under this group.

Returns

Observable<TreeViewNode<any>>

---

onNodeCheckBoxToggled

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:260

Fires when a check box under this group is toggled; emits the node.

Returns

Observable<TreeViewNode<any>>

---

onNodeContextMenu

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:267

Fires when a node under this group is right-clicked.

Returns

Observable<TreeViewNode<any>>

---

onNodeEnter

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:275

Fires when Enter is pressed on the selected node.

Returns

Observable<TreeViewNode<any>>

---

onNodeExpanding

Get Signature

get onNodeExpanding(): Observable<TreeViewGroup>

Defined in: js-api/src/widgets/tree.ts:256

Fires before this group expands — the place to load children lazily.

Returns

Observable<TreeViewGroup>

---

onNodeMouseEnter

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:271

Fires when the mouse enters a node.

Returns

Observable<TreeViewNode<any>>

---

onNodeMouseLeave

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:273

Fires when the mouse leaves a node.

Returns

Observable<TreeViewNode<any>>

---

onSelected

Get Signature

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

Defined in: js-api/src/widgets/tree.ts:139

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: js-api/src/widgets/tree.ts:269

Fires when the selected node changes.

Returns

Observable<TreeViewNode<any>>

---

parent

Get Signature

get parent(): TreeViewNode

Defined in: js-api/src/widgets/tree.ts:105

Node's parent

Returns

TreeViewNode

Inherited from

TreeViewNode.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/tree.ts:92

Visual root

Returns

HTMLElement

Inherited from

TreeViewNode.root

---

rootNode

Get Signature

get rootNode(): TreeViewGroup

Defined in: js-api/src/widgets/tree.ts:97

Top-most node.

Returns

TreeViewGroup

Inherited from

TreeViewNode.rootNode

---

tag

Get Signature

get tag(): any

Defined in: js-api/src/widgets/tree.ts:126

Auxiliary information associated with the node.

Returns

any

Set Signature

set tag(t): void

Defined in: js-api/src/widgets/tree.ts:127

Parameters

Parameter	Type
t	any

Returns

void

Inherited from

TreeViewNode.tag

---

text

Get Signature

get text(): string

Defined in: js-api/src/widgets/tree.ts:118

Node text

Returns

string

Set Signature

set text(value): void

Defined in: js-api/src/widgets/tree.ts:119

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

TreeViewNode.text

---

value

Get Signature

get value(): T

Defined in: js-api/src/widgets/tree.ts:130

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: js-api/src/widgets/tree.ts:131

Parameters

Parameter	Type
v	T

Returns

void

Inherited from

TreeViewNode.value

Methods

addItems()

addItems(items): TreeViewNode

Defined in: js-api/src/widgets/tree.ts:248

Adds new items to group

Parameters

Parameter	Type
items	any[]

Returns

TreeViewNode

---

addNode()

addNode(node, index?): void

Defined in: js-api/src/widgets/tree.ts:204

Adds an existing node at the specified index. Use with remove() to reorder nodes.

Parameters

Parameter	Type
node	TreeViewNode
index?	number

Returns

void

---

enableCheckBox()

enableCheckBox(checked?): void

Defined in: js-api/src/widgets/tree.ts:134

Enables checkbox

Parameters

Parameter	Type	Default value
checked	boolean	false

Returns

void

Inherited from

TreeViewNode.enableCheckBox

---

getOrCreateGroup()

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

Defined in: js-api/src/widgets/tree.ts:238

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: js-api/src/widgets/tree.ts:233

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: js-api/src/widgets/tree.ts:243

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: js-api/src/widgets/tree.ts:278

Populates this group from a server data source (one node per entity).

Parameters

Parameter	Type
source	HttpDataSource<any>

Returns

Promise<void>

---

remove()

remove(): void

Defined in: js-api/src/widgets/tree.ts:142

Removes the node and its children from the parent

Returns

void

Inherited from

TreeViewNode.remove

---

removeChildrenWhere()

removeChildrenWhere(predicate): void

Defined in: js-api/src/widgets/tree.ts:209

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: js-api/src/widgets/tree.ts:154

Builds a tree that groups [items] by the values of [props], one level per property, with the items as leaves.

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: js-api/src/widgets/tree.ts:149

Creates new tree

Returns

TreeViewGroup