Data binding in Angular Spreadsheet component
14 Oct 202424 minutes to read
The Spreadsheet uses DataManager, which supports both RESTful JSON data services and local JavaScript object array binding to a range. The dataSource property can be assigned either with the instance of DataManager or JavaScript object array collection.
To bind data to a cell, use
cell data bindingsupport.
Local data
To bind local data to the Spreadsheet, you can assign a JavaScript object array to the dataSource property.
Refer to the following code example for local data binding.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, OnInit,ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { data } from './datasource';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet> <e-sheets> <e-sheet> <e-ranges> <e-range [dataSource]='data'></e-range></e-ranges><e-columns><e-column [width]=90></e-column><e-column [width]=100></e-column><e-column [width]=96></e-column><e-column [width]=120></e-column><e-column [width]=130></e-column><e-column [width]=120></e-column></e-columns></e-sheet></e-sheets></ejs-spreadsheet>"
})
export class AppComponent implements OnInit {
public data?: object[];
@ViewChild('spreadsheet') public spreadsheetObj?: SpreadsheetComponent;
ngOnInit(): void {
this.data = data;
}
};import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));The local data source can also be provided as an instance of the
DataManager. By default,DataManagerusesJsonAdaptorfor local data-binding.
Customizing column data mapping
By default, when a data source is bound to a sheet, columns are auto-assigned from the data source fields sequentially. This means that the first field in the data source is assigned to Column A, the second to Column B, and so on, sequentially. However, now you can customize the column assignments by specifying the appropriate field names in the desired order using the fieldsOrder property.
You can customize the mapping of column data only in the local data binding support.
The following code example demonstrates how to customize the mapping of column data:
import { NgModule, ViewChild } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule, SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet'
import { Component } from '@angular/core';
import { getDefaultData } from './datasource';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: `<ejs-spreadsheet #spreadsheet [openUrl]="openUrl" [saveUrl]="saveUrl">
<e-sheets>
<e-sheet name="Car Sales Report">
<e-ranges>
<e-range [dataSource]="data" [fieldsOrder]="fieldsOrder"></e-range>
</e-ranges>
<e-columns>
<e-column [width]="180"></e-column>
<e-column [width]="130"></e-column>
<e-column [width]="130"></e-column>
<e-column [width]="180"></e-column>
<e-column [width]="130"></e-column>
<e-column [width]="120"></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>`
})
export class AppComponent {
constructor() {
}
@ViewChild('spreadsheet')
public spreadsheetObj!: SpreadsheetComponent;
public data: Object[] = getDefaultData();
public openUrl = 'https://services.syncfusion.com/angular/production/api/spreadsheet/open';
public saveUrl = 'https://services.syncfusion.com/angular/production/api/spreadsheet/save';
public fieldsOrder: string[] = ['Customer Name', 'Payment Mode', 'Model', 'Color', 'Amount', 'Delivery Date'];
}import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent)
.catch((err) => console.error(err));Remote data
To bind remote data to the Spreadsheet control, assign service data as an instance of DataManager to the dataSource property. To interact with remote data source, provide the service endpoint url.
Refer to the following code example for remote data binding.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, OnInit, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { DataManager, Query } from '@syncfusion/ej2-data';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet><e-sheets><e-sheet name='Shipment Details'> <e-ranges> <e-range [showFieldAsHeader]='false' startCell='A2' [dataSource]='data' [query]='query'> </e-range> </e-ranges><e-rows><e-row><e-cells><e-cell value='Order ID'></e-cell> <e-cell value='Customer Name'></e-cell> <e-cell value='Freight'></e-cell> <e-cell value='Ship Name'></e-cell><e-cell value='Ship City'></e-cell> <e-cell value='Ship Country'></e-cell></e-cells> </e-row></e-rows><e-columns><e-column [width]=100></e-column> <e-column [width]=130></e-column> <e-column [width]=100></e-column> <e-column [width]=220></e-column> <e-column [width]=150></e-column> <e-column [width]=180></e-column> </e-columns> </e-sheet></e-sheets></ejs-spreadsheet>"
})
export class AppComponent implements OnInit {
@ViewChild('spreadsheet') public spreadsheetObj?: SpreadsheetComponent;
public query: Query = new Query().select(['OrderID', 'CustomerID', 'ShipName', 'ShipCity', 'ShipCountry', 'Freight']).take(200);
public data: DataManager = new DataManager({
url: 'https://services.syncfusion.com/js/production/api/Orders',
crossDomain: true
});
ngOnInit(): void {
this.data = this.data;
}
}import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));By default,
DataManageruses ODataAdaptor for remote data-binding.
Binding with OData services
OData is a standardized protocol for creating and consuming data. You can retrieve data from OData service using the DataManager. Refer to the following code example for remote Data binding using OData service.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, OnInit, ViewChild } from '@angular/core';
import { DataManager, ODataAdaptor } from '@syncfusion/ej2-data';
import { SpreadsheetComponent, CellModel, UsedRangeModel, SheetModel } from '@syncfusion/ej2-angular-spreadsheet';
import { getComponent, print } from '@syncfusion/ej2-base';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet (created)='created()'> <e-sheets> <e-sheet> <e-ranges> <e-range [dataSource]='data'></e-range></e-ranges><e-columns><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=280></e-column><e-column [width]=180></e-column><e-column [width]=80></e-column><e-column [width]=180></e-column><e-column [width]=180></e-column></e-columns> </e-sheet></e-sheets></ejs-spreadsheet>"
})
export class AppComponent implements OnInit {
@ViewChild('spreadsheet')
public spreadsheetObj: SpreadsheetComponent | undefined;
public data?: DataManager;
ngOnInit(): void {
this.data = new DataManager({
url: 'https://services.syncfusion.com/angular/production/api/Orders',
adaptor: new ODataAdaptor(),
crossDomain: true
});
}
created(){
//Applies cell and number formatting to specified range of the active sheet
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center', verticalAlign: 'middle' },
'A1:K1');
};
}import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));Web API
You can use WebApiAdaptor to bind spreadsheet with Web API created using OData endpoint.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, OnInit, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { DataManager, WebApiAdaptor } from '@syncfusion/ej2-data';
import { getComponent, print } from '@syncfusion/ej2-base';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet (created)='created()'> <e-sheets> <e-sheet> <e-ranges> <e-range [dataSource]='data'></e-range></e-ranges><e-columns><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=80></e-column><e-column [width]=280></e-column><e-column [width]=180></e-column><e-column [width]=80></e-column><e-column [width]=180></e-column><e-column [width]=180></e-column></e-columns> </e-sheet></e-sheets></ejs-spreadsheet>"
})
export class AppComponent implements OnInit {
@ViewChild('spreadsheet')
public spreadsheetObj: SpreadsheetComponent | undefined;
public data?: DataManager;
ngOnInit(): void {
this.data = new DataManager({
url: 'https://services.syncfusion.com/angular/production/api/Orders',
adaptor: new WebApiAdaptor(),
crossDomain: true
});
}
created(){
//Applies cell and number formatting to specified range of the active sheet
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center', verticalAlign: 'middle' },
'A1:K1');
};
}import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));Cell data binding
The Spreadsheet control can bind the data to individual cell in a sheet . To achive this you can use the value property.
Refer to the following code example for cell data binding.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, OnInit,ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: "<ejs-spreadsheet #spreadsheet> <e-sheets> <e-sheet selectedRange='D13'><e-rows> <e-row><e-cells> <e-cell value='Order ID'></e-cell> <e-cell value='Customer ID'></e-cell> <e-cell value='Employee ID'></e-cell> <e-cell value='Ship Name'></e-cell> <e-cell value='Ship City'></e-cell> <e-cell value='Ship Address'></e-cell> </e-cells> </e-row> <e-row> <e-cells> <e-cell value='10248'></e-cell> <e-cell value='VINET'></e-cell> <e-cell value='5'></e-cell> <e-cell value='Vins et alcools Chevalier'></e-cell> <e-cell value='Reims'></e-cell> <e-cell value='59 rue de lAbbaye'></e-cell> </e-cells> </e-row> <e-row> <e-cells> <e-cell value='10249'></e-cell> <e-cell value='TOMSP'></e-cell> <e-cell value='3'></e-cell> <e-cell value='Toms Spezialitäten'></e-cell> <e-cell value='Münster'></e-cell> <e-cell value='Luisenstr. 48'></e-cell> </e-cells> </e-row> <e-row> <e-cells> <e-cell value='10250'></e-cell> <e-cell value='HANAR'></e-cell> <e-cell value='2'></e-cell> <e-cell value='Hanari Carnes'></e-cell> <e-cell value='Rio de Janeiro'></e-cell> <e-cell value='Rua do Paço, 67'></e-cell> </e-cells> </e-row> <e-row> <e-cells> <e-cell value='10251'></e-cell> <e-cell value='VICTE'></e-cell> <e-cell value='3'></e-cell> <e-cell value='Victuailles en stock'></e-cell> <e-cell value='Lyon'></e-cell> <e-cell value='2, rue du Commerce'></e-cell> </e-cells> </e-row> <e-row> <e-cells> <e-cell value='10252'></e-cell> <e-cell value='SUPRD'></e-cell> <e-cell value='4'></e-cell><e-cell value='Suprêmes délices'></e-cell><e-cell value='Charleroi'></e-cell><e-cell value='Boulevard Tirou, 255'></e-cell></e-cells></e-row></e-rows><e-columns><e-column [width]=110></e-column><e-column [width]=115></e-column><e-column [width]=110></e-column> <e-column [width]=130></e-column> <e-column [width]=140></e-column><e-column [width]=150></e-column> </e-columns></e-sheet></e-sheets><e-rows></e-rows></ejs-spreadsheet>"
})
export class AppComponent implements OnInit {
ngOnInit(): void {
throw new Error('Method not implemented.');
}
@ViewChild('spreadsheet') public spreadsheetObj?: SpreadsheetComponent;
}import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));The cell data binding also supports formula, style, number format, and more.
Dynamic data binding and Datasource change event
You can dynamically change the datasource of the spreadsheet by changing the model which is bound to the dataSource property or by changing the dataSource property of the range object of the sheet directly. The dataSourceChanged event handler will be triggered when editing, inserting, and deleting a row in the datasource range. This event will be triggered with a parameter named action which indicates the edit, add and delete actions for the respective ones.
The following table defines the arguments of the dataSourceChanged event.
| Property | Type | Description |
|---|---|---|
| action | string | Indicates the type of action such as edit, add, and delete performed in the datasource range. |
| data | object[] | Modified data for edit action; New data for add action; Deleted data for delete action. |
| rangeIndex | number | Specifies the range index of the datasource. |
| sheetIndex | number | Specifies the sheet index of the datasource. |
For
addaction, the value for all the fields will benullin the data. In the case that you do not want the primary key field to be null which needs to be updated in the backend service, you can useeditaction after updating the primary key field to update in the backend service.
For inserting a row at the end of the datasource range, you should insert a row below at the end of the range to trigger thedataSourceChangedevent with actionadd.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, OnInit,ViewChild, ViewEncapsulation } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { DataSourceChangedEventArgs } from '@syncfusion/ej2-spreadsheet';
import { data, itemData } from './datasource';
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: `<div>
<div>
<button class='e-btn' style="margin-bottom: 10px;" (click)='changeDataSource()'>Change Datasource</button>
<ejs-spreadsheet #spreadsheet (dataSourceChanged)='dataSourceChanged($event)' [showRibbon]='false'>
<e-sheets>
<e-sheet>
<e-ranges><e-range [dataSource]='data'></e-range></e-ranges>
<e-columns><e-column [width]=90></e-column><e-column [width]=100></e-column><e-column [width]=96></e-column><e-column [width]=120></e-column><e-column [width]=130></e-column><e-column [width]=120></e-column></e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</div>
<div>
<h4><b>Event Trace</b></h4>
<div id="evt">
<div style="height:173px;overflow: auto;min-width: 250px;">
<span #EventLog class="EventLog" id="EventLog" style="word-break: normal;"></span>
</div>
<button class='e-btn' (click)='clearTrace()'>Clear</button>
</div>
</div>
</div>`,
styles: [`
#EventLog b {
color: #388e3c;
}
#evt {
border: 1px solid #dcdcdc;
padding: 10px;
}
`],
encapsulation: ViewEncapsulation.None
})
export class AppComponent {
public data: object[] = data;
@ViewChild('spreadsheet') public spreadsheetObj?: SpreadsheetComponent;
@ViewChild('EventLog') EventLogEle: any;
dataSourceChanged(args: DataSourceChangedEventArgs): void {
this.appendElement("Data source changed with" + "<b> " + args.action + "</b> action<hr>");
}
changeDataSource(): void {
this.data = itemData;
// You can also change the datasource of the range by changing dataSource property of the range by using below line of code.
// this.spreadsheetObj.sheets[0].ranges[0].dataSource = itemData;
}
clearTrace(): void {
this.EventLogEle.nativeElement.innerHTML = "";
}
appendElement(html: string): void {
let span: HTMLElement = document.createElement("span");
span.innerHTML = html;
let log: HTMLElement = this.EventLogEle.nativeElement;
log.insertBefore(span, log.firstChild);
}
};import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));Dynamic data binding using updateRange method
The updateRange method allows you to dynamically update the dataSource in a spreadsheet without manually iterating through each cell. This method is especially useful for efficiently applying bulk updates to a specific range within the spreadsheet.
To use the updateRange method, provide the new dataSource and specify the starting cell for the update using the startCell property of the RangeDirective. Additionally, set the sheetIndex to target the appropriate sheet for the update.
The following code example demonstrates how to dynamically update data using the updateRange method.
import { Component, OnInit, ViewChild } from '@angular/core';
import { defaultData } from './datasource';
import { SpreadsheetComponent, SheetModel, getRangeIndexes, getSwapRange, getRangeAddress, CellModel, RangeModel } from '@syncfusion/ej2-angular-spreadsheet';
import { isNullOrUndefined } from '@syncfusion/ej2-base';
@Component({
selector: 'app-container',
template: `<button class="e-btn custom-btn" (click)="updateDataCollection()">Update Dynamic Data</button>
<ejs-spreadsheet #spreadsheet (created)='created()'>
<e-sheets>
<e-sheet>
<e-ranges>
<e-range [dataSource]='dataSource'>
</e-range>
</e-ranges>
<e-columns>
<e-column [width]=150></e-column>
<e-column [width]=120></e-column>
<e-column [width]=100></e-column>
<e-column [width]=180></e-column>
<e-column [width]=130></e-column>
<e-column [width]=120></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>`
})
export class AppComponent implements OnInit {
public dataSource?: object[];
@ViewChild('spreadsheet')
public spreadsheetObj!: SpreadsheetComponent;
ngOnInit(): void {
this.dataSource = defaultData;
}
created() {
// Applies cell formatting to specified range of the active sheet.
this.spreadsheetObj.cellFormat({ fontWeight: 'bold', textAlign: 'center', verticalAlign: 'middle' }, 'A1:F1');
};
updateDataCollection(): void {
const newDataCollection: RangeModel = {
dataSource: [
{
'Payment Mode': 'Debit Card',
'Delivery Date': '07/11/2015',
'Amount': '8529.22',
},
{
'Payment Mode': 'Cash On Delivery',
'Delivery Date': '7/13/2016',
'Amount': '17866.19',
},
{
'Payment Mode': 'Net Banking',
'Delivery Date': '09/04/2015',
'Amount': '13853.09',
},
{
'Payment Mode': 'Credit Card',
'Delivery Date': '12/15/2017',
'Amount': '2338.74',
},
{
'Payment Mode': 'Credit Card',
'Delivery Date': '10/08/2014',
'Amount': '9578.45',
},
{
'Payment Mode': 'Cash On Delivery',
'Delivery Date': '7/01/2017',
'Amount': '19141.62',
},
{
'Payment Mode': 'Credit Card',
'Delivery Date': '12/20/2015',
'Amount': '6543.30',
},
{
'Payment Mode': 'Credit Card',
'Delivery Date': '11/24/2014',
'Amount': '13035.06',
},
{
'Payment Mode': 'Debit Card',
'Delivery Date': '05/12/2014',
'Amount': '18488.80',
},
{
'Payment Mode': 'Net Banking',
'Delivery Date': '12/30/2014',
'Amount': '12317.04',
},
{
'Payment Mode': 'Credit Card',
'Delivery Date': '12/18/2013',
'Amount': '6230.13',
},
{
'Payment Mode': 'Cash On Delivery',
'Delivery Date': '02/02/2015',
'Amount': '9709.49',
},
{
'Payment Mode': 'Debit Card',
'Delivery Date': '11/19/2014',
'Amount': '9766.10',
},
{
'Payment Mode': 'Net Banking',
'Delivery Date': '02/08/2014',
'Amount': '7685.49',
},
{
'Payment Mode': 'Debit Card',
'Delivery Date': '08/05/2016',
'Amount': '18012.45',
},
{
'Payment Mode': 'Credit Card',
'Delivery Date': '05/30/2016',
'Amount': '2785.49',
},
{
'Payment Mode': 'Debit Card',
'Delivery Date': '12/10/2016',
'Amount': '9967.74',
},
],
startCell: 'D1',
}
this.spreadsheetObj.updateRange(newDataCollection,0)
}
}import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';
import 'zone.js';
enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);Note
You can refer to our Angular Spreadsheet feature tour page for its groundbreaking feature representations. You can also explore our Angular Spreadsheet example to knows how to present and manipulate data.