Skip to content

addSpan

adds a colspan or a rowspan to the datagrid

function addSpan(
// the id of the row that starts colspan/rowspan
id: number|string|WebixSpanConfig,
// the id of the column that starts colspan/rowspan
column?: string,
// how many columns should the span include
width?: number,
// how many rows should the span include
height?: number,
// value that the span area should display
value?: string,
// css class that should be applied to the span area
css?: string
): void
grid.addSpan(1, "country", 1, 3);
grid.refresh();

To enable the rowspans and colspans functionality, you should set the spans parameter to true in the datagrid configuration:

webix.grid({
columns:[...],
spans:true
...
});

The method can also take an array of arrays with the same configuration (id, column, width, height, value, css) to define several spans at a time.

grid.addSpan([
[1, "country", 1, 3],
[4, "country", 1, 2],
[6, "country", 1, 3]
]);

Defaults:

  • default values for span width and height are 1;
  • span value parameter is optional and used if a custom text for the cell is required. If you need to display the initial value, omit this field or pass an empty value ("", null);
  • span css is optional. By default, colspans and rowspans don’t feature any special styling.

Articles

API