Worksheet in Angular Spreadsheet component
1 Jul 202424 minutes to read
Worksheet is a collection of cells organized in the form of rows and columns that allows you to store, format, and manipulate the data.
Add sheet
You can dynamically add or insert a sheet by one of the following ways,
- Click the
Add Sheet
button in the sheet tab. This will add a new empty sheet next to current active sheet. - Right-click on the sheet tab, and then select
Insert
option from the context menu to insert a new empty sheet before the current active sheet. - Using
insertSheet
method, you can insert one or more sheets at your desired index.
The following code example shows the insert sheet operation in spreadsheet.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { enableRipple } from '@syncfusion/ej2-base';
import { dataSource } from './datasource';
enableRipple(true);
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: `<ejs-spreadsheet #spreadsheet (created)="created()" [showFormulaBar]="false" [showRibbon]="false">
<e-sheets>
<e-sheet name="Price Details">
<e-ranges>
<e-range [dataSource]="data"></e-range>
</e-ranges>
<e-columns>
<e-column [width]=150></e-column>
<e-column [width]=110></e-column>
<e-column [width]=110></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj: SpreadsheetComponent | undefined;
data: object[] = dataSource;
created() {
// Applies style formatting to the active sheet before inserting a new sheet
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:H1');
this.spreadsheetObj!.cellFormat({ textAlign: 'center' }, 'D2:H11');
// inserting a new sheet with data at 1st index
// You can also insert empty sheets by specifying the start and end sheet index instead of sheet model
this.spreadsheetObj!.insertSheet([{
index: 1,
name: 'Inserted Sheet',
ranges: [{ dataSource: this.data }],
columns: [{ width: 150 }, { width: 110 }, { width: 110 }, { width: 85 }, { width: 85 }, { width: 85 }, { width: 85 },
{ width: 85 }]
}]);
// Applies style formatting for the inserted sheet
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'Inserted Sheet!A1:H1');
this.spreadsheetObj!.cellFormat({ textAlign: 'center' }, 'Inserted Sheet!D2:H11');
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Insert a sheet programmatically and make it active sheet
A sheet is a collection of cells organized in the form of rows and columns that allows you to store, format, and manipulate the data. Using insertSheet method, you can insert one or more sheets at the desired index. Then, you can make the inserted sheet as active sheet by focusing the start cell of that sheet using the goTo method.
The following code example shows how to insert a sheet programmatically and make it the active sheet.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { data, employeeData } from './datasource';
@Component({
imports: [
SpreadsheetModule
],
standalone: true,
selector: 'app-container',
template: `<div >
<button class="e-btn custom-btn" (click)='onClick()'>Insert Sheet</button>
<ejs-spreadsheet #spreadsheet >
<e-sheets>
<e-sheet name="Car Sales Report">
<e-ranges>
<e-range [dataSource]="dataSource"></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>
</div>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj!: SpreadsheetComponent;
dataSource: Object[] = data;
onClick(): void {
this.spreadsheetObj.insertSheet(
[
{
index: 1,
name: 'new_sheet',
ranges: [
{
dataSource: employeeData,
startCell: 'A1'
},
]
},
]
);
// Use the timeout function to wait until the sheet is inserted.
setTimeout(() => {
// Method for switching to a new sheet.
this.spreadsheetObj.goTo('new_sheet!A1');
})
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Delete sheet
The Spreadsheet has support for removing an existing worksheet. You can dynamically delete the existing sheet by the following way,
- Right-click on the sheet tab, and then select
Delete
option from context menu. - Using
delete
method to delete the sheets.
Rename sheet
You can dynamically rename an existing worksheet in the following way,
- Right-click on the sheet tab, and then select
Rename
option from the context menu.
Headers
By default, the row and column headers are visible in worksheets. You can dynamically show or hide worksheet headers by using one of the following ways,
- Switch to
View
tab, and then selectHide Headers
option to hide both the row and column headers. - Set
showHeaders
property insheets
astrue
orfalse
to show or hide the headers at initial load. By default, theshowHeaders
property is enabled in each worksheet.
Gridlines
Gridlines act as a border like appearance of cells. They are used to distinguish cells on the worksheet. You can dynamically show or hide gridlines by using one of the following ways,
- Switch to
View
tab, and then selectHide Gridlines
option to hide the gridlines in worksheet. - Set
showGridLines
property insheets
astrue
orfalse
to show or hide the gridlines at initial load. By default, theshowGridLines
property is enabled in each worksheet.
The following code example shows the headers and gridlines operation in spreadsheet.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { enableRipple } from '@syncfusion/ej2-base';
import { dataSource } from './datasource';
enableRipple(true);
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: `<ejs-spreadsheet #spreadsheet (created)="created()" [showFormulaBar]="false"
[showSheetTabs]="false">
<e-sheets>
<!-- Hiding the headers and gridlines in 'Price Details' sheet -->
<e-sheet [showGridLines]="false" [showHeaders]="false">
<e-ranges>
<e-range [dataSource]="data"></e-range>
</e-ranges>
<e-columns>
<e-column [width]=150></e-column>
<e-column [width]=110></e-column>
<e-column [width]=110></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj: SpreadsheetComponent | undefined;
data: object[] = dataSource;
created() {
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:H1');
this.spreadsheetObj!.cellFormat({ textAlign: 'center' }, 'D2:H11');
// The gridlines have been removed to set border for the range of cells
this.spreadsheetObj!.setBorder({ border: '1px solid #e0e0e0' }, 'A1:H11');
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Sheet visibility
Hiding a worksheet can help prevent unauthorized or accidental changes to your file.
There are three visibility state as like Microsoft Excel,
State | Description |
---|---|
Visible |
You can see the worksheet once the component is loaded. |
Hidden |
This worksheet is not visible, but you can unhide by selecting the sheet from List All Sheets dropdown menu. |
VeryHidden |
This worksheet is not visible and cannot be unhidden. Changing the state property to Visible is the only way to view this sheet. |
The following code example shows the three types of sheet visibility state.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SpreadsheetAllModule } from '@syncfusion/ej2-angular-spreadsheet'
import { Component, ViewChild } from '@angular/core';
import { SpreadsheetComponent } from '@syncfusion/ej2-angular-spreadsheet';
import { enableRipple } from '@syncfusion/ej2-base';
import { dataSource } from './datasource';
enableRipple(true);
@Component({
imports: [
SpreadsheetAllModule
],
standalone: true,
selector: 'app-container',
template: `<ejs-spreadsheet #spreadsheet (created)="created()" [openUrl]="openUrl"
[saveUrl]="saveUrl" [showFormulaBar]="false" [showRibbon]="false">
<e-sheets>
<!-- By default, state is set as 'visible'. We don’t need to said it in the sample. -->
<e-sheet name="Visible Sheet" state="Visible">
<e-ranges>
<e-range [dataSource]="data"></e-range>
</e-ranges>
<e-columns>
<e-column [width]=150></e-column>
<e-column [width]=110></e-column>
<e-column [width]=110></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
</e-columns>
</e-sheet>
<!-- Sets sheet state as 'VeryHidden'. It can't be unhidden. -->
<e-sheet name="Very Hidden Sheet" state="VeryHidden">
<e-ranges>
<e-range [dataSource]="data"></e-range>
</e-ranges>
<e-columns>
<e-column [width]=150></e-column>
<e-column [width]=110></e-column>
<e-column [width]=110></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
</e-columns>
</e-sheet>
<!-- Sets sheet state as 'Hidden'. It can be unhidden dynamically. -->
<e-sheet name="Hidden Sheet" state="Hidden">
<e-ranges>
<e-range [dataSource]="data"></e-range>
</e-ranges>
<e-columns>
<e-column [width]=150></e-column>
<e-column [width]=110></e-column>
<e-column [width]=110></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
<e-column [width]=85></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>`
})
export class AppComponent {
@ViewChild('spreadsheet')
spreadsheetObj: SpreadsheetComponent | undefined;
data: object[] = dataSource;
openUrl = 'https://services.syncfusion.com/angular/production/api/spreadsheet/open';
saveUrl = 'https://services.syncfusion.com/angular/production/api/spreadsheet/save'
created() {
// Applies style formatting to active visible sheet
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:H1');
this.spreadsheetObj!.cellFormat({ textAlign: 'center' }, 'D2:H11');
// Applies style formatting to active hidden sheet
this.spreadsheetObj!.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'Hidden Sheet!A1:H1');
this.spreadsheetObj!.cellFormat({ textAlign: 'center' }, 'Hidden Sheet!D2:H11');
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
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.