Represents the Workbook.
number
Specifies the active sheet index in the workbook.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
// Set 'Car Stock Report' sheet as active sheet.
activeSheetIndex: 1,
sheets: [
{
name: 'Car Sales Report'
},
{
name: 'Car Stock Report'
}
]
});
spreadsheet.appendTo('#spreadsheet');
Defaults to 0
boolean
It allows to enable/disable AutoFill functionalities.
Defaults to true
boolean
It allows you to apply styles (font size, font weight, font family, fill color, and more) to the spreadsheet cells.
Defaults to true
boolean
It allows you to insert the chart in a spreadsheet.
Defaults to true
boolean
It allows you to apply conditional formatting to the sheet.
Defaults to true
boolean
It allows you to apply data validation to the spreadsheet cells.
Defaults to true
boolean
It allows you to delete rows, columns, and sheets from a spreadsheet.
Defaults to true
boolean
It allows you to add new data or update existing cell data. If it is false, it will act as read only mode.
Defaults to true
boolean
It allows to enable/disable filter and its functionalities.
Defaults to true
boolean
It allows to enable/disable find and replace with its functionalities.
Defaults to true
boolean
It allows to enable/disable freeze pane functionality in spreadsheet.
Defaults to true
boolean
It allows to enable/disable Hyperlink and its functionalities.
Defaults to true
boolean
It allows you to insert the image in a spreadsheet.
Defaults to true
boolean
It allows you to insert rows, columns, and sheets into the spreadsheet.
Defaults to true
boolean
It allows you to merge the range of cells.
Defaults to true
boolean
It allows formatting a raw number into different types of formats (number, currency, accounting, percentage, short date, long date, time, fraction, scientific, and text) with built-in format codes.
Defaults to true
boolean
It allows you to open an Excel file (.xlsx, .xls, and .csv) in Spreadsheet.
Defaults to true
boolean
Enables or disables the printing functionality in the spreadsheet.
Defaults to true
boolean
It allows you to save Spreadsheet with all data as Excel file (.xlsx, .xls, and .csv).
Defaults to true
boolean
It allows to enable/disable sort and its functionalities.
Defaults to true
Configures the auto fill settings.
The autoFillSettings fillType
property has FOUR types and it is described below:
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
// Enable the autofill option.
allowAutoFill: true,
// Configure the autofill settings.
autoFillSettings: {
fillType: 'CopyCells',
showFillOptions: true
}
});
spreadsheet.appendTo('#spreadsheet');
The
allowAutoFill
property should betrue
.
Defaults to { fillType: ‘FillSeries’, showFillOptions: true }
Specifies the cell style options.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
cellStyle: {
fontWeight: 'bold',
fontSize: "12pt",
fontStyle: 'italic',
textIndent: '2pt',
backgroundColor: '#4b5366',
color: '#ffffff'
}
});
spreadsheet.appendTo('#spreadsheet');
Defaults to {}
Specifies the name of a range and uses it in a formula for calculation.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
// Set the specified cell range's name to 'Group1'.
definedNames: [{ name: 'Group1', refersTo: 'Sheet1!A1:B5' }]
});
spreadsheet.appendTo('#spreadsheet');
Defaults to []
boolean
Enables or disables the ability to add or show notes in the Spreadsheet. If the property is set to false, the Spreadsheet will not add notes in the cells and the notes in the existing cells will not be visible.
Defaults to true
boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
string
| number
Defines the height of the Spreadsheet. It accepts height as pixels, number, and percentage.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
height: '550px'
});
spreadsheet.appendTo('#spreadsheet');
Defaults to ‘100%’
boolean
Specifies to protect the workbook.
Defaults to false
string
Specifies the list separator which is used as the formula argument separator.
Defaults to ’,’
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ”
string
Specifies the service URL to open excel file in spreadsheet.
Defaults to ”
string
Specifies the password.
Defaults to ”
string
Specifies the service URL to save spreadsheet as Excel file.
Defaults to ”
Configures sheets and its options.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
import * as dataSource from './data.json';
let spreadsheet: Spreadsheet = new Spreadsheet({
// Specifies the sheets and its options.
sheets: [
{
name: 'First Sheet',
range: [{ dataSource: dataSource }],
rows: [
{
index: 5,
cells: [
{ index: 4, value: 'Total Amount:' },
{ formula: '=SUM(F2:F30)', style: { fontWeight: 'bold' } },
]
}
]
},
{
name: 'Second Sheet',
columns: [{ width: 180 }, { index: 4, width: 130 }],
}
]
});
spreadsheet.appendTo('#spreadsheet');
Defaults to []
boolean
It shows or hides the formula bar and its features.
Defaults to true
boolean
It shows or hides the ribbon in spreadsheet.
Defaults to true
boolean
It shows or hides the sheets tabs, this is used to navigate among the sheets and create or delete sheets by UI interaction.
Defaults to true
string
| number
Defines the width of the Spreadsheet. It accepts width as pixels, number, and percentage.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
// Specifies the width.
width: '550px'
});
spreadsheet.appendTo('#spreadsheet');
Defaults to ‘100%’
This method is used to unfreeze the frozen rows and columns from the active sheet.
Parameter | Type | Description |
---|---|---|
sheet (optional) | number | string |
Specifies the sheet name or index in which the unfreeze operation will perform. By default, active sheet will be considered. |
Returns void
To add custom library function.
Parameter | Type | Description |
---|---|---|
functionHandler | string | Function |
Custom function handler name |
functionName (optional) | string |
Custom function name |
formulaDescription (optional) | string |
Specifies formula description. |
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
created: (): void => {
// Add custom library function to compute the square root of a number.
spreadsheet.addCustomFunction('SQRTHandler', 'SQRT');
},
});
spreadsheet.appendTo('#spreadsheet');
(window as any).SQRTHandler = (num) => Math.sqrt(num);
``` |
Returns *void*
### addDefinedName
Adds the defined name to the Spreadsheet.
| Parameter | Type | Description |
|------|------|-------------|
| definedName | [`DefineNameModel`](./defineNameModel) | Specifies the name. |
Returns *boolean*
### addEventListener
Adds the handler to the given event listener.
| Parameter | Type | Description |
|------|------|-------------|
| eventName | `string` | A String that specifies the name of the event |
| handler | `Function` | Specifies the call to run when the event occurs. |
Returns *void*
### attachUnloadEvent
Adding unload event to persist data when enable persistence true
Returns *void*
### autoFill
Used to perform autofill action based on the specified range in spreadsheet.
| Parameter | Type | Description |
|------|------|-------------|
| fillRange | `string` | Specifies the fill range. |
| dataRange (*optional*) | `string` | Specifies the data range. |
| direction (*optional*) | [`AutoFillDirection`](./autoFillDirection) | Specifies the direction("Down","Right","Up","Left") to be filled. |
| fillType (*optional*) | [`AutoFillType`](./autoFillType) | Specifies the fill type("FillSeries","CopyCells","FillFormattingOnly","FillWithoutFormatting") for autofill action. |
Returns *void*
### calculateNow
The `calculateNow` method is used to calculate any uncalculated formulas in a spreadsheet.
This method accepts an option to specify whether the calculation should be performed for the entire workbook or a specific sheet.
Returns *Promise*
### cellFormat
Applies the style (font family, font weight, background color, etc...) to the specified range of cells.
```html
<div id="spreadsheet"></div>
<button id="apply-button">Apply Cell Format</button>
import { Spreadsheet, CellStyleModel } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Apply the styles to the cells in the specified range.
spreadsheet.cellFormat({ fontWeight: 'bold', fontSize: '12pt', backgroundColor: '#279377', color: '#ffffff' }, 'A2:E2');
spreadsheet.cellFormat({ verticalAlign: 'middle', fontFamily: 'Axettac Demo' }, 'A2:E12');
spreadsheet.cellFormat({ textAlign: 'center' }, 'A2:A12');
// Apply text-indent to 2nd & 4th columns.
let style: CellStyleModel = { textAlign: 'left', textIndent: '8pt' };
spreadsheet.cellFormat(style, 'B2:B12');
spreadsheet.cellFormat(style, 'D2:D12');
spreadsheet.cellFormat({ fontStyle: 'italic', textAlign: 'right' }, 'C3:C12');
spreadsheet.cellFormat({ textAlign: 'center' }, 'E2:E12');
};
Parameter | Type | Description |
---|---|---|
style | CellStyleModel |
Specifies the cell style. |
range (optional) | string |
Specifies the address for the range of cells. |
Returns void
This method is used to Clear contents, formats and hyperlinks in spreadsheet.
Parameter | Type | Description |
---|---|---|
options | ClearOptions |
Options for clearing the content, formats and hyperlinks in spreadsheet. |
Returns void
Used to compute the specified expression/formula.
<div id="spreadsheet"></div>
<button class="e-btn" id="apply-button">To Compute Expression</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Calculate the result of an arithmetic expression or formula.
spreadsheet.computeExpression('522+1');
spreadsheet.computeExpression('=SUM(F2:F3)');
};
Parameter | Type | Description |
---|---|---|
formula | string |
Specifies the formula(=SUM(A1:A3)) or expression(2+3). |
Returns string | number
When invoked, applies the pending property changes immediately to the component.
Returns void
Used to delete rows, columns and sheets from the spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Delete Row & Column</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// To delete rows, columns, and sheets with the specified index.
spreadsheet.delete(1, 1, "Row", "Sheet1");
spreadsheet.delete(2, 2, "Column", "Sheet1");
};
Parameter | Type | Description |
---|---|---|
startIndex (optional) | number |
Specifies the start sheet / row / column index. |
endIndex (optional) | number |
Specifies the end sheet / row / column index. |
model (optional) | ModelType |
Specifies the delete model type. By default, the model is considered as Sheet . The possible values are,- Row: To delete rows. - Column: To delete columns. - Sheet: To delete sheets. |
sheet (optional) | number | string |
Specifies the sheet name or index in which the delete operation will perform. By default, active sheet will be considered. It is applicable only for model type Row and Column. |
Returns void
Used to delete the chart from spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Delete Chart</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
created: (): void => {
// Insert a chart into a spreadsheet using the chart options specified.
spreadsheet.insertChart([{ type: "Line", theme: "Material", isSeriesInRows: false, range: "A1:B5", id: "Chart" }]);
}
});
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Delete the chart with the specified chart element ID from the spreadsheet.
spreadsheet.deleteChart("Chart");
};
Parameter | Type | Description |
---|---|---|
id (optional) | string |
Specifies the chart element id. |
Returns void
Destroys the Workbook library.
Returns void
Removing unload event to persist data when enable persistence true
Returns void
Used to make a duplicate/copy of the sheet in the spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Make Duplicate Sheet</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Make a duplicate/copy of the active sheet in the spreadsheet.
spreadsheet.duplicateSheet();
// Make a duplicate/copy of the specified sheet index in the spreadsheet.
spreadsheet.duplicateSheet(0);
};
Parameter | Type | Description |
---|---|---|
sheetIndex (optional) | number |
Specifies the index of the sheet to be duplicated. By default, the active sheet will be duplicated. |
Returns void
Filters the range of cells in the sheet.
Parameter | Type | Description |
---|---|---|
filterOptions (optional) | FilterOptions |
Specifies the filterOptions |
range (optional) | string |
Specifies the range |
Returns Promise
This method is used to freeze rows and columns after the specified cell in the Spreadsheet.
Parameter | Type | Description |
---|---|---|
row | number |
Specifies the freezed row count. |
column | number |
Specifies the freezed column count. |
sheet (optional) | number | string |
Specifies the sheet name or index in which the freeze operation will perform. By default, active sheet will be considered. |
Returns void
Gets the range of data as JSON from the specified address.
<div id="spreadsheet"></div>
<button id="apply-button">Get Data</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Return the specified cell address data as JSON.
spreadsheet.getData("Sheet1!A1:B2").then(data => console.log(data));
spreadsheet.getData("A1:B2").then(data => console.log(data));
};
Parameter | Type | Description |
---|---|---|
address | string |
Specifies the address for range of cells. |
Returns Promise
Gets the formatted text of the cell.
<div id="spreadsheet"></div>
<button id="apply-button">Get Display text</button>
import { Spreadsheet, CellModel, getCell } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Get the cell model for the given row, column, and sheet indexes.
let cell: CellModel = getCell(0, 0, spreadsheet.getActiveSheet());
// To get the formatted cell value, specify the cell model.
spreadsheet.getDisplayText(cell);
};
Parameter | Type | Description |
---|---|---|
cell | CellModel |
Specifies the cell. |
Returns string
Returns the persistence data for component
Returns any
Returns the route element of the component
Returns HTMLElement
Used to get a row data from the data source with updated cell value.
Parameter | Type | Description |
---|---|---|
index (optional) | number |
Specifies the row index. |
sheetIndex (optional) | number |
Specifies the sheet index. By default, it consider the active sheet index. |
Returns Object[]
Handling unload event to persist data when enable persistence true
Returns void
Used to hide/show the columns in spreadsheet.
Parameter | Type | Description |
---|---|---|
startIndex | number |
Specifies the start column index. |
endIndex | number |
Specifies the end column index. |
hide | boolean |
Set true / false to hide / show the columns. |
Returns void
Used to hide/show the rows in spreadsheet.
Parameter | Type | Description |
---|---|---|
startIndex | number |
Specifies the start row index. |
endIndex | number |
Specifies the end row index. |
hide | boolean |
To hide/show the rows in specified range. |
Returns void
Used to set the chart in spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Insert Chart</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Insert a chart into a spreadsheet using the chart options specified.
spreadsheet.insertChart([{ type: "Line", theme: "Material", isSeriesInRows: false, range: "A1", id: "Chart" }]);
};
Parameter | Type | Description |
---|---|---|
chart (optional) | ChartModel[] |
Specifies the options to insert chart in spreadsheet |
Returns void
Used to insert columns in to the spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Insert Column</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Insert the column at the starting column index specified.
spreadsheet.insertColumn([{ index: 1, width: 95 }], 1);
};
Parameter | Type | Description |
---|---|---|
startColumn (optional) | number | ColumnModel[] |
Specifies the start column index / column model which needs to be inserted. |
endColumn (optional) | number |
Specifies the end column index. |
sheet (optional) | number | string |
Specifies the sheet name or index in which the insert operation will perform. By default, active sheet will be considered. |
Returns void
Used to set the image in spreadsheet.
Parameter | Type | Description |
---|---|---|
images | ImageModel[] |
Specifies the options to insert image in spreadsheet. |
range (optional) | string |
Specifies the range in spreadsheet. |
Returns void
Used to insert rows in to the spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Insert Row</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Insert the row at the starting row index specified.
spreadsheet.insertRow(4, 4);
};
Parameter | Type | Description |
---|---|---|
startRow (optional) | number | RowModel[] |
Specifies the start row index / row model which needs to be inserted. |
endRow (optional) | number |
Specifies the end row index. |
sheet (optional) | number | string |
Specifies the sheet name or index in which the insert operation will perform. By default, active sheet will be considered. |
Returns void
Used to insert sheets in to the spreadsheet.
<div id="spreadsheet"></div>
<button id="apply-button">Insert Sheet</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Insert the sheet at the starting sheet index specified.
spreadsheet.insertSheet(0, 2);
};
Parameter | Type | Description |
---|---|---|
startSheet (optional) | number | SheetModel[] |
Specifies the start sheet index / sheet model which needs to be inserted. |
endSheet (optional) | number |
Specifies the end sheet index. |
Returns void
To determine whether the cell value in a data validation applied cell is valid or not.
Parameter | Type | Description |
---|---|---|
cellAddress (optional) | string |
Address of the cell. |
Returns boolean
Applies cell lock to the specified range of cells.
<div id="spreadsheet"></div>
<button id="apply-button">Lock Cells</button>
import { Spreadsheet, ProtectSettingsModel } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
//To protect the worksheet.
let protectSetting: ProtectSettingsModel = {
selectCells: true,
formatCells: false,
formatRows: false,
formatColumns: false,
insertLink: false
};
spreadsheet.protectSheet('Sheet1', protectSetting);
// To unlock the A2:AZ100 cell range.
spreadsheet.lockCells('A2:AZ100', false);
// To lock the A1:Z1 cell range.
spreadsheet.lockCells('A1:Z1', true);
};
Parameter | Type | Description |
---|---|---|
range (optional) | string |
Specifies the address for the range of cells. |
isLocked (optional) | boolean |
-Specifies the cell is locked or not. |
Returns void
Used to merge the range of cells.
<div id="spreadsheet"></div>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
created: (): void => {
// To merge the cells in the specified range.
spreadsheet.merge('B1:E2');
}
});
spreadsheet.appendTo('#spreadsheet');
Parameter | Type | Description |
---|---|---|
range (optional) | string |
Specifies the range of cells as address. |
type (optional) | MergeType |
Specifies the merge type. The possible values are, - All: Merge all the cells between provided range. - Horizontally: Merge the cells row-wise. - Vertically: Merge the cells column-wise. |
Returns void
Used to move the sheets to the specified position in the list of sheets.
<div id="spreadsheet"></div>
<button id="apply-button">Move Sheets</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
sheets: [{}, {}, {}]
});
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Moves the active sheet to the specified position.
spreadsheet.moveSheet(1);
// Moves the list of specified sheets to the specified position.
spreadsheet.moveSheet(0, [1, 2]);
};
Parameter | Type | Description |
---|---|---|
position | number |
Specifies the position to move a sheet in the list of sheets. |
sheetIndexes (optional) | number[] |
Specifies the indexes of the sheet to be moved. By default, the active sheet will be moved. |
Returns void
Applies the number format (number, currency, percentage, short date, etc…) to the specified range of cells.
<div id="spreadsheet"></div>
import { Spreadsheet, getFormatFromType } from '@syncfusion/ej2-spreadsheet';
import * as dataSource from './data.json';
let spreadsheet: Spreadsheet = new Spreadsheet({
sheets: [
{
name: 'Car Sales Report',
ranges: [{ dataSource: dataSource.salesData }]
},
],
created: (): void => {
// Apply the number format to the specified range of cells.
spreadsheet.numberFormat('$#,##0.00', 'E1:E3');
// Apply the accounting format to the specified range of cells.
spreadsheet.numberFormat(getFormatFromType('Accounting'), 'C3:E10');
// Apply the percentage format to the specified range of cells.
spreadsheet.numberFormat('0%', 'F3:F10');
}
});
spreadsheet.appendTo('#spreadsheet');
Parameter | Type | Description |
---|---|---|
format | string |
Specifies the number format code. |
range (optional) | string |
Specifies the address of the range of cells. |
Returns void
Opens the specified excel file or stream.
Parameter | Type | Description |
---|---|---|
options | OpenOptions |
Options for opening the excel file. |
Returns void
Opens the specified JSON object.
<div id="spreadsheet"></div>
<button id="save">Save JSON</button>
<button id="load">Load JSON</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let response: string;
let spreadsheet: Spreadsheet = new Spreadsheet({
openUrl: 'hhttps://services.syncfusion.com/js/production/api/spreadsheet/open',
saveUrl: 'https://services.syncfusion.com/js/production/api/spreadsheet/save'
});
spreadsheet.appendTo('#spreadsheet');
document.getElementById("save").onclick = () => {
// Save the spreadsheet data as JSON.
spreadsheet.saveAsJson().then(Json => (response = Json));
};
document.getElementById("load").onclick = () => {
// Load the JSON data to the spreadsheet.
spreadsheet.openFromJson({ file: response.jsonObject });
};
The available arguments in options are:
openComplete
event or not.Parameter | Type | Description |
---|---|---|
options | Object |
Options for opening the JSON object. |
jsonConfig (optional) | SerializationOptions |
Specify the serialization options to customize the loading of the JSON data. |
Returns void
Protect the active sheet based on the protect sheetings.
Parameter | Type | Description |
---|---|---|
sheet (optional) | number | string |
Specifies the sheet to protect. |
protectSettings (optional) | ProtectSettingsModel |
Specifies the protect settings of the sheet. |
password (optional) | string |
Specifies the password to protect |
Returns void
Applies all the pending property changes and render the component again.
Returns void
Removes the defined name from the Spreadsheet.
Parameter | Type | Description |
---|---|---|
definedName | string |
Specifies the name. |
scope | string |
Specifies the scope of the defined name. |
Returns boolean
Removes the handler from the given event listener.
Parameter | Type | Description |
---|---|---|
eventName | string |
A String that specifies the name of the event to remove |
handler | Function |
Specifies the function to remove |
Returns void
Saves the Spreadsheet data to Excel file.
<div id="spreadsheet"></div>
<button id="apply-button">To Save</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
openUrl: 'https://services.syncfusion.com/js/production/api/spreadsheet/open',
saveUrl: 'https://services.syncfusion.com/js/production/api/spreadsheet/save'
});
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Save the spreadsheet data to an Excel file with the filename and extension you specify.
spreadsheet.save({ url: 'https://services.syncfusion.com/js/production/api/spreadsheet/save', fileName: 'Worksheet', saveType: 'Xlsx' });
};
The available arguments in saveOptions are:
Parameter | Type | Description |
---|---|---|
saveOptions | SaveOptions |
Options for saving the excel file. |
jsonConfig (optional) | SerializationOptions |
Specify the serialization options to customize the JSON output. |
Returns void
Saves the Spreadsheet data as JSON object.
<div id="spreadsheet"></div>
<button id="save">Save JSON</button>
<button id="load">Load JSON</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let response: String;
let spreadsheet: Spreadsheet = new Spreadsheet({
openUrl: 'https://services.syncfusion.com/js/production/api/spreadsheet/open',
saveUrl: 'https://services.syncfusion.com/js/production/api/spreadsheet/save'
});
spreadsheet.appendTo('#spreadsheet');
document.getElementById("save").onclick = () => {
// Save the spreadsheet data as JSON.
spreadsheet.saveAsJson().then(Json => (response = Json));
};
document.getElementById("load").onclick = () => {
// Load the JSON data to the spreadsheet.
spreadsheet.openFromJson({ file: response.jsonObject });
};
Parameter | Type | Description |
---|---|---|
jsonConfig (optional) | SerializationOptions |
Specify the serialization options to customize the JSON output. |
Returns Promise
Sets the border to specified range of cells.
<div id="spreadsheet"></div>
<button id="apply-button">Set Border</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("apply-button").onclick = () => {
// Sets the border to the specified cell range.
spreadsheet.setBorder({ border: '1px solid #000000' }, 'C6:G8', 'Outer');
spreadsheet.setBorder({ border: '1px solid #000000' });
};
Parameter | Type | Description |
---|---|---|
style | CellStyleModel |
Specifies the style property which contains border value. |
range (optional) | string |
Specifies the range of cell reference. If not specified, it will considered the active cell reference. |
type (optional) | BorderType |
Specifies the range of cell reference. If not specified, it will considered the active cell reference. |
isUndoRedo (optional) | boolean |
Specifies is undo redo or not. |
Returns void
Sorts the range of cells in the active Spreadsheet.
Parameter | Type | Description |
---|---|---|
sortOptions (optional) | SortOptions |
options for sorting. |
range (optional) | string |
address of the data range. |
previousSort (optional) | SortCollectionModel[] |
specifies previous sort collection. |
Returns Promise
Used to split the merged cell into multiple cells.
<div id="spreadsheet"></div>
<button id="apply-button">UnMerge Cells</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet({
created: (): void => {
spreadsheet.merge('B1:E2');
},
});
spreadsheet.appendTo('#spreadsheet');
document.getElementById('apply-button').onclick = () => {
//To split the merged cell into multiple cells.
spreadsheet.unMerge('B1:E2');
};
Parameter | Type | Description |
---|---|---|
range (optional) | string |
Specifies the range of cells as address. |
Returns void
This method is used to unfreeze the frozen rows and columns from spreadsheet.
Parameter | Type | Description |
---|---|---|
sheet (optional) | number | string |
Specifies the sheet name or index in which the unfreeze operation will perform. By default, active sheet will be considered. |
Returns void
Unprotect the active sheet.
Parameter | Type | Description |
---|---|---|
sheet | number | string |
Specifies the sheet to Unprotect. |
Returns void
To update a cell properties.
Parameter | Type | Description |
---|---|---|
cell | CellModel |
Cell properties. |
address (optional) | string |
Address to update. |
Returns void
This method is used to update the Range property in specified sheet index.
Returns void
This method is used to wrap/unwrap the text content of the cell.
<div id="spreadsheet"></div>
<button id="wrap">To Wrap</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
let spreadsheet: Spreadsheet = new Spreadsheet();
spreadsheet.appendTo('#spreadsheet');
document.getElementById("wrap").onclick = () => {
// To wrap/unwrap the cell's text content with the specified address.
spreadsheet.wrap("B5", true);
};
Parameter | Type | Description |
---|---|---|
address | string |
Address of the cell to be wrapped. |
wrap | boolean |
Set false if the text content of the cell to be unwrapped. |
Returns void
Dynamically injects the required modules to the component.
Parameter | Type | Description |
---|---|---|
moduleList | Function[] |
? |
Returns void
EmitType<BeforeCellFormatArgs>
Triggers before the cell format applied to the cell.
<div id='Spreadsheet'></div>
new Spreadsheet({
beforeCellFormat: (args: BeforeCellFormatArgs) => {
}
...
}, '#Spreadsheet');
EmitType<BeforeCellUpdateArgs>
Triggers before changing any cell properties.
<div id='Spreadsheet'></div>
new Spreadsheet({
beforeCellUpdate: (args: BeforeCellUpdateArgs) => {
}
...
}, '#Spreadsheet');
Triggers before opening an Excel file.
<div id='Spreadsheet'></div>
new Spreadsheet({
beforeOpen: (args: BeforeOpenEventArgs) => {
}
...
}, '#Spreadsheet');
Triggers before saving the Spreadsheet as Excel file.
<div id='Spreadsheet'></div>
new Spreadsheet({
beforeSave: (args: BeforeSaveEventArgs) => {
}
...
}, '#Spreadsheet');
Triggers when the opened Excel file fails to load.
<div id='Spreadsheet'></div>
new Spreadsheet({
openFailure: (args: OpenFailureArgs) => {
}
...
}, '#Spreadsheet');
Triggered every time a request is made to access cell information.
<div id='Spreadsheet'></div>
new Spreadsheet({
queryCellInfo: (args: CellInfoEventArgs) => {
}
...
}, '#Spreadsheet');
EmitType<SaveCompleteEventArgs>
Triggers after saving the Spreadsheet as Excel file.
<div id='Spreadsheet'></div>
new Spreadsheet({
saveComplete: (args: SaveCompleteEventArgs) => {
}
...
}, '#Spreadsheet');