React TreeView Methods
This section describes members used to manipulate the UI component.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
collapseItem(itemData)
Collapses an item with a specific key.
The key.
Name | Type | Description |
---|---|---|
disabled |
Specifies whether the UI component item responds to user interaction. |
|
expanded |
Specifies whether or not the tree view item is displayed expanded. |
|
hasItems | | undefined |
Specifies whether or not the tree view item has children. |
html |
Specifies the HTML markup to be inserted into the item element. |
|
icon |
Specifies the tree view item's icon. |
|
id | | | undefined |
Holds the unique key of an item. |
items |
Specifies nested tree view items. |
|
parentId | | | undefined |
Holds the key of the parent item. |
selected |
Specifies whether the TreeView item should be displayed as selected. |
|
template | | |
Specifies a template that should be used to render this item only. |
text |
Specifies text displayed for the UI component item. |
|
visible |
Specifies whether or not a UI component item must be displayed. |
A Promise that is resolved after the item is collapsed and rejected if the item is nonexistent or disabled.
It is a native Promise or a jQuery.Promise when you use jQuery.
collapseItem(itemElement)
Collapses an item found using its DOM node.
The item's DOM node.
A Promise that is resolved after the item is collapsed and rejected if the item is nonexistent or disabled.
It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
collapseItem(key)
Collapses an item with a specific key.
The item's key.
A Promise that is resolved after the item is collapsed and rejected if the item is nonexistent or disabled.
It is a native Promise or a jQuery.Promise when you use jQuery.
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the TreeView UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxTreeView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeView properties } });
Angular
import TreeView, { Properties } from "devextreme/ui/tree_view"; // ... export class AppComponent { constructor () { TreeView.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the TreeView properties } }); } }
Vue
<template> <div> <DxTreeView id="treeView1" /> <DxTreeView id="treeView2" /> </div> </template> <script> import DxTreeView from "devextreme-vue/tree-view"; import TreeView from "devextreme/ui/tree_view"; TreeView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeView properties } }); export default { components: { DxTreeView } } </script>
React
import dxTreeView from "devextreme/ui/tree_view"; import TreeView from "devextreme-react/tree-view"; dxTreeView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeView properties } }); export default function App() { return ( <div> <TreeView id="treeView1" /> <TreeView id="treeView2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxTreeView.defaultOptions({ device: deviceConfig, options: { // Here go the TreeView properties } }); });
Angular
import TreeView, { Properties } from "devextreme/ui/tree_view"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { TreeView.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the TreeView properties } }); }); } }
Vue
<template> <div> <DxTreeView /> </div> </template> <script> import DxTreeView from "devextreme-vue/tree-view"; import TreeView from "devextreme/ui/tree_view"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { TreeView.defaultOptions({ device: deviceConfig, options: { // Here go the TreeView properties } }); }); export default { components: { DxTreeView } } </script>
React
import dxTreeView from "devextreme/ui/tree_view"; import TreeView from "devextreme-react/tree-view"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxTreeView.defaultOptions({ device: deviceConfig, options: { // Here go the TreeView properties } }); }); export default function App() { return ( <div> <TreeView /> </div> ) }
dispose()
Disposes of all the resources allocated to the TreeView instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myTreeView").dxTreeView("dispose"); $("#myTreeView").remove();
Angular
Use conditional rendering instead of this method:
<dx-tree-view ... *ngIf="condition"> </dx-tree-view>
Vue
Use conditional rendering instead of this method:
<template> <DxTreeView ... v-if="condition"> </DxTreeView> </template> <script> import DxTreeView from 'devextreme-vue/tree-view'; export default { components: { DxTreeView } } </script>
React
Use conditional rendering instead of this method:
import React from 'react'; import TreeView from 'devextreme-react/tree-view'; function DxTreeView(props) { if (!props.shouldRender) { return null; } return ( <TreeView ... > </TreeView> ); } class App extends React.Component { render() { return ( <DxTreeView shouldRender="condition" /> ); } } export default App;
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
expandAll()
Expands all items. If you load items on demand, this method expands only the loaded items.
expandItem(itemData)
Expands an item found using its data object.
The item's data object.
Name | Type | Description |
---|---|---|
disabled |
Specifies whether the UI component item responds to user interaction. |
|
expanded |
Specifies whether or not the tree view item is displayed expanded. |
|
hasItems | | undefined |
Specifies whether or not the tree view item has children. |
html |
Specifies the HTML markup to be inserted into the item element. |
|
icon |
Specifies the tree view item's icon. |
|
id | | | undefined |
Holds the unique key of an item. |
items |
Specifies nested tree view items. |
|
parentId | | | undefined |
Holds the key of the parent item. |
selected |
Specifies whether the TreeView item should be displayed as selected. |
|
template | | |
Specifies a template that should be used to render this item only. |
text |
Specifies text displayed for the UI component item. |
|
visible |
Specifies whether or not a UI component item must be displayed. |
A Promise that is resolved after the item is expanded and rejected if the item is nonexistent or disabled.
It is a native Promise or a jQuery.Promise when you use jQuery.
expandItem(itemElement)
Expands an item found using its DOM node.
The item's DOM node.
A Promise that is resolved after the item is expanded and rejected if the item is nonexistent or disabled.
It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
expandItem(key)
Expands an item with a specific key.
The item's key.
A Promise that is resolved after the item is expanded and rejected if the item is nonexistent or disabled.
It is a native Promise or a jQuery.Promise when you use jQuery.
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the TreeView instance found in an element with the myTreeView
ID:
// Modular approach import TreeView from "devextreme/ui/tree_view"; ... let element = document.getElementById("myTreeView"); let instance = TreeView.getInstance(element) as TreeView; // Non-modular approach let element = document.getElementById("myTreeView"); let instance = DevExpress.ui.dxTreeView.getInstance(element);
See Also
getNodes()
Gets all nodes.
All nodes. Their structure is described in the Node section.
getScrollable()
Gets the instance of the UI component's scrollable part.
Scrollable
The scrollable part's instance.
For information on API members of the scrollable part, refer to the ScrollView section. The list below shows ScrollView members that are unavailable for this method.
Properties:
- pullingDownText
- pulledDownText
- refreshingText
- reachBottomText
- onPullDown
- onReachBottom
Methods:
- release(preventScrollBottom)
- refresh()
See Also
getSelectedNodeKeys()
Gets the keys of selected nodes.
Array<any>
The keys of selected nodes.
See Also
getSelectedNodes()
Gets selected nodes.
Selected nodes.
jQuery
const selectedNodes = $("#treeViewContainer").dxTreeView("getSelectedNodes");
Angular
import { Component, ViewChild } from '@angular/core'; import { DxTreeViewComponent } from 'devextreme-angular'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('treeViewRef', { static: false }) treeView: DxTreeViewComponent; // Prior to Angular 8 // @ViewChild('treeViewRef') treeView: DxTreeViewComponent; selectedNodes = []; getSelectedNodes() { this.selectedNodes = this.treeView.instance.getSelectedNodes(); } }
<dx-tree-view ... #treeViewRef> </dx-tree-view>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTreeViewModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTreeViewModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxTreeView ... :ref="treeViewRef"> </DxTreeView> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxTreeView from 'devextreme-vue/tree-view'; export default { components: { DxTreeView }, data() { return { treeViewRef, selectedNodes: [] } }, computed: { treeView: function() { return this.$refs[treeViewRef].instance; } }, methods: { getSelectedNodes() { this.selectedNodes = this.treeView.getSelectedNodes(); } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import TreeView from 'devextreme-react/tree-view'; class App extends React.Component { constructor(props) { super(props); this.treeViewRef = React.createRef(); this.selectedNodes = []; this.getSelectedNodes = () => { this.selectedNodes = this.treeView.getSelectedNodes(); } } get treeView() { return this.treeViewRef.current.instance(); } render() { return ( <TreeView ... ref={this.treeViewRef}> </TreeView> ); } } export default App;
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
scrollToItem(itemData)
Scrolls the content to an item found using its data.
The item's data object.
Name | Type | Description |
---|---|---|
disabled |
Specifies whether the UI component item responds to user interaction. |
|
expanded |
Specifies whether or not the tree view item is displayed expanded. |
|
hasItems | | undefined |
Specifies whether or not the tree view item has children. |
html |
Specifies the HTML markup to be inserted into the item element. |
|
icon |
Specifies the tree view item's icon. |
|
id | | | undefined |
Holds the unique key of an item. |
items |
Specifies nested tree view items. |
|
parentId | | | undefined |
Holds the key of the parent item. |
selected |
Specifies whether the TreeView item should be displayed as selected. |
|
template | | |
Specifies a template that should be used to render this item only. |
text |
Specifies text displayed for the UI component item. |
|
visible |
Specifies whether or not a UI component item must be displayed. |
A Promise that is resolved after the content is scrolled to the target item and rejected if the item is nonexsistent or nested in a collapsed and disabled node.
It is a native Promise or a jQuery.Promise when you use jQuery.
scrollToItem(itemElement)
Scrolls the content to an item found using its DOM node.
The item's DOM node.
A Promise that is resolved after the content is scrolled to the target item and rejected if the item is nonexsistent or nested in a collapsed and disabled node.
It is a native Promise or a jQuery.Promise when you use jQuery.
scrollToItem(key)
Scrolls the content to an item found using its key.
The item's key.
A Promise that is resolved after the content is scrolled to the target item and rejected if the item is nonexsistent or nested in a collapsed and disabled node.
It is a native Promise or a jQuery.Promise when you use jQuery.
selectAll()
Selects all nodes.
This method has the following specificities:
Only loaded nodes can be selected. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, only the nodes that satisfy the search condition can be selected.
See Also
selectItem(itemData)
Selects a node found using its data object.
A data object.
Name | Type | Description |
---|---|---|
disabled |
Specifies whether the UI component item responds to user interaction. |
|
expanded |
Specifies whether or not the tree view item is displayed expanded. |
|
hasItems | | undefined |
Specifies whether or not the tree view item has children. |
html |
Specifies the HTML markup to be inserted into the item element. |
|
icon |
Specifies the tree view item's icon. |
|
id | | | undefined |
Holds the unique key of an item. |
items |
Specifies nested tree view items. |
|
parentId | | | undefined |
Holds the key of the parent item. |
selected |
Specifies whether the TreeView item should be displayed as selected. |
|
template | | |
Specifies a template that should be used to render this item only. |
text |
Specifies text displayed for the UI component item. |
|
visible |
Specifies whether or not a UI component item must be displayed. |
false if no node was found.
This method has the following specificities:
Only loaded nodes can be selected. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, only the nodes that satisfy the search condition can be selected.
See Also
selectItem(itemElement)
Selects a TreeView node found using its DOM node.
This method has the following specificities:
Only loaded nodes can be selected. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, only the nodes that satisfy the search condition can be selected.
See Also
selectItem(key)
Selects a node with a specific key.
A key.
false if no node matches the specified key.
This method has the following specificities:
Only loaded nodes can be selected. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, only the nodes that satisfy the search condition can be selected.
See Also
unselectAll()
Cancels the selection of all nodes.
This method has the following specificities:
The selection of only loaded nodes can be canceled. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, this method cancels the selection of only those nodes that satisfy the search condition.
See Also
unselectItem(itemData)
Cancels the selection of a node found using its data object.
A data object.
Name | Type | Description |
---|---|---|
disabled |
Specifies whether the UI component item responds to user interaction. |
|
expanded |
Specifies whether or not the tree view item is displayed expanded. |
|
hasItems | | undefined |
Specifies whether or not the tree view item has children. |
html |
Specifies the HTML markup to be inserted into the item element. |
|
icon |
Specifies the tree view item's icon. |
|
id | | | undefined |
Holds the unique key of an item. |
items |
Specifies nested tree view items. |
|
parentId | | | undefined |
Holds the key of the parent item. |
selected |
Specifies whether the TreeView item should be displayed as selected. |
|
template | | |
Specifies a template that should be used to render this item only. |
text |
Specifies text displayed for the UI component item. |
|
visible |
Specifies whether or not a UI component item must be displayed. |
false if no node was found.
This method has the following specificities:
The selection of only loaded nodes can be canceled. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, this method cancels the selection of only those nodes that satisfy the search condition.
See Also
unselectItem(itemElement)
Cancels the selection of a TreeView node found using its DOM node.
This method has the following specificities:
The selection of only loaded nodes can be canceled. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, this method cancels the selection of only those nodes that satisfy the search condition.
See Also
unselectItem(key)
Cancels the selection of a node with a specific key.
A key.
false if no node matches the specified key.
This method has the following specificities:
The selection of only loaded nodes can be canceled. Take this specificity into account if nodes are loaded on demand (for example, if you use the virtual mode or createChildren function).
If searching is applied, this method cancels the selection of only those nodes that satisfy the search condition.
See Also
updateDimensions()
Updates the tree view scrollbars according to the current size of the UI component content.
A Promise that is resolved if the UI component is updated and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
If you have technical questions, please create a support ticket in the DevExpress Support Center.