JavaScript/jQuery TreeList Methods
This section describes methods that you can use to manipulate the TreeList UI component in code.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
addColumn(columnOptions)
Adds a new column.
The column's configuration or a data field for which the column should be created.
This method is intended to add columns at runtime. To add columns at design-time, use the columns array.
If stateStoring is enabled, the added column is saved in the UI component's state after the creation.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
addRow()
Adds an empty data row to the highest hierarchical level and switches it to the editing state.
Use this method if you want to add an empty row. If you need to add a row with data, do the following:
For a remote data source, insert a new row with data into it and reload the data source:
jQuery
JavaScript$(function(){ var treeList = $("#treeListContainer").dxTreeList({ // ... }).dxTreeList("instance"); var dataSource = treeList.getDataSource(); dataSource.store().insert(data).then(function() { dataSource.reload(); }) });
Angular
app.component.tsapp.module.tsimport { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { constructor() { this.dataSource = new DataSource({ // ... }) } // ... insertRowRemote: function(dataObj) { this.dataSource.store().insert(data).then(function() { this.dataSource.reload(); }) } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTreeListModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTreeListModule ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxTreeList :data-source="dataSource" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxTreeList from 'devextreme-vue/tree-list'; import DataSource from 'devextreme/data/data_source'; const ds = new DataSource({ // ... }); export default { components: { DxTreeList }, data() { return { dataSource: ds } }, methods: { insertRowRemote: function(dataObj) { ds.store().insert(dataObj).then(() => ds.reload()); } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import TreeList from 'devextreme-react/tree-list'; import DataSource from 'devextreme/data/data_source'; const ds = new DataSource({ // ... }); class App extends React.Component { insertRowRemote(dataObj) { ds.store().insert(dataObj).then(() => ds.reload()); } render() { return ( <TreeList dataSource={ds} /> ); } } export default App;
For a local data source, push a new row into it.
jQuery
JavaScript$(function(){ var treeList = $("#treeListContainer").dxTreeList({ // ... }).dxTreeList("instance");
});var dataSource = treeList.getDataSource(); dataSource.store().push([ { type: "insert", data: data } ])
Angular
app.component.tsapp.module.tsimport { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { constructor() { this.dataSource = new DataSource({ // ... }) } // ... insertRowLocal: function(dataObj) { this.dataSource.store().push([ { type: "insert", data: dataObj } ]) } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTreeListModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTreeListModule ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxTreeList :data-source="dataSource" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxTreeList from 'devextreme-vue/tree-list'; import DataSource from 'devextreme/data/data_source'; const ds = new DataSource({ // ... }); export default { components: { DxTreeList }, data() { return { dataSource: ds } }, methods: { insertRowLocal: function(dataObj) { ds.store().push([ { type: "insert", data: dataObj } ]); } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import TreeList from 'devextreme-react/tree-list'; import DataSource from 'devextreme/data/data_source'; const ds = new DataSource({ // ... }); class App extends React.Component { insertRowLocal(dataObj) { ds.store().push([ { type: "insert", data: dataObj } ]); } render() { return ( <TreeList dataSource={ds} /> ); } } export default App;
This method works only when paging.enabled is false or when dataSource.reshapeOnPush is true and remoteOperations is false.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- TreeList - Add a Row
- editing.allowUpdating
addRow(parentId)
Adds an empty data row to a specified parent row.
The parent row's ID.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- TreeList - Add a Row
- editing.allowUpdating
beginCustomLoading(messageText)
Shows the load panel.
The text for the load panel to display.
Normally, the load panel is invoked automatically while the UI component is busy rendering or loading data. Additionally, you can invoke it by calling this method. If you call it without the argument, the load panel displays text specified by the loadPanel.text property. To specify the appearance of the load panel, use the loadPanel object. Once invoked from code, the load panel will not hide until you call the endCustomLoading() method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
byKey(key)
Gets a data object with a specific key.
A Promise that is resolved after the data object is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
The following code shows how to get a data object whose key is 15.
widgetInstance.byKey(15).done(function(dataObject) { // process "dataObject" }).fail(function(error) { // handle error });
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- instance()
cellValue(rowIndex, dataField)
Gets the value of a cell with a specific row index and a data field, column caption or name.
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The data field, caption, or unique name of the column to which the cell belongs.
The cell's value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
cellValue(rowIndex, dataField, value)
Sets a new value to a cell with a specific row index and a data field, column caption or name.
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The data field, caption, or unique name of the column to which the cell belongs.
The cell's new value.
Call saveEditData() after this method to save the changes:
jQuery
var treeList = $("#treeListContainer").dxTreeList("instance"); treeList.cellValue(0, "Position", "CEO"); treeList.saveEditData();
Angular
import { ..., ViewChild } from "@angular/core"; import { DxTreeListModule, DxTreeListComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild(DxTreeListComponent, { static: false }) treeList: DxTreeListComponent; // Prior to Angular 8 // @ViewChild(DxTreeListComponent) treeList: DxTreeListComponent; updateCell(rowIndex, dataField, value) { this.treeList.instance.cellValue(rowIndex, dataField, value); this.treeList.instance.saveEditData(); } } @NgModule({ imports: [ // ... DxTreeListModule ], // ... })
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
cellValue(rowIndex, visibleColumnIndex)
Gets the value of a cell with specific row and column indexes.
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The visible index of the column to which the cell belongs.
The cell's value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
cellValue(rowIndex, visibleColumnIndex, value)
Sets a new value to a cell with specific row and column indexes.
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The visible index of the column to which the cell belongs.
The cell's new value.
Call saveEditData() after this method to save the changes:
jQuery
var treeList = $("#treeListContainer").dxTreeList("instance"); treeList.cellValue(0, 1, "newValue"); treeList.saveEditData();
Angular
import { ..., ViewChild } from "@angular/core"; import { DxTreeListModule, DxTreeListComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild(DxTreeListComponent, { static: false }) treeList: DxTreeListComponent; // Prior to Angular 8 // @ViewChild(DxTreeListComponent) treeList: DxTreeListComponent; updateCell(rowIndex, columnIndex, value) { this.treeList.instance.cellValue(rowIndex, columnIndex, value); this.treeList.instance.saveEditData(); } } @NgModule({ imports: [ // ... DxTreeListModule ], // ... })
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
clearFilter()
Clears all filters applied to UI component rows.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
clearFilter(filterName)
Clears all row filters of a specific type.
The filter type.
The method's parameter specifies what type of filter should be cleared. This parameter can have one of the following values:
- "row"
Clears the filter row. - "header"
Clears the header filter. - "filterValue"
Clears the filter builder and the synchronized filtering UI elements. - "search"
Clears the search panel. - "dataSource"
Clears the data source filter defined in the configuration or applied by the filter(filterExpr) method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- clearFilter()
clearSelection()
Clears selection of all rows on all pages.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- deselectAll()
- deselectRows(keys)
clearSorting()
Clears sorting settings of all columns at once.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
closeEditCell()
Switches the cell being edited back to the normal state. Takes effect only if editing.mode is batch and showEditorAlways is false.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- cancelEditData()
collapseAdaptiveDetailRow()
Collapses the currently expanded adaptive detail row (if there is one).
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- isAdaptiveDetailRowExpanded(key)
- expandAdaptiveDetailRow(key)
- columnHidingEnabled
collapseRow(key)
Collapses a row with a specific key.
The row's key.
A Promise that is resolved after the row is collapsed. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- expandRow(key)
columnCount()
Gets the data column count. Includes visible and hidden columns, excludes command columns.
The data column count.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
columnOption(id)
Gets all properties of a column with a specific identifier.
The column's properties.
This method gets the properties of the first column found by either of the below:
Name
The unique name of the column.Column Index
The index of the column in the columns array.Data Field
The name of the data source field assigned to the column.Caption
The text displayed in the column header.Service String
A string that matches the following format: "optionName:value", where optionName is one of the column properties. For example, the following string corresponds to the command column:"type:buttons"
.
See Also
- columns
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
columnOption(id, optionName)
Gets the value of a single column property.
The column's index, data field, caption, type, or unique name. Refer to columnOption(id) for details.
The property's name.
The property's value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- columns
columnOption(id, optionName, optionValue)
Updates the value of a single column property.
The column's index, data field, caption, type, or unique name. Refer to columnOption(id) for details.
The property's name.
The property's new value.
See Also
- columns
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
columnOption(id, options)
Updates the values of several column properties.
The column's index, data field, caption, type, or unique name. Refer to columnOption(id) for details.
The properties with their new values.
See Also
- columns
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
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 TreeList UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxTreeList.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeList options } });
Angular
import TreeList from "devextreme/ui/tree_list"; // ... export class AppComponent { constructor () { TreeList.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeList options } }); } }
Vue
<template> <div> <DxTreeList id="treeList1" /> <DxTreeList id="treeList2" /> </div> </template> <script> import DxTreeList from "devextreme-vue/tree-list"; import TreeList from "devextreme/ui/tree_list"; TreeList.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeList options } }); export default { components: { DxTreeList } } </script>
React
import React from "react"; import dxTreeList from "devextreme/ui/tree_list"; import TreeList from "devextreme-react/tree-list"; class App extends React.Component { render () { dxTreeList.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TreeList options } }) return ( <div> <TreeList id="treeList1" /> <TreeList id="treeList2" /> </div> ) } } export default App;
deleteColumn(id)
Removes a column.
This method removes the first column found by either of the below:
Name
The unique name of the column.Column Index
The index of the column in the columns array.Data Field
The name of the data source field assigned to the column.Caption
The text displayed in the column header.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- addColumn(columnOptions)
- deleteRow(rowIndex)
deleteRow(rowIndex)
Removes a row with a specific index.
The row's index. Refer to Column and Row Indexes for more information.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- addRow()
- deleteColumn(id)
deselectAll()
Clears the selection of all rows on all pages or the currently rendered page only.
A Promise that is resolved after the selection is cleared. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- clearSelection()
deselectRows(keys)
Cancels the selection of rows with specific keys.
Array<any>
The row keys.
A Promise that is resolved after selection is cleared. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Initial and Runtime Selection
- deselectAll()
dispose()
Disposes of all the resources allocated to the TreeList instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myTreeList").dxTreeList("dispose"); $("#myTreeList").remove();
Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-tree-list ... *ngIf="condition"> </dx-tree-list>
Vue
<template> <DxTreeList ... v-if="condition"> </DxTreeList> </template> <script> import DxTreeList from 'devextreme-vue/tree-list'; export default { components: { DxTreeList } } </script>
React
import React from 'react'; import TreeList from 'devextreme-react/tree-list'; function DxTreeList(props) { if (!props.shouldRender) { return null; } return ( <TreeList ... > </TreeList> ); } class App extends React.Component { render() { return ( <DxTreeList shouldRender="condition" /> ); } } export default App;
See Also
editCell(rowIndex, dataField)
Switches a cell with a specific row index and a data field to the editing state. Takes effect only if the editing mode is "batch" or "cell".
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The name of the data field in the data source.
See Also
- Editing
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
editCell(rowIndex, visibleColumnIndex)
Switches a cell with specific row and column indexes to the editing state. Takes effect only if the editing mode is "batch" or "cell".
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The visible index of the column to which the cell belongs.
See Also
- Editing
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
editRow(rowIndex)
Switches a row with a specific index to the editing state. Takes effect only if the editing mode is "row", "popup" or "form".
The row's index. Refer to Column and Row Indexes for more information.
See Also
- Editing
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endCustomLoading()
Hides the load panel.
Normally, the UI component hides the load panel automatically once data is ready. But if you have invoked the load panel from code using the beginCustomLoading(messageText) method, you must call the endCustomLoading() method to hide it.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
expandAdaptiveDetailRow(key)
Expands an adaptive detail row.
The key of the data row to which the adaptive detail row belongs.
See Also
expandRow(key)
Expands a row with a specific key.
The row's key.
A Promise that is resolved after the row is expanded. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- collapseRow(key)
filter()
Gets a filter expression applied to the UI component's data source using the filter(filterExpr) method and the DataSource's filter property.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getCombinedFilter()
filter(filterExpr)
Applies a filter to the UI component's data source.
Pass an array with the following members to this method:
- The data source field by which data items are filtered.
- The comparison operator. The following operators are available: "=", "<>", ">", ">=", "<", "<=", "startswith", "endswith", "contains", "notcontains".
- The value with which data source field values should be compared.
The filter passed to this method is not reflected in any of the filtering UI elements and is applied before these elements' filters (filterValue, columns[].filterValue, columns[].filterValues, and searchPanel.text). To clear all filters applied in code and the UI, call the clearFilter() method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getCombinedFilter()
focus()
Sets focus on the UI component.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus(element)
Sets focus on a specific cell.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getCellElement(rowIndex, visibleColumnIndex)
forEachNode(callback)
Performs a pre-order tree traversal, executing a function on each visited node. Starts traversing from the top level nodes.
A function to be executed; return false to stop traversing deeper.
forEachNode(nodes, callback)
Performs a pre-order tree traversal, executing a function on each visited node. Starts traversing from the specified nodes.
Nodes from which to start the traversal.
A function to be executed; return false to stop traversing deeper.
getCellElement(rowIndex, dataField)
Gets a cell with a specific row index and a data field, column caption or name.
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The data field, caption, or unique name of the column to which the cell belongs.
The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.
If the specified row or data field does not exist, the method returns undefined.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getCellElement(rowIndex, visibleColumnIndex)
Gets a cell with specific row and column indexes.
The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.
The visible index of the column to which the cell belongs.
The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.
If the specified row or column does not exist, the method returns undefined.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getCombinedFilter()
Gets the total filter that combines all the filters applied.
Use this method to get the total filter. This filter combines filters applied using filtering UI elements and the filter(filterExpr) method. Note that the total filter contains getters. To get the total filter containing data fields, call the getCombinedFilter(returnDataField) method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getCombinedFilter(returnDataField)
Gets the total filter that combines all the filters applied.
Use this method to get the total filter. This filter combines filters applied using filtering UI elements and the filter(filterExpr) method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getCombinedFilter()
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Data Layer - Overview
- Data Layer - DataSource Examples
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 TreeList instance found in an element with the myTreeList
ID:
// Modular approach import TreeList from "devextreme/ui/tree_list"; ... let element = document.getElementById("myTreeList"); let instance = TreeList.getInstance(element) as TreeList; // Non-modular approach let element = document.getElementById("myTreeList"); let instance = DevExpress.ui.dxTreeList.getInstance(element);
See Also
getKeyByRowIndex(rowIndex)
Gets the key of a row with a specific index.
The row's visible index. Refer to Column and Row Indexes for more information.
The row's key; undefined if nothing found.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getRowIndexByKey(key)
getNodeByKey(key)
Gets a node with a specific key.
The Node object; undefined if nothing found.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Node Structure
getRootNode()
Gets the root node.
The root node.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Node Structure
getRowElement(rowIndex)
Gets the container of a row with a specific index.
The row's visible index. Refer to Column and Row Indexes for more information.
Note that if the UI component has fixed columns, the method returns an array of two separate elements: with unfixed and with fixed columns.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getRowIndexByKey(key)
Gets the index of a row with a specific key.
The row's index; -1 if nothing found. Refer to Column and Row Indexes for more information.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getKeyByRowIndex(rowIndex)
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, but bear in mind that several members described there are unavailable. Those are the following.
Properties:
- pullingDownText
- pulledDownText
- refreshingText
- reachBottomText
- onPullDown
- onReachBottom
Methods:
- release(preventScrollBottom)
- refresh()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getSelectedRowKeys()
Gets the keys of the rows selected explicitly via the API or via a click or tap.
Array<any>
Keys of selected rows. The keys are stored in the order the user selects rows.
See Also
- getSelectedRowKeys(mode)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getSelectedRowKeys(leavesOnly)
Use the getSelectedRowKeys(mode) method instead.
Gets the selected rows' keys.
Specifies whether this method returns only leaves' keys.
Array<any>
Keys of selected rows. The keys are stored in the order the user selects rows.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getSelectedRowKeys(mode)
Gets the selected rows' keys.
"all", "excludeRecursive", or "leavesOnly".
Array<any>
Keys of selected rows. The keys are stored in the order the user selects rows.
Below is an example of a TreeList with several selected rows:
The getSelectedRowKeys(mode) method called for this TreeList returns different results depending on the mode argument:
"all"
Returns all the selected rows' keys.getSelectedRowKeys("all") // returns [2, 5, 8, 9, 6, 10, 4]
"excludeRecursive"
Excludes recursively selected rows' keys.getSelectedRowKeys("excludeRecursive") // returns [2, 6, 10, 4]
"leavesOnly"
Returns only leaves' keys.getSelectedRowKeys("leavesOnly") // returns [8, 9, 6, 10, 4]
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getSelectedRowsData(mode)
getSelectedRowsData()
Gets the data objects of the rows selected explicitly via the API or via a click or tap.
Array<any>
The selected rows' data objects.
The objects are not processed by the DataSource and have the same order in which the rows were selected.
jQuery
var treeList = $("#treeListContainer").dxTreeList("instance"); var selectedRowsData = treeList.getSelectedRowsData();
Angular
import { Component, ViewChild } from '@angular/core'; import { DxTreeListComponent } from 'devextreme-angular'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('treeListRef', { static: false }) treeList: DxTreeListComponent; // Prior to Angular 8 // @ViewChild('treeListRef') treeList: DxTreeListComponent; selectedRowsData = []; getSelectedData() { this.selectedRowsData = this.treeList.instance.getSelectedRowsData(); } }
<dx-tree-list ... #treeListRef ></dx-tree-list>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTreeListModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTreeListModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxTreeList ... :ref="treeListRef"> </DxTreeList> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxTreeList from 'devextreme-vue/tree-list'; const treeListRef = 'treeList'; export default { components: { DxTreeList }, data() { return { treeListRef, selectedRowsData: [] } }, computed: { treeList: function() { return this.$refs[treeListRef].instance; } }, methods: { getSelectedData() { this.selectedRowsData = this.treeList.getSelectedRowsData(); } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import TreeList from 'devextreme-react/tree-list'; class App extends React.Component { constructor(props) { super(props); this.treeListRef = React.createRef(); this.selectedRowsData = []; this.getSelectedData = () => { this.selectedRowsData = this.treeList.getSelectedRowsData(); } } get treeList() { return this.treeListRef.current.instance; } render() { return ( <TreeList ... ref={this.treeListRef}> </TreeList> ); } } export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().TreeList() .ID("treeList") @* ... *@ ) <script type="text/javascript"> function getSelectedData() { var treeList = $("#treeList").dxTreeList("instance"); var selectedRowsData = treeList.getSelectedRowsData(); // ... } </script>
See Also
getSelectedRowsData(mode)
Gets the selected rows' data objects.
"all", "excludeRecursive", or "leavesOnly".
Array<any>
The selected rows' data objects.
The objects are not processed by the DataSource and have the same order in which the rows were selected.
Below is an example of a TreeList with several selected rows:
The getSelectedRowsData(mode) method called for this TreeList returns different results depending on the mode argument:
"all"
Returns all the selected rows' data objects.getSelectedRowsData("all") // returns data objects with the following keys: 2, 5, 8, 9, 6, 10, and 4
"excludeRecursive"
Excludes recursively selected rows' data objects.getSelectedRowsData("excludeRecursive") // returns data objects with the following keys: 2, 6, 10, and 4
"leavesOnly"
Returns only leaves' data objects.getSelectedRowsData("leavesOnly") // returns data objects with the following keys: 8, 9, 6, 10, and 4
jQuery
var treeList = $("#treeListContainer").dxTreeList("instance"); var selectedRowsData = treeList.getSelectedRowsData("leavesOnly");
Angular
import { Component, ViewChild } from '@angular/core'; import { DxTreeListComponent } from 'devextreme-angular'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('treeListRef', { static: false }) treeList: DxTreeListComponent; // Prior to Angular 8 // @ViewChild('treeListRef') treeList: DxTreeListComponent; selectedRowsData = []; getSelectedData() { this.selectedRowsData = this.treeList.instance.getSelectedRowsData('leavesOnly'); } }
<dx-tree-list ... #treeListRef ></dx-tree-list>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTreeListModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTreeListModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxTreeList ... :ref="treeListRef"> </DxTreeList> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxTreeList from 'devextreme-vue/tree-list'; const treeListRef = 'treeList'; export default { components: { DxTreeList }, data() { return { treeListRef, selectedRowsData: [] } }, computed: { treeList: function() { return this.$refs[treeListRef].instance; } }, methods: { getSelectedData() { this.selectedRowsData = this.treeList.getSelectedRowsData('leavesOnly'); } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import TreeList from 'devextreme-react/tree-list'; class App extends React.Component { constructor(props) { super(props); this.treeListRef = React.createRef(); this.selectedRowsData = []; this.getSelectedData = () => { this.selectedRowsData = this.treeList.getSelectedRowsData('leavesOnly'); } } get treeList() { return this.treeListRef.current.instance; } render() { return ( <TreeList ... ref={this.treeListRef}> </TreeList> ); } } export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().TreeList() .ID("treeList") @* ... *@ ) <script type="text/javascript"> function getSelectedData() { var treeList = $("#treeList").dxTreeList("instance"); var selectedRowsData = treeList.getSelectedRowsData(); // ... } </script>
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getSelectedRowKeys(mode)
getVisibleColumnIndex(id)
Gets the index of a visible column.
The column's index, data field, caption, type, or unique name. Refer to columnOption(id) for details.
The column's index.
getVisibleColumns()
Gets all visible columns.
Visible columns; may include command columns.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getVisibleColumns(headerLevel)
- columns
getVisibleColumns(headerLevel)
Gets all visible columns at a specific hierarchical level of column headers. Use it to access banded columns.
The column headers' level.
Visible columns; may include command columns.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getVisibleColumns()
- columns
getVisibleRows()
Gets currently rendered rows.
Currently rendered rows.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Row Structure
- getVisibleColumns()
hasEditData()
Checks whether the UI component has unsaved changes.
true if the UI component has unsaved changes; otherwise - false.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- saveEditData()
- cancelEditData()
hideColumnChooser()
Hides the column chooser.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- showColumnChooser()
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
isAdaptiveDetailRowExpanded(key)
Checks whether an adaptive detail row is expanded or collapsed.
The key of the data row to which the adaptive detail row belongs.
true if the adaptive detail row is expanded; false if collapsed.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- expandAdaptiveDetailRow(key)
- collapseAdaptiveDetailRow()
- columnHidingEnabled
isRowExpanded(key)
Checks whether a row is expanded or collapsed.
The row's key.
true if the row is expanded; false if collapsed.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
isRowFocused(key)
Checks whether a row with a specific key is focused.
A row's key.
true if the row is focused; otherwise false.
See Also
- focusedRowEnabled
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
isRowSelected(key)
Checks whether a row with a specific key is selected.
The row's key.
true if the row is selected; otherwise false.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
keyOf(obj)
Gets a data object's key.
The data object.
The data object's key.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
loadDescendants()
Loads all root node descendants (all data items). Takes effect only if data has the plain structure and remoteOperations | filtering is true.
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
loadDescendants(keys)
Loads a specific node's descendants. Takes effect only if data has the plain structure and remoteOperations | filtering is true.
Array<any>
Node keys.
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
loadDescendants(keys, childrenOnly)
Loads all or only direct descendants of specific nodes. Takes effect only if data has the plain structure and remoteOperations | filtering is true.
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
navigateToRow(key)
Navigates to a row with the specified key.
The row's key.
This method performs the following actions:
- Switches the UI component to the data page that contains the specified row.
- Expands groups in which the row is nested.
- Scrolls the UI component to display the row (if the row is outside the viewport).
The following requirements apply when you use this method:
The UI component's keyExpr or the store's key property should be specified.
Rows should be initially sorted by keys. You can sort them on the server or use a column's sortOrder or the DataSource's sort property to sort the rows on the client.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Focused Row
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all UI component properties.
The UI component's properties.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single property.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several properties.
Propertieswith their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
pageCount()
Gets the total page count.
The total page count.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Paging - API
pageIndex()
Gets the current page index.
The current page index.
When the scrolling mode is "virtual", this method returns the index of the page whose row is shown first in the UI component.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Paging - API
pageIndex(newIndex)
Switches the UI component to a specific page using a zero-based index.
The zero-based page index.
A Promise that is resolved after the page is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
pageSize()
Gets the current page size.
The current page size.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
pageSize(value)
Sets the page size.
The page size.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Paging - API
refresh()
Reloads data and repaints the UI component.
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
The UI component cannot track changes a third party makes in the data source. To update data in the UI component in this case, call the refresh() method. Data sources of lookup columns are updated with the main data source.
The following code shows how to call this method:
jQuery
var treeList = $("#treeListContainer").dxTreeList("instance"); treeList.refresh() .done(function() { // ... }) .fail(function(error) { // ... });
Angular
<dx-tree-list #treeListVar ... > <!-- ... --> </dx-tree-list>
import { Component, ViewChild } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('treeListVar', { static: false }) treeList: DxTreeListComponent; // Prior to Angular 8 // @ViewChild('treeListVar') treeList: DxTreeListComponent; refreshTreeList() { this.treeList.instance.refresh() .then(function() { // ... }) .catch(function(error) { // ... }); } }
Vue
<template> <DxTreeList ... :ref="treeListRefKey"> <!-- ... --> </DxTreeList> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import { DxTreeList, /* ... */ } from 'devextreme-vue/tree-list'; export default { components: { DxTreeList, // ... }, data() { return { treeListRefKey: 'treeList' }; }, computed: { treeList: function() { return this.$refs[treeListRefKey].instance; } }, methods: { refreshTreeList() { this.treeList.refresh() .then(function() { // ... }) .catch(function(error) { // ... }); } } }; </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import { TreeList, /* ... */ } from 'devextreme-react/tree-list'; class App extends React.Component { render() { return ( <TreeList ... ref={ref => this.treeList = ref}> {/* ... */} </TreeList> ); } refreshTreeList() { this.treeList.instance.refresh() .then(function() { // ... }) .catch(function(error) { // ... }); } } export default App;
ASP.NET MVC Controls
@(Html.DevExtreme().TreeList() .ID("treeListContainer") // ... ) <script type="text/javascript"> function refreshTreeList() { var treeList = $("#treeListContainer").dxTreeList("instance"); treeList.refresh() .done(function() { // ... }) .fail(function(error) { // ... }); } </script>
See Also
- refresh(changesOnly)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
refresh(changesOnly)
Reloads data and repaints the UI component or elements whose data changed.
Pass true to repaint elements whose data changed; false to repaint the entire UI component.
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
Main article: refresh()
repaint()
Repaints the UI component without reloading data. Call it to update the UI component's markup.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaintRows(rowIndexes)
Repaints specific rows.
Row indexes. Refer to Column and Row Indexes for more information.
This method updates the row objects and their visual representation.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
Resets an property to its default value.
An property's name.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
saveEditData()
Saves changes that a user made to data.
A Promise that is resolved after changes are saved in the data source. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- cancelEditData()
- hasEditData()
- onRowInserted
- onRowUpdated
- onRowRemoved
searchByText(text)
Seeks a search string in the columns whose allowSearch property is true.
A search string. Pass an empty string to clear search results.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- getCombinedFilter()
- searchPanel
selectAll()
Selects all rows.
A Promise that is resolved after all rows are selected. It is a native Promise or a jQuery.Promise when you use jQuery.
If a filter is applied, this method selects only those rows that meet the filtering conditions.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- selectRows(keys, preserve)
- selection
selectRows(keys, preserve)
Selects rows with specific keys.
A Promise that is resolved after the rows are selected. It is a native Promise or a jQuery.Promise when you use jQuery.
By default, this method call clears selection of previously selected rows. To keep these rows selected, call this method with true as the second argument.
widgetInstance.selectRows([5, 10, 12], true);
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Initial and Runtime Selection
- selectRowsByIndexes(indexes)
selectRowsByIndexes(indexes)
Selects rows with specific indexes.
A Promise that is resolved after the rows are selected. It is a native Promise or a jQuery.Promise when you use jQuery.
This method has the following specifics:
- A call of this method clears selection of all previously selected rows.
- When calculating row indexes, the UI component ignores the hierarchy of rows.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
showColumnChooser()
Shows the column chooser.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- hideColumnChooser
state()
Gets the current UI component state.
The current UI component state.
The following example shows how to save the UI component state in the local storage and load it from there:
jQuery
$(function () { var treeList = $("#treeListContainer").dxTreeList({ // ... }).dxTreeList; $("#save").dxButton({ text: "Save State", onClick: function() { var state = treeList.state(); // Saves the state in the local storage localStorage.setItem("treeListState", JSON.stringify(state)); } }); $("#load").dxButton({ text: "Load State", onClick: function() { let state = JSON.parse(localStorage.getItem("treeListState")); treeList.state(state); } }); });
Angular
import { Component, ViewChild } from "@angular/core"; import { DxTreeListModule, DxButtonModule, DxTreeListComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild(DxTreeListComponent, { static: false }) treeList: DxTreeListComponent // Prior to Angular 8 // @ViewChild(DxTreeListComponent) treeList: DxTreeListComponent saveState() { let state = this.treeList.instance.state(); // Saves the state in the local storage localStorage.setItem("treeListState", JSON.stringify(state)); } loadState() { let state = JSON.parse(localStorage.getItem("treeListState")); this.treeList.instance.state(state); } } @NgModule({ imports: [ DxTreeListModule, DxButtonModule, // ... ], // ... })
<dx-tree-list ...> </dx-tree-list> <dx-button text="Save State" (onClick)="saveState()"> </dx-button> <dx-button text="Load State" (onClick)="loadState()"> </dx-button>
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- stateStoring
state(state)
Sets the UI component state.
The UI component's state to be set. Pass null to reset the state to default.
After the state is set, the TreeList reloads data to apply sorting, filtering, and other data processing settings.
Refer to the state() method description for an example of how to work with the UI component state.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- stateStoring
undeleteRow(rowIndex)
Recovers a row deleted in batch editing mode.
The row's index. Refer to Column and Row Indexes for more information.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- closeEditCell()
- cancelEditData()
updateDimensions()
Updates the UI component's content after resizing.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.