Skip to main content

TreeViewNode<T>

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

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

Extended by

Type Parameters

Type ParameterDefault type
Tany

Constructors

Constructor

new TreeViewNode<T>(dart): TreeViewNode<T>

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

Parameters

ParameterType
dartany

Returns

TreeViewNode<T>

Properties

PropertyTypeDefined in
dartanyjs-api/src/widgets/tree.ts:84

Accessors

captionLabel

Get Signature

get captionLabel(): HTMLElement

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

Caption label

Returns

HTMLElement


checkBox

Get Signature

get checkBox(): HTMLElement | null

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

Check box element

Returns

HTMLElement | null


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
ParameterType
checkedboolean
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
ParameterType
valueElement
Returns

void


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>>


parent

Get Signature

get parent(): TreeViewNode

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

Node's parent

Returns

TreeViewNode


root

Get Signature

get root(): HTMLElement

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

Visual root

Returns

HTMLElement


rootNode

Get Signature

get rootNode(): TreeViewGroup

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

Top-most node.

Returns

TreeViewGroup


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
ParameterType
tany
Returns

void


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
ParameterType
valuestring
Returns

void


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
ParameterType
vT
Returns

void

Methods

enableCheckBox()

enableCheckBox(checked?): void

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

Enables checkbox

Parameters

ParameterTypeDefault value
checkedbooleanfalse

Returns

void


remove()

remove(): void

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

Removes the node and its children from the parent

Returns

void