Configuration

dhtmlxTreeGrid possesses flexible configuration that let you get desired look and feel via a collection of versatile properties.

Columns

It is possible to adjust the configuration of grid columns via the corresponding option columns. As a value it takes an array with objects each of which contains config of a column. The full list of properties you can set for a column is given in the API reference.

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { width: 100, id: "a", header: [{ text: "#" }] },
        { width: 100, id: "b", header: [{ text: "Title" }] },
        { width: 200, id: "c", header: [{ text: "Name" }] },
        { width: 200, id: "d", header: [{ text: "Address" }] }
    ],
    data: dataset
});

Related sample:  TreeGrid. Basic initialization

Each column object may contain a set of properties described below:

  • id - (string|number) the id of a column
  • width - (number) the width of a column
  • header - (array) an array of objects with header rows configuration. Each header object may include:
    • text - (string|number) the text of a header
    • align - (string) aligns data in the header: "left"|"center"|"right"
    • colspan - (number) the number of columns in a colspan
    • rowspan - (number) the number of rows in a rowspan
      Related sample:  TreeGrid. Header spans
    • css - (any) styling to be applied to a header
    • content - (string) additional content of a header, which can be:
      • a filter: "inputFilter" | "selectFilter" | "comboFilter"
      • one of the methods that process values in a column and show result in the header:
        "avg" | "sum" | "max" | "min"
      • some other string
    • filterConfig - (object) optional, a configuration object for "comboFilter". It can contain a set of properties:
      • filter - (function) sets a custom function for filtering Combo Box options
      • readonly - (boolean) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input)
      • template - (function) sets a template of displaying options in the popup list
      • placeholder - (string) sets a placeholder in the input of ComboBox
      • virtual - (boolean) enables dynamic loading of data on scrolling the list of options
  • htmlEnable - (boolean) if set to true, specifies the HTML content (inner HTML) of a column. If set to false, the content of the column cells will be displayed as a string value
    Related sample:  TreeGrid. Html In Data
  • footer - (array) an array of objects with footer rows configuration. Each footer object may include:
    • text - (string|number) the text of a header
    • colspan - (number) the number of columns in a colspan
    • rowspan - (number) the number of rows in a rowspan
    • css - (any) styling to be applied to a header
    • content - (string) additional content of a header, which can be:
      • a filter: "inputFilter" | "selectFilter" | "comboFilter"
      • one of the methods that process values in a column and show result in the footer:
        "avg" | "sum" | "max" | "min"
      • some other string
  • maxWidth - (number) the maximal width to be set for a column
    Related sample:  TreeGrid. Max Width
  • minWidth - (number) the minimal width to be set for a column
    Related sample:  TreeGrid. Min Width
  • mark - (object|function) returns a template for marking a cell(s)
    • as an object contains min and max properties, to apply desired CSS classes to cells with minimal|maximal values in a column
    • as a function takes several parameters:
      • cell - (string) the value of a cell
      • columnCells - (array) an array of all cell values in the specified column
      • row - (object) an object with all cells in a row
      • col - (object) the config of a column (see the columns config)
  • resizable - (boolean) defines whether a column can be resized
  • type - (string) the type of a column: "string"|"number"|"boolean"|"any"|"date"
  • dateFormat - (string) defines the format of dates (type:"date")
  • editorType - (string) the type of an editor used in a column: "input"|"select"|"datePicker"|"checkbox"|"combobox"
  • options - (array) a set of options to be displayed in the editor of a cell (editorType: "select"|"combobox")
  • template - (function) returns a template with content for a cell(s). Takes 3 parameters:
    • cellValue - (any) the value of a cell
    • row - (object) an object with all cells in a row
    • col - (object) the config of a column (see the columns config)
  • hidden - (boolean) defines whether a column is hidden
  • draggable - (boolean) defines whether a column is draggable
  • editable - (boolean) defines whether a column is editable
  • sortable - (boolean) defines whether a column is sortable
  • adjust - (boolean|string) defines whether the width of a column is automatically adjusted to its content
  • autoWidth - (boolean) enables/disables the ability of a column to adjust its size to the size of TreeGrid
  • align - (string) aligns data in a column: "left" | "center" | "right"
  • tooltip - (boolean) enables a tooltip on hovering over the content of a column, true by default

Alignment

Starting from v6.5, there is the ability to align data in a column as well as to align data in the column's header via the align option:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { id: "name", header:  [{ title: "Name", align: "center" }], align: "right"}         // more options
    ],
    data: dataset
});

Related sample:  Content align - DHTMLX TreeGrid

The available values of the option are "left", "center" and "right".

Autosize for columns

You can configure columns' settings so that their width would automatically adjust to their content. Use the adjust property for this purpose. The property can take one of three values:

  • "header" - adjusts the columns to the width of their header
  • "footer" - adjusts the columns to the width of their footer
  • "data" - adjusts the columns to the width of their content
  • true - combines the above mentioned modes and adjusts the column to the bigger value
var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    adjust: "header",     data: dataset
});

Related sample:  TreeGrid. Adjust Columns

It is also possible to set the adjust property to true in the configuration of a separate column to make its width adjust automatically to the content:

var treegrid = new dhx.TreeGrid("treegrid_container", { 
    columns: [
        { id: "country", header: [{ text: "Country" }], adjust: "header" },         { id: "population", header: [{ text: "Population" }] }
    ],
    adjust: false,     data: dataset
});

Autowidth for columns

It is possible to adjust the size of TreeGrid columns to the size of TreeGrid with the help of the autoWidth configuration option, like this:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    autoWidth: true,     data: dataset
});

Related sample:  TreeGrid. Auto Width

You can disable this functionality for a specified column via setting the autoWidth property to false in the configuration of the column:

var treegrid = new dhx.TreeGrid("grid", {
    columns: [
        { width: 200, id: "country", header: [{ text: "Country" }], autoWidth: false },         { width: 150, id: "population", header: [{ text: "Population" }] },
    ],
    autoWidth: true,     data: dataset
});

Data

You can specify data for your grid before initialization via the data configuration property. There are also API methods for loading data into grid on the fly. Check the details in the article Data Loading.

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    data: dataset });

Related sample:  TreeGrid. Basic initialization

Drag-n-drop of Grid columns

Starting from v6.5, you can add the ability to reorder columns of TreeGrid by drag and drop via using the dragItem configuration property and setting its value to "column".

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    dragItem:"column",        data: dataset
});

You can disable this functionality for a separate column via the draggable configuration option of the column:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { width: 200, id: "name", header: [{ text: "Name" }], draggable: false },         { width: 260, id: "native", type: "string", header: [{ text: "Native name" }] },
        { width: 200, id: "currency", type: "string", header: [{ text: "Currency" }] } 
    ],
    data: dataset,
    dragItem: "column",    });

Related sample:  Setup drag column

To make the process of reordering columns by drag and drop more flexible, apply the related beforeColumnDrag and beforeColumnDrop events.

Drag-n-drop of Grid rows

dhtmlxTreeGrid supports drag-n-drop of rows between grids in several modes. To begin with, you should specify the dragMode property in the configuration object of TreeGrid. Then define which mode you need:

  • "target" - a grid takes rows from other grids, while its row can't be dragged out of it
  • "source" - a grid allows dragging its rows out and can't take rows from other grids
  • "both" - a grid both takes rows from other grids and allows dragging its rows out as well
var treegrid = new dhx.TreeGrid("treegrid_container", { 
    columns: [
        { id: "country", header: [{ text: "Country" }] },
        { id: "population", header: [{ text: "Population" }] }
    ],
    data: dataset,
    dragMode: "source" });

Related sample:  TreeGrid. Setup Drag Mode

Editing Grid and separate columns

dhtmlxGrid provides the editing feature that includes two options:

  • editing of the whole Grid, i.e. of all its columns

To make all columns of the Grid editable, specify the editable option in the configuration of Grid:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    data: data,
    editable: true });

Related sample:  TreeGrid. Editable Data

  • editing of the specified columns only

This option implies that you can enable/disable editing of particular columns by setting the editable: true property in the configuration of a column:

In the example below all columns will be editable, except for the first one:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { 
            width:150,id:"project",
            editable:false,             header: [
              {text:"Project"}, {content:"selectFilter"}
            ]
        },
        { width:150, id:"owner", header: [{text:"Owner"},{content:"inputFilter"}]},
        { width:150, id:"hours", header: [{text:"Hours"}, {content:"inputFilter"}]},
        // more columns
    ],
    data: data,
    editable: true
});

And the following example demonstrates an opposite situation when only the first column is editable:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { 
           width:150,id:"project",
           editable:true,            header: [
            {text:"Project"}, {content:"selectFilter"}
           ]
        },
        { width:150, id:"owner", header: [{text:"Owner"},{content:"inputFilter"}]},
        { width:150, id: "hours", header: [{text:"Hours"}, {content:"inputFilter"}]},
        // more columns
    ],
    data: data
});

Setting type of column editor

You can specify the way of editing the cells of a Grid column depending on its content as simple inputs, select controls or date pickers. The type of the used editor is defined by the editorType property of a column. There are three types of column editors:

  • input - an editor for cells with a simple text (the default one, unless a column has type:"date")
// cells of the "project" column will be edited as inputs
var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        {
            width: 150,
            id: "project",
            header: [{ text: "Project" }, { content: "selectFilter" }]
        }
    // more columns
    ],
    data: data,
    editable: true
});
  • datePicker - an editor for cells with dates (default for a column with type:"date")

To use this editor, you should specify the type:"date" property for a column. It is also possible to set the necessary format of date while editing a cell content with the help of the dateFormat option.

{ 
    // if the type:"date" config is set in the column config, 
    // there's no need to specify the type of the editor
    width: 150, id: "start_date", 
    header: [{ text: "Calendar", colspan: 2 }, { text: "Start date" }], 
    type: "date", dateFormat: "%d/%m/%Y"  }
  • select - an editor for cells that should contain several options to choose from

To set this editor type you need to provide the options property with an array of options to be displayed in the editor, e.g.:

{
    width: 150, id: "status", header: [{text: "Status"}, {content: "selectFilter"}],
    editorType: "select", options: ["Done", "In Progress", "Not Started"] }

Related sample:  TreeGrid. Editable Data

  • checkbox - an editor for cells with a two-state check box

To use this editor, you need to specify the type: "boolean" property for a column.

{ 
    // if the type:"boolean" config is set in the column config, 
    // there's no need to specify the type of the editor
    width: 160, id: "test", 
    header: [{ text: "Test" }], 
    type: "boolean" }

Related sample:  TreeGrid. Editable Data

If you specify the editable option in the configuration of Grid, then editing of a column with checkbox will always be enabled.

  • combobox - an editor for cells that should contain several options to choose from. There is a possibility to find an option by entering text in the edit control

To use this editor you need to specify the editorType: "combobox" property for a column and provide the options property with an array of options to be displayed in the editor, e.g.:

{
    width: 160, id: "test", header: [{ text: "Test" }], type: "string", 
    editorType: "combobox", options: ["1 time", "1-2 times", "more than 5 times"]  }

Related sample:  TreeGrid. Editable Data

Frozen columns

You can fix (or "freeze") a column or several columns, so that they will become static, while the rest of columns remain scrollable. There is the splitAt property that splits grid columns into the frozen and movable parts. Just set the number of columns (from the left side of the grid) you want to freeze as a value of the property in the Grid configuration.

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    splitAt:1,       data: dataset
});

Related sample:  TreeGrid. Frozen Columns

Header/footer content

There are three types of filters that you can specify in the header/footer content of a Grid column:

  • inputFilter - provides a way of filtering data of a Grid column by using a text field
{ 
    width: 160, id: "budget", 
    header: [{ text: "Budget" }, { content: "inputFilter" }] }
  • selectFilter - allows end users to filter data of a column by choosing an option from a presented dropdown list
{ 
    width: 160, id: "status", 
    header: [{ text: "Status" }, { content: "selectFilter" }],     editorType: "select", 
    options: ["Done", "In Progress", "Not Started"] 
}
  • comboFilter - provides a way to filter data of a column by choosing an option from a presented dropdown list. To find an option quickly you can enter text into the edit control.
{
    width: 160, id: "renewals", 
    header: [{ text: "Number of renewals" }, { content: "comboFilter" }],     type: "string", editorType: "combobox", 
    options: ["1 time", "1-2 times", "more than 5 times"] 
}

If you specify comboFilter as the header or footer content of a column, you can set an additional config with properties for it.

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        {
            width: 150, 
            id: "migrants", 
            header: [
                { text: "Migrants (net)" }, 
                { content: "comboFilter", filterConfig: {readonly: true }}             ] 
        }   
    ],
    data: dataset
}

The list of configuration properties for comboFilter

  • filter - (function) sets a custom function for filtering Combo Box options
  • readonly - (boolean) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input)
  • template - (function) sets a template of displaying options in the popup list
  • placeholder - (string) sets a placeholder in the input of ComboBox
  • virtual - (boolean) enables dynamic loading of data on scrolling the list of options

Header/footer height

The height of the header/footer of Grid is calculated as a sum of rows which are included into it. To set the height of a row inside the header/footer, use the headerRowHeight / footerRowHeight properties, correspondingly.

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    // footerRowHeight:50       headerRowHeight: 50    });

Related sample:  TreeGrid. Rows Height

The default value of the mentioned properties is 40.

Hidden columns

You can set the hidden:true property in the config of a column so that it doesn't appear on a page.

{ 
    width: 150, id: "population", header: [{ text: "Population" }] 
},
{ 
    hidden: true, width: 150, id: "yearlyChange", header: [{ text: "Yearly Change" }] }

Related sample:  TreeGrid. Hidden Columns

HTML content of TreeGrid columns

dhtmlxTreeGrid allows adding HTML content into TreeGrid cells in two ways:

  • by specifying the HTML content of all TreeGrid columns

This way presupposes making each cells of TreeGrid capable of displaying the HTML content via using the htmlEnable property in the configuration object of TreeGrid.

var dataset = [
    {
        "name": "A Time to Kill",
        "inStock": "80 <input type='checkbox' checked />"
    },
];
 
var treegrid = new dhx.TreeGrid("treegrid", {
    columns: [// columns config],
    data: dataset,
    htmlEnable: true });
  • by specifying the HTML content of a separate column

If you want to add custom elements into cells of the specified column, you need to set the htmlEnable:true property in the configuration of a column:

var dataset = [
    {
        "name": "A Time to Kill",
        "inStock": "80 <input type='checkbox' checked />"
    },
];
 
var treegrid = new dhx.TreeGrid("treegrid", {
    columns: [
        { width: 280, id: "name", header: [{ text: "Book Name" }] },
        {
            width: 160, id: "inStock", type: "string", 
            header: [{ text: "In stock" }], 
            htmlEnable: true         } 
        // more columns 
    ],
    data: dataset
});

Related sample:  TreeGrid. Html In Data

Resizing

Columns of Grid have fixed width with no possibility to change them from UI. You can switch on the corresponding resizable configuration option to make all columns of Grid resizable.

var grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    data: dataset,
    resizable: true }

Then you will be able to change the width of columns using the mouse. With the cursor grab the right border and drag to the desired width.

If you also set the autoWidth configuration option, you will be able to change the width of columns only inside the container of Grid.

You can disable the resizing of any column by setting the resizable:false property in the config of a column.

var grid = new dhx.Grid("grid_container", {
    columns: [
        { width: 150, id: "test1", header: [{ text: "Test1" }] },
        { width: 150, id: "test2", header: [{ text: "Test2" }], resizable: false }     ],
    data: dataset,
    resizable: true }

Related sample:  TreeGrid. Resizable Columns

To define the resizing limits, set necessary values to the minWidth/maxWidth properties in the config of a column.

Row height

The default height of a grid row is 40. You can change it and set any other height via the rowHeight property, e.g.:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    rowHeight: 30,      data: dataset
});

Related sample:  TreeGrid. Rows Height

Row style

There is a possibility to apply some styling to a row via the rowCss property. It is a function that takes the id of a row as a parameter and returns a string with the name of a CSS class.

<style>
    .my_custom_row {
        background: coral;
    }
</style>
 
 
var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    rowCss: function (row) { return row.custom ? "my_custom_row" : "" },     data: dataset
});

Related sample:  TreeGrid. Custom Row Style

Selection

dhtmlxTreeGrid includes the selection feature that allows highlighting TreeGrid elements depending on the chosen mode. The selection property enables selection in a grid. It can take three values:

  • row - to move selection between Grid rows
  • cell - to move selection between Grid cells
  • complex - to highlight both a selected cell and the row it belongs to
var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    selection:"complex",        data: dataset
});

Related sample:  TreeGrid. Selection

Sorting columns

By default, dhtmlxTreeGrid allows sorting content of any TreeGrid column by clicking on its header.

To disable this option, set the sortable property in the TreeGrid configuration to false:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    sortable:false,       data: dataset
});

Related sample:  TreeGrid. Sortable Columns

Sorting separate columns

You can make separate columns sortable by specifying the sortable:true property in the configuration of a column.

In the example below all columns will be sortable, except for the second one:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { width: 200, id: "country", header: [{ text: "Country" }], sortable: true },         { width: 150, id: "land", header: [{ text: "Land" }] },
        { width: 150, id: "density", header: [{ text: "Density" }], sortable: true }     ],
    data: dataset,
    sortable: false,    });

The following sample demonstrates the same situation:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [
        { width: 200, id: "country", header: [{ text: "Country" }] },
        { width: 150, id: "land", header: [{ text: "Land" }], sortable: false },         { width: 150, id: "density", header: [{ text: "Density" }] }
    ],
    data: dataset
});

Spans

The component has the spans property that allows you to specify all necessary columns and rows spans right through the initial configuration. It represents an array with spans objects. Each span object contains the following properties:

  • row - (string|number) obligatory, the id of a row
  • column - (string|number) obligatory, the id of a column
  • rowspan - (number) optional, the number of rows in a span
  • colspan - (number) optional, the number of columns in a span
  • text - (string|number) optional, the content of a span
  • css - (string) optional, the name of a CSS class applied to a span
  • tooltip - (boolean) enables a tooltip on hovering over the content of a span, true by default
var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    spans: [
        {row:"0", column:"a", rowspan:5 },
        {row:"0", column:"b", rowspan:9, text:"<h2>Some content here</h2>"},
        {row:"0", column:"c", colspan:2, text:"Some content"},
        {row:"10", column:"a", colspan:4, text:"Some header", css:"myCustomColspan"}
    ],
    data: dataset
});

Related sample:  TreeGrid. Spans Cells

Note, that if both the spans and splitAt properties are set in the Grid config, the following rules will be applied:

  • All necessary columns or rows will be in a span if the spans property is set for the columns located within the frozen area.
  • If the spans property is set for a number of columns or rows placed as in the frozen part as in the movable one, then the columns remained in the movable part only will be in a span.

Tooltip

The default configuration of TreeGrid provides tooltips that are rendered when a user hovers over the content of a column. Starting from v6.5, you can hide the tooltips via setting the tooltip configuration property of TreeGrid to false:

var treegrid = new dhx.TreeGrid("treegrid", {
    columns: [//columns config],
    data: dataset,
    tooltip: false 
});

Related sample:  Hiding tooltips - DHTMLX TreeGrid

There is also the possibility to enable/disable tooltips for separate columns or spans by using the tooltip option in the configuration object of the columns or spans accordingly:

var treeGrid = new dhx.TreeGrid("treegrid", {
    columns: [
        { width: 280, id: "name", header: [{ text: "Book Name" }], tooltip: true },         { width: 160, id: "cover", type: "string", header: [{}, { text: "Cover" }] },
        { width: 160, id: "ships", type: "string", header: [{ text: "Ships in" }] },
        { width: 160, id: "inStock", type: "string", header: [{ text: "In stock" }] }
    ],
    data: dataset,
    tooltip: false });

Related sample:  Hiding tooltips - DHTMLX TreeGrid

Width/height

You can specify necessary size of your TreeGrid via the configuration properties width and height:

var treegrid = new dhx.TreeGrid("treegrid_container", {
    columns: [// columns config],
    width: 400,       height: 400,      data: dataset
});

In case these options aren't set in the TreeGrid configuration, the component will take the size of the container.

Back to top