Configuration

dhtmlxGrid 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 grid = new dhx.Grid("grid_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
});

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

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 grid = new dhx.Grid("grid_container", {
    columns: [
        { id: "name", header:  [{ title: "Name", align: "center" }], align: "right"}         // more options
    ],
    data: dataset
});

Related sample:  Content align - DHTMLX Grid

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

Automatic adding of empty row into Grid

There is a possibility to automatically add an empty row after the last filled row in the grid. Use the autoEmptyRow property in the Grid configuration object to enable this feature:

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

Related sample:  Grid. Auto Empty Row

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 four values:


var grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    adjust: "header",     data: dataset
});

Related sample:  Grid. 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 grid = new dhx.Grid("grid_container", { 
    columns: [
        { id: "country", header: [{ text: "Country" }], adjust: "header" },         { id: "population", header: [{ text: "Population" }] }
    ],
    adjust: false,     data: dataset
});

In case complex HTML content is added into a column, the column width may be calculated incorrectly.

Autoheight for columns

Starting from v7.1, you can set the autoHeight:true option in the configuration of Grid to make long text to split into multiple lines automatically based on the width of the column

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

Related sample:  Grid. Auto height

As a result, the height of the cells will automatically adjust to their content.

But, note, that the autoHeight option does not adjust the height in the cells of the header/footer of Grid. The option just makes their text to split into multiple lines, but the height of the cells will remain the same. To set the height of the rows in the header/footer, you should apply the headerRowHeight and footerRowHeight configuration options of Grid.

Autowidth for columns

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

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

Related sample:  Auto width - DHTMLX Grid

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

var grid = new dhx.Grid("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 grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    data: dataset });

Drag-n-drop of Grid columns

This functionality requires PRO version of the dhtmlxGrid (or DHTMLX suite) package.

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

var grid = new dhx.Grid("grid_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 grid = new dhx.Grid("grid_container", {
    columns: [
        { width: 200, id: "country", header: [{ text: "Country" }], draggable: false },         { width: 150, id: "land", header: [{ text: "Land" }] },
        { width: 150, id: "density", header: [{ text: "Density" }], draggable: false }     ],
    data: dataset,
    dragItem: "column",    });

Related sample:  Setup drag column (Pro)

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

Drag-n-drop of Grid rows

dhtmlxGrid 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 Grid. 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 grid = new dhx.Grid("grid_container", { 
    columns: [
        { id: "country", header: [{ text: "Country" }] },
        { id: "population", header: [{ text: "Population" }] }
    ],
    data: dataset,
    dragMode: "source" });

Related sample:  Grid. Setup Drag Mode

Here is a list of drag-n-drop events that you can use while drag-n-drop of rows is enabled:

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 grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    data: data,
    editable: true });

Related sample:  Grid. 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 grid = new dhx.Grid("grid", {
    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 grid = new dhx.Grid("grid", {
    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 input, select control, date picker, checkbox or combobox. The type of the used editor is defined by the editorType property of a column. There are five 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 grid = new dhx.Grid("grid", {
    columns: [
        {
            width: 150,
            id: "project",
            header: [{ text: "Project" }, { content: "selectFilter" }]
        }
    // more columns
    ],
    data: data,
    editable: true
});

Related sample:  Grid. Editable Data

  • 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 format 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", format: "%d/%m/%Y"  }

Related sample:  Grid. Editable Data

  • 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:  Grid. 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:  Grid. Editable Data

If you specify the editing 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:  Grid. Editable Data

  • textarea - an editor for cells that contain text

To use this editor, you should specify the editorType:"textarea" property for a column.

The textarea editor allows editing multiple lines of text when the autoHeight:true configuration option of Grid is enabled. The functionality is available only in PRO version of the dhtmlxGrid (or DHTMLX suite) package.

var grid = new dhx.Grid("grid", {
    columns: [
        {
            width: 150, id: "project", 
            header: [{ text: "Project" }, { content: "selectFilter" }], 
            editorType: "textarea"         }
    // more columns
    ],
    data: data,
    editable: true,
    autoHeight: true });

Related sample:  Grid. Editable Data

Formatting columns

Starting from v7.1, you can display the values of the cells of a Grid column in the desired format:

1. To define the format for numeric values, apply the format configuration option of the column:

{ 
    width: 150, id: "population", header: [{ text: "Population" }],  
    format: "# #.0" }
// -> 1415045928 will be displayed as 1 415 045 928.0

The following characters can be used:

  • # - the integer part of the number
  • 0 - the fractional part of the number. The 0 placeholder displays insignificant zeros if a number has fewer digits than there are zeros in the format string, for instance, the .00 format will display 0.298 as 0.30.
    If a number has more digits to the right of the decimal point than there are placeholders in the format string, the number rounds to as many decimal places as there are placeholders, for instance, the .000 format will display 0.2 as 0.200.
  • # # - sets the thousands separator in a number (123 456)
  • #.0 - sets the separator for the decimal point in a number (123 456.357)

2. You can display the percentage value in the necessary format by setting the type: "percent" configuration option of a column together with the format option:

{ 
    width: 150, id: "yearlyChange", header: [{ text: "Yearly Change" }], 
    type: "percent", format: "#.00" }
// -> 0.0039 will be displayed as 0.39%

When using just the type: "percent" configuration option of a column, the result will be the following:

{ 
    width: 150, id: "yearlyChange", header: [{ text: "Yearly Change" }], 
    type: "percent" }
// -> 0.0039 will be displayed as 0%

3. To define the format for dates, set the type: "date" property for a column and define the format of dates with the help of the format option:

{ 
    width: 150, id: "date", header: [{ text: "Date" }], 
    type: "date", format: "%M %d %Y" }

Related sample:  Grid. Data formats

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 leftSplit 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 grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    leftSplit:1,       data: dataset
});

Related sample:  Grid. 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" }] }

Related sample:  Grid. Header Filter

  • 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"] 
}

Related sample:  Grid. Header Filter

  • 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"] 
}

Related sample:  Grid. Header Filter

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

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

The list of configuration properties for comboFilter


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 grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    // footerRowHeight:50       headerRowHeight: 50    });

Related sample:  Grid. 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:  Grid. Hidden Columns

HTML content of Grid columns

dhtmlxGrid allows adding an image or an icon into Grid cells in two ways:

  • by specifying the HTML content of all Grid columns

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

var dataset = [
    {
        "country": "China",
        "flag": "<img src='../flags/cn.jpg' />",
        "id": "1"
    }
];
 
var grid = new dhx.Grid("grid", {
    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 = [
    {
        "country": "<span>China</span><img src='../flags/cn.jpg' />",
        "id": "1"
    }
];
 
var grid = new dhx.Grid("grid", {
    columns: [
        {
            width: 200, id: "country", header: [{ text: "Country" }],
            htmlEnable: true         }, 
        { 
            width: 150, id: "urban", header: [{ text: "Urban Pop" }] 
        }, 
        // more columns 
    ],
    data: dataset
});

Related sample:  Grid. Html In Data

Event handlers for HTML content

Starting from v7.0, you can add event handlers to the HTML elements defined in a data set of Grid with the help of the eventHandlers configuration property, for instance:

const data = [
    {
        "country": "<div class='cell__html'><span>China</span>             <img src='../flags/cn.svg'></div>",         "population": "1415045928", "yearlyChange": "0.0039",
        "netChange": "5528531", "destiny": "151",
        "urban": "0.5800", "id": "1"
    },
    // more options
];
 
const grid = new dhx.Grid("grid", {
    columns: [
        { width: 200, id: "country", header: [{ text: "Country" }], htmlEnable: true },         // more options
    ],
    data: data,
    eventHandlers: {         onclick: {             cell__html: function(event, data) {                 display(JSON.stringify(data.col, null, 2));             },         },         onmouseover: {             cell__html: function(event) {                 display("You are over " + event.target.tagName);             },         }     } });

Related sample:  Handling events in template - DHTMLX Grid

The eventHandlers object includes a set of key:value pairs, where:

Keyboard Navigation

dhtmlxGrid provides the keyboard navigation that will help you manipulate your grid faster.

Default shortcut keys

There are four navigation keys that Grid enables by default:

If you need to disable this functionality, set the keyNavigation property to false.

var grid = new dhx.Grid("grid", {
    columns: [// columns config],
    data: dataset,
    keyNavigation: false });

Related sample:  Grid. Key Navigation

Arrow shortcut keys

In case you want to enable the arrow keys that allow moving the selection between cells, you need to specify the selection property for Grid.

var grid = new dhx.Grid("grid", {
    columns: [// columns config],
    data: dataset,
    selection: "complex",     keyNavigation: true // true - by default
});

Related sample:  Grid. Key Navigation

The list of the arrow shortcut keys:

The arrow shortcut keys listed below do not work when the selection property is set to "complex". Use another mode ("cell" or "row") in case you you want to activate these navigation keys:

Shortcut keys for editing

It is also possible to use shortcut keys for editing a cell in Grid by setting editable:true property in the configuration object of Grid.

var grid = new dhx.Grid("grid", {
    columns: [// columns config],
    data: dataset,
    selection: "complex",     editable: true,     keyNavigation: true // true - by default
});

Related sample:  Grid. Key Navigation

The list of the shortcut keys for editing:

Multiple selection of Grid cells

While setting the selection property either to "row" or to "cell" value, you can enable the multiselection property to allow a user to select multiple Grid elements:

var grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    multiselection:true,     selection:"row",
    data: dataset
});

Related sample:  Grid. Multiselection

Since the multiselection configuration option is set to true, using the "Ctrl + Click" combination allows selecting the desired cells or rows. A range of Grid cells/rows can be selected by clicking the first element to select and then, while holding down the Shift key, clicking the last element to select.

Resizing

Columns of Grid have fixed width with no possibility to change them from UI. You can switch on the corresponding 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:  Grid. 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 grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    rowHeight: 30,      data: dataset
});

Related sample:  Grid. Rows Height

In this case, the height of each row is 30.

Setting height for a separate row

Starting with v7.1, it is possible to specify the height for the necessary row of data in Grid via setting the number value to the height option when defining the data set:

var dataset = [
    {
        "country": "China",
        "population": "1415045928",
        "height": 80,         "id": "1"
    },
    {
        "country": "India",
        "population": "1354051854",
        "id": "2",
    }
];

Related sample:  Grid. Row height

The height option has a higher priority than the autoHeight:true configuration property of Grid.

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 grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    rowCss: function (row) { return row.custom ? "my_custom_row" : "" },     data: dataset
});

Related sample:  Grid. Custom Row Style

Selection

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


var grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    selection:"complex",        data: dataset
});

Related sample:  Grid. Selection

Sorting columns

By default, dhtmlxGrid allows sorting content of any Grid column by clicking on its header.

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

var grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    sortable:false,       data: dataset
});

Related sample:  Grid. 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 grid = new dhx.Grid("grid_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 grid = new dhx.Grid("grid_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:


var grid = new dhx.Grid("grid_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:  Grid. Spans Cells

Note, that if both the spans and leftSplit 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 Grid 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 Grid to false:

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

Related sample:  Hiding tooltips - DHTMLX Grid

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 grid = new dhx.Grid("grid", {
    columns: [
        { width: 200, id: "country", header: [{ text: "Country" }], tooltip: true },         { width: 150, id: "population", header: [{ text: "Population" }] },
    ],
    spans: [
        { row: "1", column: "country", rowspan: 5, tooltip: true },     ],
    data: dataset,
    tooltip: false });

Width/height

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

var grid = new dhx.Grid("grid_container", {
    columns: [// columns config],
    width: 400,       height: 400,      data: dataset
});

Related sample:  Grid. Custom Sizes

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

Back to top