Work with TreeGrid

Working with columns and cells

The API of dhtmlxTreeGrid allows setting configuration of columns, getting an object of a particular column as well as the parameters of a certain cell.

Setting columns configuration

You can specify the configuration of TreeGrid columns on the fly via the setColumns() method. It takes an array with columns objects as a parameter.

treegrid.setColumns([
    { id: "a", header: [{ text: "New header for column a" }] },
    { id: "b", header: [{ text: "New header for column b" }] },
    // more columns objects
]);

You can find the full list of the available configuration options of a TreeGrid column here.

Getting configuration of a column

It is possible to return an object with attributes of a column via its id. Use the getColumn() method for this purpose.

var column = treegrid.getColumn("b"); // ->
// {width: 100, id: "b", header: Array(1), $cellCss: {…}, type: "string"

The method returns an object with configuration of the specified column. Such an object contains a set of fields:

Getting configuration of a cell

There is the getCellRect() method that returns an object with coordinates of a cell. The method takes as parameters the ids of the row and the column the cell belongs to:

var rect = treegrid.getCellRect("1","c");
// -> {x: 200, y: -40, height: 40, width: 200}

The return object includes the following attributes:

Getting header filter

You may want to manipulate a filter specified in the header of a treegrid, for example, to set/unset the focus on the filter, to change the filter, or clear it. For that, you should get an object of the header filter by column id via the getHeaderFilter method:

var countryFilter = treegrid.getHeaderFilter("capital");
// -> return HTMLElement
// <label class="dhx_grid-filter__label dxi dxi-magnify">...</label>
 
countryFilter.focus();
 
// or
 
var countryFilter = treegrid.getHeaderFilter("name");
// -> return Combobox
// Combobox {_uid: "u1597322507580", config: {…}, events: EventSystem, 
// data: DataCollection, popup: Popup, …}
 
countryFilter.blur();

Related sample:  Get header filter - DHTMLX TreeGrid

The method returns either an HTML object or an object with Combobox configuration.

Hiding/showing a column

It is possible to show and hide a column in the grid via the showColumn() and hideColumn() methods.

//showing a column
treegrid.showColumn(col);
//hiding a column
treegrid.hideColumn(col);

Related sample:  TreeGrid. Show/Hide column

Since the object of a column has the hidden property, the showColumn() method changes it value to false while the hideColumn() method changes the hidden property to true.

Checking visibility of a column

You can check whether a column is hidden or shown on a page using the isColumnHidden method. The method returns true, if a column is visible, and false if it's hidden.

treegrid.isColumnHidden("country"); // -> true|false

Related sample:  TreeGrid. Is column hidden

Hiding/showing a row

Starting from v7.0, it is possible to show and hide a row in the treegrid via the showRow() and hideRow() methods.

//showing a row
treegrid.showRow(rowId);
//hiding a row
treegrid.hideRow(rowId);

Related sample:  Show/Hide row - DHTMLX TreeGrid

Checking visibility of a row

You can check whether a row is hidden or shown on a page using the isRowHidden method. The method returns true, if a row is hidden, and false if it's visible.

treegrid.isRowHidden("1"); // -> true|false

Related sample:  Show/Hide row - DHTMLX TreeGrid

Adding/removing spans

You can manipulate columns and rows spans inside the grid with the help of corresponding API methods: addSpan(), removeSpan() and getSpan().

Adding spans

In order to add a col/row span into the grid, use the addSpan() method. Pass an object with configuration of a span as a parameter:

treegrid.addSpan({ 
    row: "0", 
    column: "a", 
    rowspan: 5 
});

These are possible fields of a span object:

Getting spans

You can return the col/row span a cell is a part of using the getSpan() method. It takes the ids of the row and the column the cell belongs to as parameters:

var span = treegrid.getSpan("10","a"); 
// -> {row:"10", column:"a", colspan:4, text:"Some header", css:"myCustomColspan"}

As a result, you'll get an object with a span configuration, if any span includes the specified cell. Attributes of a span object are described above.

Removing spans

To remove an existing span, make use of the removeSpan() method. It takes the ids of the row and the column as parameters:

treegrid.removeSpan("10","a");

Controlling scroll behavior

The API of dhtmlxTreeGrid provides the possibility to set scrolls to the nevessary position and to get the current state of scrolls.

Scrolling to specific coordinates

You can scroll grid content to exact position defined by x and y coordinates via the scroll() method. Pass the coordinates as parameters of the method.

treegrid.scroll(75,230);

Scrolling to specific treegrid cell

It is also possible to scroll treegrid content to a particular cell. Pass the ids of the row and the column as parameters:

treegrid.scrollTo("15","c");

Related sample:  TreeGrid. Controlling Scroll Behavior

Getting the state of scroll

To return the current state of scroll, use the getScrollState() method.

var state = treegrid.getScrollState(); // -> {x:0,y:0}

It returns an object with x,y coordinates of a position the grid has been scrolled to.

Grouping data

To make data in TreeGrid well-structured and easily understood you can group data with the help of the groupBy() method. There are two options of grouping data.

Grouping by a column

To group the content of a treegrid by values of the specified column, pass the id of the column as a parameter to the groupBy() method:

  • id - (string) the id of a column
treegrid.groupBy("age");

Related sample:  Group data items by a property - DHTMLX TreeGrid

Grouping by the result of calculation

You can pass a function with a rule of grouping data in the treegrid as a parameter to the groupBy() method. The function returns the name of a group and takes one parameter:

  • item - a data item
treegrid.groupBy(function (item) {
    if (!item.area || item.area < 0) {
        return "N.A.";
    }
    if (item.area < 25000) {
        return "Small";
    } else if (item.area < 60000) {
        return "Medium";
    }
    return "Big";
});

Related sample:  Group data items by a property - DHTMLX TreeGrid

If necessary, you can set a template to the title of the group via the groupTitleTemplate configuration option.

Filtering data

You can filter grid data by the specified criteria with the help of the filter() method of data collection. The method takes as a parameter an object with the properties described below:


// filtering by the specified rule
tree.data.filter(function (item) {
    return item.value.toLowerCase().indexOf("a") !== -1;
});
 
// filtering the "b" column by value "Tyro"
treegrid.data.filter({ by:"b", match:"Tyro" });
 
// filtering data by several criteria at once
treegrid.data.filter({
    by:"b",
    compare:function(val,match,item){
        if(item.a!=="Some"){
            return val === "New"
        }
        return false;
    }
});

Related sample:  TreeGrid. Basic Filter

Related sample:  TreeGrid. External filter

Sorting data

It is possible to sort data in the grid via the sort() method of data collection. The method takes an object with the following attributes:


treeGrid.data.sort({
    by: "price",
    dir: "asc",
    as: function (value) { return value ? value : "" }
});

Related sample:  TreeGrid. Sorting data

To discard all applied sorting rules, call the method without parameters:

treegrid.data.sort();

Custom sorting

You can also specify the rule attribute in a passed object instead of the default ones and set a custom function for sorting. For example:

treegrid.data.sort({
    rule: (a, b) => a.id > b.id ? 1 : (a.id < b.id ? -1 : 0) 
});

Getting the sorting state

To get the current state of sorting data in TreeGrid, use the getSortingState method. The method returns an object with two attributes:


var state = treegrid.getSortingState(); 
// -> {dir: "desc", by: "country"}

Related sample:  TreeGrid. Get sorting state

Editing data

You can easily edit the desired cell of a treegrid with the help of the editCell() method. It takes two parameters:

For example, you can edit the first cell of the "project" column like this:

treegrid.editCell(grid.data.getId(0),"project");

Related sample:  TreeGrid. Editing data

To finish editing of a cell, use the editEnd() method. The method takes a boolean value as a parameter to define whether the edited data will be saved after the editing of a cell is complete (if true, the made changes won't be saved).

treegrid.editEnd(); // the edited data will be saved
 
treegrid.editEnd(true); // the edited data won't be saved

The editEnd() method does not work if the type of the column editor is defined as checkbox.

Expanding/collapsing nodes

Expand/collapse a certain node

To expand a particular node in a treegrid by its id, use the expand method:

treegrid.expand("native");

To collapse a treegrid node, make use of the collapse method:

treegrid.collapse("native");

Related sample:  TreeGrid. Expand/Collapse nodes

Expand/collapse all nodes

It is also possible to expand/collapse all TreeGrid nodes using the two corresponding methods - expandAll and collapseAll:

// expand all treegrid nodes
treegrid.expandAll();
// collapse all treegrid nodes
treegrid.collapseAll();

Related sample:  TreeGrid. Expand/Collapse nodes

Exporting TreeGrid

You can easily export data of TreeGrid into the Excel or CSV format.

Exporting data to Excel

dhtmlxTreeGrid provides the possibility to export data from TreeGrid into an Excel file by calling the export() method of the export module. The method takes an object with export settings as a parameter.

treegrid.export.xls({
    url: "//export.dhtmlx.com/excel"
});

Related sample:  TreeGrid. Export

Export settings include:

Exporting data to CSV

You can export data from TreeGrid to the CSV format with the csv() method of the Export module. The method takes an object with export settings as a parameter:


treegrid.export.csv({
    name:"treegrid_data", // data will be exported to a CSV file named "treegrid_data"
    rowDelimiter: "\t", // the tab delimiter will be used to separate rows
    columnDelimiter: ";" // the semicolon delimiter will be used to separate columns
});

Related sample:  TreeGrid. Export

The csv() method returns a CSV string with TreeGrid data.

Repainting TreeGrid

In case you've changed some configuration settings of a treegrid, you can repaint it on a page via the paint() method:

treegrid.paint();

Destructing TreeGrid

When it's necessary to release resources occupied by TreeGrid during its activity, you can make use of the destructor() method:

treegrid.destructor();

Using Selection API

For information on using Selection API, read Work with Selection Object.

Back to top