TreeViewGroup
Tree view node. Sample: https://public.datagrok.ai/js/samples/ui/tree-view
Extends
Constructors
new TreeViewGroup()
new TreeViewGroup(
dart
):TreeViewGroup
Parameters
Parameter | Type |
---|---|
dart | any |
Returns
Inherited from
Constructs
from the Dart object
Source
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
captionLabel
get
captionLabel():HTMLElement
Caption label
Returns
HTMLElement
Source
checkBox
get
checkBox():null
|HTMLElement
Check box element
Returns
null
| HTMLElement
Source
checked
get
checked():boolean
Returns true
if checked
set
checked(checked
):void
Parameters
Parameter | Type |
---|---|
checked | boolean |
Returns
boolean
Source
children
get
children():TreeViewNode
<any
>[]
Gets the node's children
Returns
TreeViewNode
<any
>[]
Source
currentItem
get
currentItem():TreeViewNode
<any
>
set
currentItem(node
):void
Parameters
Parameter | Type |
---|---|
node | TreeViewNode <any > |
Returns
TreeViewNode
<any
>
Source
expanded
get
expanded():boolean
set
expanded(isExpanded
):void
Parameters
Parameter | Type |
---|---|
isExpanded | boolean |
Returns
boolean
Source
items
get
items():TreeViewNode
<any
>[]
Gets all node items
Returns
TreeViewNode
<any
>[]
Source
onChildNodeExpandedChanged
get
onChildNodeExpandedChanged():Observable
<TreeViewGroup
>
Returns
Observable
<TreeViewGroup
>
Source
onChildNodeExpanding
get
onChildNodeExpanding():Observable
<TreeViewGroup
>
Returns
Observable
<TreeViewGroup
>
Source
onNodeAdded
get
onNodeAdded():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onNodeCheckBoxToggled
get
onNodeCheckBoxToggled():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onNodeContextMenu
get
onNodeContextMenu():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onNodeEnter
get
onNodeEnter():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onNodeExpanding
get
onNodeExpanding():Observable
<TreeViewGroup
>
Returns
Observable
<TreeViewGroup
>
Source
onNodeMouseEnter
get
onNodeMouseEnter():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onNodeMouseLeave
get
onNodeMouseLeave():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onSelected
get
onSelected():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
onSelectedNodeChanged
get
onSelectedNodeChanged():Observable
<TreeViewNode
<any
>>
Returns
Observable
<TreeViewNode
<any
>>
Source
parent
get
parent():TreeViewNode
<any
>
Returns
TreeViewNode
<any
>
Source
root
get
root():HTMLElement
Visual root
Returns
HTMLElement
Source
rootNode
get
rootNode():TreeViewGroup
Returns
Source
tag
get
tag():any
set
tag(t
):void
Parameters
Parameter | Type |
---|---|
t | any |
Returns
any
Source
text
get
text():string
Node text
set
text(value
):void
Parameters
Parameter | Type |
---|---|
value | string |
Returns
string
Source
value
get
value():T
Node value
set
value(v
):void
Parameters
Parameter | Type |
---|---|
v | T |
Returns
T
Source
Methods
enableCheckBox()
enableCheckBox(
checked
):void
Enables checkbox
Parameters
Parameter | Type | Default value |
---|---|---|
checked | boolean | false |
Returns
void
Inherited from
Source
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
Source
group()
group(
text
,value
,expanded
,index
):TreeViewGroup
Adds new group
Parameters
Parameter | Type | Default value |
---|---|---|
text | string | Element | undefined |
value | null | object | null |
expanded | boolean | true |
index | null | number | null |
Returns
Source
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
loadSources()
loadSources(
source
):Promise
<void
>
Parameters
Parameter | Type |
---|---|
source | HttpDataSource <any > |
Returns
Promise
<void
>
Source
remove()
remove():
void
Removes the node and its children from the parent
Returns
void
Inherited from
Source
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
Source
tree()
static
tree():TreeViewGroup
Creates new tree