Row spanning in Angular Grid component
17 Feb 202417 minutes to read
The grid provides an option to span row cells, allowing you to merge two or more cells in a row into a single cell. This feature can be useful in scenarios where you want to display information that spans across multiple rows, but want to avoid repeating the same information in each row.
To achieve this, You need to define the rowSpan attribute to span cells in the queryCellInfo event. The rowSpan attribute is used to specify the number of rows that the current cell should span.
The queryCellInfo event is triggered for each cell in the grid, and allows you to customize the cells in the grid. By handling this event, you can set the rowSpan attribute for a cell to achieve row spanning.
In the following demo, Davolio cell is spanned to two rows in the EmployeeName column.Also Grid supports the spanning of rows and columns for same cells. Lunch Break cell is spanned to two rows and three columns in the 1:00 column.
import { Component, OnInit } from '@angular/core';
import { QueryCellInfoEventArgs, GridLine, Column } from '@syncfusion/ej2-angular-grids';
import { columnSpanData, ColumnSpanDataType } from './datasource';
import { EmitType } from '@syncfusion/ej2-base';
@Component({
selector: 'app-root',
template: `<ejs-grid [dataSource]='data' [height]='300' [width]='width' [gridLines]='gridLines'
[allowTextWrap]='textWrap' (queryCellInfo)='queryCellInfoEvent($event)'>
<e-columns>
<e-column field='EmployeeID' headerText='Employee ID' width='150' textAlign="Right" isPrimaryKey=true></e-column>
<e-column field='EmployeeName' headerText='Employee Name' width='200'></e-column>
<e-column field='9:00' headerText='9:00 AM' width='120'></e-column>
<e-column field='9:30' headerText='9:30 AM' width='120'></e-column>
<e-column field='10:00' headerText='10:00 AM' width='120'></e-column>
<e-column field='10:30' headerText='10:30 AM' width='120'></e-column>
<e-column field='11:00' headerText='11:00 AM' width='120'></e-column>
<e-column field='11:30' headerText='11:30 AM' width='120'></e-column>
<e-column field='12:00' headerText='12:00 PM' width='120'></e-column>
<e-column field='12:30' headerText='12:30 PM' width='120'></e-column>
<e-column field='1:00' headerText='1:00 PM' width='120'></e-column>
<e-column field='1:30' headerText='1:30 PM' width='120'></e-column>
<e-column field='2:00' headerText='2:00 PM' width='120'></e-column>
<e-column field='2:30' headerText='2:30 PM' width='120'></e-column>
<e-column field='3:00' headerText='3:00 PM' width='120'></e-column>
<e-column field='3:30' headerText='3:30 PM' width='120'></e-column>
<e-column field='4:00' headerText='4:00 PM' width='120'></e-column>
<e-column field='4:30' headerText='4:30 PM' width='120'></e-column>
<e-column field='5:00' headerText='5:00 PM' width='120'></e-column>
</e-columns>
</ejs-grid>`
})
export class AppComponent implements OnInit {
public data?: object[];
public width?: string | number;
public gridLines?: GridLine;
public textWrap?: boolean;
public queryCellInfoEvent: EmitType<QueryCellInfoEventArgs> = (args: QueryCellInfoEventArgs) => {
const data: ColumnSpanDataType = args.data as ColumnSpanDataType;
switch (data.EmployeeID) {
case 10001:
if (((args.column as Column) as Column).field === '9:00' || (args.column as Column).field === '2:30' || (args.column as Column).field === '4:30') {
args.colSpan = 2;
} else if ((args.column as Column).field === '11:00') {
args.colSpan = 3;
} else if ((args.column as Column).field === 'EmployeeName') {
args.rowSpan = 2;
} else if ((args.column as Column).field === '1:00') {
args.colSpan = 3;
args.rowSpan = 2;
}
break;
case 10002:
if ((args.column as Column).field === '9:30' || (args.column as Column).field === '2:30' ||
(args.column as Column).field === '4:30') {
args.colSpan = 3;
} else if ((args.column as Column).field === '11:00') {
args.colSpan = 4;
}
break;
case 10003:
if ((args.column as Column).field === '9:00' || (args.column as Column).field === '11:30') {
args.colSpan = 3;
} else if ((args.column as Column).field === '10:30' || (args.column as Column).field === '3:30' ||
(args.column as Column).field === '4:30' || (args.column as Column).field === '2:30') {
args.colSpan = 2;
}
break;
case 10004:
if ((args.column as Column).field === '9:00') {
args.colSpan = 3;
} else if ((args.column as Column).field === '11:00') {
args.colSpan = 4;
} else if ((args.column as Column).field === '4:00' || (args.column as Column).field === '2:30') {
args.colSpan = 2;
}
break;
case 10005:
if ((args.column as Column).field === '9:00') {
args.colSpan = 4;
} else if ((args.column as Column).field === '11:30') {
args.colSpan = 3;
} else if ((args.column as Column).field === '3:30' || (args.column as Column).field === '4:30' || (args.column as Column).field === '2:30') {
args.colSpan = 2;
}
break;
case 10006:
if ((args.column as Column).field === '9:00' || (args.column as Column).field === '4:30' ||
(args.column as Column).field === '2:30' || (args.column as Column).field === '3:30') {
args.colSpan = 2;
} else if ((args.column as Column).field === '10:00' || (args.column as Column).field === '11:30') {
args.colSpan = 3;
}
break;
case 10007:
if ((args.column as Column).field === '9:00' || (args.column as Column).field === '3:00' || (args.column as Column).field === '10:30') {
args.colSpan = 2;
} else if ((args.column as Column).field === '11:30' || (args.column as Column).field === '4:00') {
args.colSpan = 3;
}
break;
case 10008:
if ((args.column as Column).field === '9:00' || (args.column as Column).field === '10:30' || (args.column as Column).field === '2:30') {
args.colSpan = 3;
} else if ((args.column as Column).field === '4:00') {
args.colSpan = 2;
}
break;
case 10009:
if ((args.column as Column).field === '9:00' || (args.column as Column).field === '11:30') {
args.colSpan = 3;
} else if ((args.column as Column).field === '4:30' || (args.column as Column).field === '2:30') {
args.colSpan = 2;
}
break;
case 100010:
if ((args.column as Column).field === '9:00' || (args.column as Column).field === '2:30' ||
(args.column as Column).field === '4:00' || (args.column as Column).field === '11:30') {
args.colSpan = 3;
} else if ((args.column as Column).field === '10:30') {
args.colSpan = 2;
}
break;
}
}
ngOnInit(): void {
this.data = columnSpanData;
this.gridLines = 'Both';
this.width = 'auto';
this.textWrap = true;
}
}import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { GridModule } from '@syncfusion/ej2-angular-grids';
import { AppComponent } from './app.component';
/**
* Module
*/
@NgModule({
imports: [
BrowserModule,
GridModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';
import 'zone.js';
enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);To disable the spanning for particular grid page, you need to use requestType from
queryCellInfoevent argument.
TherowSpanandcolSpanattributes can be used together to merge cells both vertically and horizontally.
Limitations
- The updateCell method does not support row spanning.
- Row spanning is not compatible with the following features:
- Virtual scrolling
- Infinite scrolling
- Grouping
- Row drag and drop
- Autofill
- Inline editing
- Batch editing
- CRUD