Search results

Spreadsheet

Represents the Spreadsheet component.

<div id='spreadsheet'></div>
<script>
 var spreadsheetObj = new Spreadsheet();
 spreadsheetObj.appendTo('#spreadsheet');
</script>

Properties

activeSheetIndex

number

Specifies active sheet index in workbook.

<div id='Spreadsheet'></div>
new Spreadsheet({
     activeSheetIndex: 2
...
 }, '#Spreadsheet');

Defaults to 0

allowCellFormatting

boolean

It allows you to apply styles (font size, font weight, font family, fill color, and more) to the spreadsheet cells.

Defaults to true

allowChart

boolean

It allows you to insert the chart in spreadsheet.

Defaults to true

allowConditionalFormat

boolean

It allows you to apply conditional formatting to the sheet.

Defaults to true

allowDataValidation

boolean

It allows you to apply validation to the spreadsheet cells.

Defaults to true

allowDelete

boolean

It allows you to delete rows, columns and sheets from spreadsheet.

Defaults to true

allowEditing

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

allowFiltering

boolean

It allows to enable/disable filter and its functionalities.

Defaults to true

allowFindAndReplace

boolean

It allows to enable/disable find & replace with its functionalities.

Defaults to true

It allows to enable/disable Hyperlink and its functionalities.

Defaults to true

allowImage

boolean

It allows you to insert the image in spreadsheet.

Defaults to true

allowInsert

boolean

It allows you to insert rows, columns and sheets in to the spreadsheet.

Defaults to true

allowMerge

boolean

It allows you to merge the range of cells.

Defaults to true

allowNumberFormatting

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

allowOpen

boolean

It allows you to open an Excel file (.xlsx, .xls, and .csv) in Spreadsheet.

Defaults to true

allowResizing

boolean

If allowResizing is set to true, spreadsheet columns and rows can be resized.

Defaults to true

allowSave

boolean

It allows you to save Spreadsheet with all data as Excel file (.xlsx, .xls, and .csv).

Defaults to true

allowScrolling

boolean

It specifies whether the Spreadsheet should be rendered with scrolling or not. To customize the Spreadsheet scrolling behavior, use the scrollSettings property.

Defaults to true

allowSorting

boolean

It allows to enable/disable sort and its functionalities.

Defaults to true

allowUndoRedo

boolean

It allows to enable/disable undo and redo functionalities.

Defaults to true

allowWrap

boolean

It allows to enable/disable wrap text feature. By using this feature the wrapping applied cell text can wrap to the next line, if the text width exceeds the column width.

Defaults to true

cellStyle

CellStyleModel

Specifies the cell style options.

<div id='Spreadsheet'></div>
new Spreadsheet({
     ...
         cellStyle: { fontWeight: 'bold', fontSize: 12,
             fontStyle: 'italic', textIndent: '2pt'
             backgroundColor: '#4b5366', color: '#ffffff'
     },
     ...
 }, '#Spreadsheet');

Defaults to {}

cssClass

string

To specify a CSS class or multiple CSS class separated by a space, add it in the Spreadsheet root element. This allows you to customize the appearance of component.

<div id='spreadsheet'></div>
new Spreadsheet({
 cssClass: 'e-custom1 e-custom2',
 ...
}, '#spreadsheet');

Defaults to

definedNames

DefineNameModel[]

Specifies the name for a range and uses it in formula for calculation.

<div id='Spreadsheet'></div>
new Spreadsheet({
     ...
     definedNames: [{ name: 'namedRange1', refersTo: 'Sheet1!A1:B5' }],
     ...
 }, '#Spreadsheet');

Defaults to []

enableClipboard

boolean

It enables or disables the clipboard operations (cut, copy, and paste) of the Spreadsheet.

Defaults to true

enableContextMenu

boolean

It enables or disables the context menu option of spreadsheet. By default, context menu will opens for row header, column header, sheet tabs, and cell.

Defaults to true

enableKeyboardNavigation

boolean

It allows you to interact with cell, sheet tabs, formula bar, and ribbon through the keyboard device.

Defaults to true

enableKeyboardShortcut

boolean

It enables shortcut keys to perform Spreadsheet operations like open, save, copy, paste, and more.

Defaults to true

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

height

string | number

Defines the height of the Spreadsheet. It accepts height as pixels, number, and percentage.

<div id='Spreadsheet'></div>
new Spreadsheet({
     height: '550px'
...
 }, '#Spreadsheet');

Defaults to ‘100%’

isProtected

boolean

Specifies to protect the workbook.

Defaults to false

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to

openUrl

string

Specifies the service URL to open excel file in spreadsheet.

Defaults to

password

string

Specifies the password.

Defaults to

saveUrl

string

Specifies the service URL to save spreadsheet as Excel file.

Defaults to

scrollSettings

ScrollSettingsModel

Configures the scroll settings.

<div id='Spreadsheet'></div>
new Spreadsheet({
     scrollSettings: {
         isFinite: true,
         enableVirtualization: false
     }
...
 }, '#Spreadsheet');

The allowScrolling property should be true.

Defaults to { isFinite: false, enableVirtualization: true }

selectionSettings

SelectionSettingsModel

Configures the selection settings.

<div id='Spreadsheet'></div>
new Spreadsheet({
     selectionSettings: {
         mode: 'None'
     }
...
}, '#Spreadsheet');
The selectionSettings `mode` property has three values and it is described below:

* None: Disables UI selection.
* Single: Allows single selection of cell, row, or column and disables multiple selection.
* Multiple: Allows multiple selection of cell, row, or column and disables single selection.

Defaults to { mode: ‘Multiple’ }

sheets

SheetModel[]

Configures sheets and its options.

<div id='Spreadsheet'></div>
new Spreadsheet({
     sheets: [{
                 name: 'First Sheet',
                 range: [{ dataSource: data }],
                 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');

Defaults to []

showFormulaBar

boolean

It shows or hides the formula bar and its features.

Defaults to true

showRibbon

boolean

It shows or hides the ribbon in spreadsheet.

Defaults to true

showSheetTabs

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

width

string | number

Defines the width of the Spreadsheet. It accepts width as pixels, number, and percentage.

<div id='Spreadsheet'></div>
new Spreadsheet({
     width: '550px'
...
 }, '#Spreadsheet');

Defaults to ‘100%’

Methods

Unfreeze

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

addContextMenuItems

To add context menu items.

    <div id="spreadsheet"></div>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
import { closest } from '@syncfusion/ej2-base';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        contextMenuBeforeOpen: (args): void => {
           // To add context menu items in sheet content context menu.
           if(closest(args.event.target as Element, '.e-sheet-content')){
              spreadsheet.addContextMenuItems([{ text: 'Custom Item' }], 'Paste Special', false); //To pass the items, Item before / after that the element to be inserted, Set false if the items need to be inserted before the text.
           }
           // To add context menu items in column header context menu.
           else if(closest(args.event.target as Element, '.e-colhdr-table')){
              spreadsheet.addContextMenuItems([{ text: 'Custom Column' }], 'Insert Column', false);
           }
            // To add context menu items in row header context menu.
           else if(closest(args.event.target as Element, '.e-rowhdr-table')){
              spreadsheet.addContextMenuItems([{ text: 'Custom Row' }], 'Insert Row', false);
           }
            // To add context menu items in sheet tab context menu.
           else if(closest(args.event.target as Element, '.e-toolbar-item')){
              spreadsheet.addContextMenuItems([{ text: 'Custom tab' }], 'Insert', false);
           }
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');
Parameter Type Description
items MenuItemModel[] Items that needs to be added.
text string Item before / after that the element to be inserted.
insertAfter boolean Set false if the items need to be inserted before the text.
By default, items are added after the text.
isUniqueId (optional) boolean Set true if the given text is a unique id.

Returns void

addCustomFunction

To add custom library function.

   <div id="spreadsheet"></div>
   <button class="e-btn" id="btn">Add CustomFunction</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To add custom library function.
   spreadsheet.addCustomFunction("CustomFuntion", "SQRT"); //// Custom function handler name, Custom function name
};

(window as any).CustomFuntion = num => Math.sqrt(num);
Parameter Type Description
functionHandler string | Function Custom function handler name
functionName (optional) string Custom function name

Returns void

addDataValidation

This method is used to add data validation.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Add Data Validation</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To add the data validation
    spreadsheet.addDataValidation({ type: 'TextLength', operator: 'LessThanOrEqualTo', value1: '4' }, 'A2:A5'); // specifies the validation rules, range that needs to be add validation.// specifies the validation rules, range that needs to be add validation.
    spreadsheet.addDataValidation({ type: 'WholeNumber', operator: 'NotEqualTo', value1: '1' }, 'B2:B5');
    spreadsheet.addDataValidation({ type: 'Date', operator: 'NotEqualTo', value1: '04/11/2019' }, 'F2:F5');
    spreadsheet.addDataValidation({ type: 'Time', operator: 'Between', value1: '10:00:00 AM', value2: '11:00:00 AM' }, 'G2:G5');
    spreadsheet.addDataValidation({ type: 'Decimal', operator: 'LessThan', value1: '100000.00' }, 'H2:H5');
    spreadsheet.addDataValidation({ type: 'List', inCellDropDown: true, value1: '10, 20, 30' }, 'I2:I5'); // Specifies InCellDropDown option in Data Validation.
};
Parameter Type Description
rules ValidationModel specifies the validation rules like type, operator, value1, value2, ignoreBlank, inCellDropDown, isHighlighted arguments.
range (optional) string range that needs to be add validation.

Returns void

addDefinedName

Adds the defined name to the Spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Add Defined Name</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To provide name and range arguments in this method 
   spreadsheet.addDefinedName({name: 'value', refersTo: '=Sheet1!B2' });
};
Parameter Type Description
definedName DefineNameModel Specifies the name, scope, comment, refersTo.

Returns boolean

addEventListener

Adds the handler to the given event listener.

Returns void

addFileMenuItems

To add custom file menu items.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Add File Menu Items</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To add custom file menu items
   spreadsheet.addFileMenuItems([{ text: 'Print' }], 'Save As', false, false); //Specifies the ribbon file menu items to be inserted, text, Set `false` if the `items` need to be inserted before the `text`, isUniqueId? - Set `true` if the given file menu items `text` is a unique id
};
Parameter Type Description
items MenuItemModel[] Specifies the ribbon file menu items to be inserted.
text string Specifies the existing file menu item text before / after which the new file menu items to be inserted.
insertAfter boolean Set false if the items need to be inserted before the text.
By default, items are added after the text.
isUniqueId (optional) boolean Set true if the given file menu items text is a unique id.

Returns void

To add the hyperlink in the cell

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Add Hyperlink</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To add the hyperlink in the cell
   spreadsheet.addHyperlink("https://www.google.com/", "A5"); // hyperlink, address
};
Parameter Type Description
hyperlink string | HyperlinkModel to specify the hyperlink
address string to specify the address

Returns void

addInvalidHighlight

This method is used to highlight the invalid data.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Higlight Invalid Data</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
     //Highlight Invalid Data
  spreadsheet.addInvalidHighlight('A1:H5'); //range
};
Parameter Type Description
range (optional) string range that needs to be highlight the invalid data.

Returns void

addRibbonTabs

To add custom ribbon tabs.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Add Ribbon Tabs</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
     //To add custom ribbon tabs
  spreadsheet.addRibbonTabs([{ header: { text: 'Custom' }, content: [{ text: 'Custom', tooltipText: 'Custom Btn' }] }], 'Data'); // items , Specifies the existing ribbon header text before which the new tabs will be inserted.
};
Parameter Type Description
items RibbonItemModel[] Specifies the ribbon tab items to be inserted.
insertBefore (optional) string Specifies the existing ribbon header text before which the new tabs will be inserted.
If not specified, the new tabs will be inserted at the end.

Returns void

addToolbarItems

To add the custom items in Spreadsheet ribbon toolbar.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Add Toolbar Items</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
     //To add the custom items in Spreadsheet ribbon toolbar.
  spreadsheet.addToolbarItems('Home', [{ type: 'Separator' }, { text: 'Custom', tooltipText: 'Custom Btn' }], 15); // Specifies the ribbon tab header text under which the specified items will be inserted, Specifies the ribbon toolbar items that needs to be inserted, Specifies the index text before which the new items will be inserted.
};
Parameter Type Description
tab string Specifies the ribbon tab header text under which the specified items will be inserted.
items ItemModel[] Specifies the ribbon toolbar items that needs to be inserted.
index (optional) number Specifies the index text before which the new items will be inserted.
If not specified, the new items will be inserted at the end of the toolbar.

Returns void

appendTo

Appends the control within the given HTML Div element.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">AppendTo</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //Appends the control within the given HTML Div element.
    spreadsheet.appendTo('#spreadsheet'); // pass argument as selector of the element, here we passing selector(id) of the spreadsheet element
};
Parameter Type Description
selector string | HTMLElement Target element where control needs to be appended.

Returns void

applyFilter

Applies the filter UI in the range of cells in the sheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Apply Filter</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, PredicateModel, getCellIndexes, getColumnHeaderText, getCell } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
     //Applies the filter UI in the range of cells in the sheet.
    let sheet = spreadsheet.getActiveSheet();
    let cell = getCellIndexes(sheet.activeCell);
    let predicates: PredicateModel[] = [{
            field: getColumnHeaderText(cell[1] + 1),
            operator: 'equal',
            value: getCell(cell[0], cell[1], sheet).value, matchCase: false,
        }];
    spreadsheet.applyFilter(predicates, 'A1:F1');// predicates, range
};
Parameter Type Description
predicates (optional) PredicateModel[] Specifies the predicates.
range (optional) string Specify the range.

Returns void

autoFit

This method is used to autofit the range of rows or columns

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">AutoFit</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //This method is used to autofit the range of rows or columns
  spreadsheet.autoFit("D:F") //To autofit the column
  spreadsheet.autoFit("5:10"); // To autofit to rows
};
Parameter Type Description
range string range of rows or columns that needs to be autofit.

Returns void

cellFormat

Applies the style (font family, font weight, background color, etc…) to the specified range of cells.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Cell Format</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, CellStyleModel } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Applies the style (font family, font weight, background color, etc…) to the specified range of cells.
    spreadsheet.cellFormat({ fontWeight: 'bold', fontSize: '12pt', backgroundColor: '#279377', color: '#ffffff' }, 'A2:E2');
    // Setting common styles to whole table cells
    spreadsheet.cellFormat({ verticalAlign: 'middle', fontFamily: 'Axettac Demo' }, 'A2:E12');
    // Column wise styles setting
    spreadsheet.cellFormat({ textAlign: 'center' }, 'A2:A12');
    // Setting text-indent to 2 and 4 column
    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

clear

This method is used to Clear contents, formats and hyperlinks in spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Clear</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
  spreadsheet.clear({type: 'Clear Contents', range: 'A1:A10'}); // Clear the content in the provided range
  spreadsheet.clear({type: 'Clear Formats', range: 'A1:A10'}); // Clear the formats applied in the provided range
  spreadsheet.clear({type: 'Clear Hyperlinks', range: 'A1:A10'}); // Clear the hyperlinks applied in the provided range
  spreadsheet.clear({type: 'Clear All', range: 'B1:B10'}); // Clear the content, formats and hyperlinks applied in the provided range. 
};
Parameter Type Description
options ClearOptions Options for clearing the content, formats and hyperlinks in spreadsheet.

Returns void

clearConditionalFormat

This method is used for remove conditional formatting.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Clear Conditional Format</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // This method is used to remove conditional formatting.
  spreadsheet.clearConditionalFormat("A1:B5"); // range that needs to be remove conditional formatting.
  spreadsheet.clearConditionalFormat("Sheet1!A1:B5"); // you can also specify the range with sheetname.
};
Parameter Type Description
range (optional) string range that needs to be remove conditional formatting.

Returns void

clearFilter

Clears the filter changes of the sheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Clear Filter</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Clears the filter changes of the sheet.
    spreadsheet.clearFilter();
};
Parameter Type Description
field (optional) string Specify the field.

Returns void

closeEdit

Cancels the edited state, this will not update any value in the cell.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Close Edit</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Cancels the edited state, this will not update any value in the cell.
  spreadsheet.closeEdit();
};

Returns void

computeExpression

Used to compute the specified expression/formula.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Compute Expression</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Used to compute the specified expression/formula.
    spreadsheet.computeExpression('522+1'); // pass the  expression 
    spreadsheet.computeExpression('=SUM(F2:F3)'); //pass the formula as string.
};
Parameter Type Description
formula string Specifies the formula(=SUM(A1:A3)) or expression(2+3).

Returns string | number

conditionalFormat

This method is used to add conditional formatting.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Conditional Format</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // This method is used to add conditional formatting.
  spreadsheet.conditionalFormat({ type: 'BlueDataBar', range: 'D3:D18' });
  spreadsheet.conditionalFormat({ type: 'OrangeDataBar', range: 'E3:E18' });
  spreadsheet.conditionalFormat({ type: 'ThreeStars', range: 'F3:F18' });
};
Parameter Type Description
conditionalFormat ConditionalFormatModel Specify the conditionalFormat.

Returns void

copy

To copy the specified cell or cells properties such as value, format, style etc…

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Copy</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        sheets: [
            {
                name: 'Car Sales Report'
            }]
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    spreadsheet.copy(); //Copy the selected cell
    spreadsheet.copy('A2'); // specify the address
    spreadsheet.copy('Car Sales Report!B2')  // address with sheet name. 
};
Parameter Type Description
address (optional) string Specifies the range address.

Returns Promise

cut

To cut the specified cell or cells properties such as value, format, style etc…

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Cut</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        sheets: [
            {
                name: 'Car Sales Report'
            }]
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    spreadsheet.cut(); //cut the selected cell
    spreadsheet.cut('A2'); // specify the address
    spreadsheet.cut('Car Sales Report!B2')  // address with sheet name.
};
Parameter Type Description
address (optional) string Specifies the range address to cut.

Returns Promise

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

delete

Used to delete rows, columns and sheets from the spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Delete</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Used to delete rows, columns and sheets from the spreadsheet.
    spreadsheet.delete(1, 1, "Row", "Sheet1"); // start index of row/column, end index of row/column, Model type(Row, Column, Sheet), sheet(sheet name or index)
    spreadsheet.delete(2, 2, "Column", "Sheet1"); // start index of row/column, end index of row/column, Model type(Row, Column, Sheet), sheet(sheet name or index)
};
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) string 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

deleteChart

Used to delete the chart from spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Delete Image</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        created: (): void => {
            spreadsheet.insertChart([{ type: "Line", theme: "Material", isSeriesInRows: false, range: "A1", id: "Chart1"}]);
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

    document.getElementById("btn").onclick = () => {
     //Used to delete the chart from spreadsheet.
    spreadsheet.deleteChart("Chart1"); // id - Specifies the chart element id.
};
Parameter Type Description
id (optional) string Specifies the chart element id.

Returns void

deleteImage

Used to delete the image in spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Delete Image</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        created: (): void => {
            // Used to set the image in spreadsheet.
            spreadsheet.insertImage([{ src: "https://www.w3schools.com/images/w3schools_green.jpg", height: 400,
            width: 400 }], "A1"); // images - Specifies the options to insert image in spreadsheet, Specifies the range in spreadsheet.
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

    document.getElementById("btn").onclick = () => {
    //  Used to delete the image in spreadsheet.
    spreadsheet.deleteImage("spreadsheet_overlay_picture_1", "A3"); //id - Specifies the id of the image element to be deleted, range - Specifies the range in spreadsheet.
};
Parameter Type Description
id string Specifies the id of the image element to be deleted.
range (optional) string Specifies the range in spreadsheet.

Returns void

destroy

Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).

Returns void

duplicateSheet

Used to make a duplicate/copy of the sheet in the spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Duplicate Sheet</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Make a duplicate/copy of the active sheet in the spreadsheet.
    spreadsheet.duplicateSheet();
    // Make a duplicate/copy of the specified sheet in the spreadsheet.
    spreadsheet.duplicateSheet(1); // index of the sheet to be duplicated
};
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

enableContextMenuItems

To enable / disable context menu items.

    <div id="spreadsheet"></div>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        contextMenuBeforeOpen: (): void => {
            //To enable / disable context menu items.
          spreadsheet.enableContextMenuItems(['Copy'], false, false); // Contextmenu Items that needs to be enabled / disabled, Set true / false to enable / disable the menu items, Set true if the given text is a unique id.
          spreadsheet.enableContextMenuItems(['spreadsheet_cmenu_copy'], false, true); // Contextmenu id that needs to be enabled / disabled, Set true / false to enable / disable the menu items, Set true if the given text is a unique id.
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');
Parameter Type Description
items string[] Items that needs to be enabled / disabled.
enable boolean Set true / false to enable / disable the menu items.
isUniqueId (optional) boolean Set true if the given text is a unique id.

Returns void

enableFileMenuItems

To enable / disable file menu items.

    <div id="spreadsheet"></div>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        fileMenuBeforeOpen: (): void => {
            // To enable / disable file menu items.
          spreadsheet.enableFileMenuItems(['New'], false, true); //File menu Items that needs to be enabled / disabled, set `true` / `false` to enable / disable the menu items, set `true` if the   given file menu items `text` is a unique id.
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');
Parameter Type Description
items string[] Items that needs to be enabled / disabled.
enable boolean Set true / false to enable / disable the menu items.
isUniqueId (optional) boolean Set true if the given file menu items text is a unique id.

Returns void

enableRibbonTabs

To enable / disable the existing ribbon tabs.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Enable Ribbon Tabs</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To enable / disable the existing ribbon tabs.
  spreadsheet.enableRibbonTabs(['Home'], false); // tabs - Specifies the ribbon tab header text which needs to be enabled / disabled, Set `true` / `false` to enable / disable the ribbon tabs.
};
Parameter Type Description
tabs string[] Specifies the tab header text which needs to be enabled / disabled.
enable boolean Set true / false to enable / disable the ribbon tabs.

Returns void

enableToolbarItems

Enables or disables the specified ribbon toolbar items or all ribbon items.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Enable Toolbar Items</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To Enables or disables the specified ribbon toolbar items or all ribbon items
    spreadsheet.enableToolbarItems('Home', ['spreadsheet_line-through'], false); // Specifies the ribbon tab header text under which the toolbar items need to be enabled / disabled, Specifies the toolbar item indexes / unique id's which needs to be enabled / disabled, Boolean value that determines whether the toolbar items should be enabled or disabled.
    spreadsheet.enableToolbarItems('Home', [3, 4], false); // 3,4 - index
};
Parameter Type Description
tab string Specifies the ribbon tab header text under which the toolbar items need to be enabled / disabled.
items (optional) number[] | string[] Specifies the toolbar item indexes / unique id’s which needs to be enabled / disabled.
If it is not specified the entire toolbar items will be enabled / disabled.
enable (optional) boolean Boolean value that determines whether the toolbar items should be enabled or disabled.

Returns void

endEdit

If Spreadsheet is in editable state, you can save the cell by invoking endEdit.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">End Edit</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // If Spreadsheet is in editable state, you can save the cell by invoking endEdit.
    spreadsheet.endEdit();
};

Returns void

find

To find the specified cell value.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Find</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, FindOptions } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To find the specified cell value.
    let findOption: FindOptions = {
    value: "Jenna Schoolfield", sheetIndex: 1, findOpt: "next", mode: "Sheet", isCSen: false,
    isEMatch: false, searchBy: "By Row"
  };
    spreadsheet.find(findOption);
};
Parameter Type Description
args FindOptions Specifies the replace value with find args to replace specified cell value.

Returns void

findAll

To Find All the Match values Address within Sheet or Workbook.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">FindAll</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, FindOptions } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To Find All the Match values Address within Sheet or Workbook.
    spreadsheet.findAll('shoes', 'Sheet', false, false, spreadsheet.getActiveSheet().id); // Specifies the value to find, Specifies the value to be find within Sheet/Workbook, Specifies the find match with case sensitive or not, Specifies the find match with entire match or not,Specifies the sheetIndex
};
Parameter Type Description
value string Specifies the value to find.
mode (optional) string Specifies the value to be find within Sheet/Workbook.
isCSen (optional) boolean Specifies the find match with case sensitive or not.
isEMatch (optional) boolean Specifies the find match with entire match or not.
sheetIndex (optional) number Specifies the sheetIndex. If not specified, it will consider the active sheet.

Returns string[]

freezePanes

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

getData

Gets the range of data as JSON from the specified address.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Get Data</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Gets the range of data as JSON from the specified address.
    spreadsheet.getData("Sheet1!A1:B2").then(data => console.log(data)); // Specifies the address with sheet name for range of cells, Gets the range of data as JSON from the specified address
    spreadsheet.getData("A1:B2").then(data => console.log(data)); // Specifies the address for range of cells, Gets the range of data as JSON from the specified address
};
Parameter Type Description
address string Specifies the address for range of cells.

Returns Promise

getDisplayText

Gets the formatted text of the cell.

Parameter Type Description
cell CellModel Specifies the cell.
`html
<div id="spreadsheet"></div>
<button class="e-btn" id="btn">Get display text</button>
```ts
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, CellModel, getCell } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To Gets the formatted text of the cell.
   let cell: CellModel = getCell(0,0, spreadsheet.getActiveSheet()); // rowIndex, colIndex, sheetIndex
   console.log(spreadsheet.getDisplayText(cell)); // to provide the cell model
};
``` |

Returns *string*

### getLocalData

Returns the persistence data for component

Returns *any*

### getRootElement

Returns the route element of the component

Returns *HTMLElement*

### getSelectAllContent

Get the select all div of spreadsheet

Returns *HTMLElement*

### goTo

Used to navigate to cell address within workbook.
```html
    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Goto</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Used to navigate to cell address within workbook.
   spreadsheet.goTo("B1"); // pass the range
   spreadsheet.goTo("Sheet2!B1"); // You can specify the sheet name with cell address to navigate the specified cell address
};
Parameter Type Description
address string Specifies the cell address you need to navigate.
You can specify the address in two formats,
{sheet name}!{cell address} - Switch to specified sheet and navigate to specified cell address.
{cell address} - Navigate to specified cell address with in the active sheet.

Returns void

hideFileMenuItems

To show/hide the file menu items in Spreadsheet ribbon.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Hide File MenuItems</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To show/hide the file menu items in Spreadsheet ribbon.
   spreadsheet.hideFileMenuItems(['File'], true, true); // Specifies the file menu items text which is to be show/hide, Set `true` / `false` to hide / show the file menu items, set `true` if the given file menu items `text` is a unique id.
};
Parameter Type Description
items string[] Specifies the file menu items text which is to be show/hide.
hide boolean Set true / false to hide / show the file menu items.
isUniqueId (optional) boolean Set true if the given file menu items text is a unique id.

Returns void

hideRibbonTabs

To show/hide the existing ribbon tabs.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Hide Ribbon Tabs</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To show/hide the existing ribbon tabs.
  spreadsheet.hideRibbonTabs(['Formulas', 'Insert'], true); // specifies the ribbon tab header text which needs to be shown/hidden, Set `true` / `false` to hide / show the ribbon tabs.
};
Parameter Type Description
tabs string[] Specifies the tab header text which needs to be shown/hidden.
hide boolean Set true / false to hide / show the ribbon tabs.

Returns void

hideSpinner

To hide showed spinner manually.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Hide Spinner</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To hide showed spinner manually.
  spreadsheet.hideSpinner(); 
};

Returns void

hideToolbarItems

To show/hide the existing Spreadsheet ribbon toolbar items.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Hide Toolbar Items</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To show/hide the existing Spreadsheet ribbon toolbar items.
  spreadsheet.hideToolbarItems('Home', [0, 1, 2, 4, 14, 15, 22, 23, 24]); // tab name, index
  spreadsheet.hideToolbarItems('View', [1, 2]);
};
Parameter Type Description
tab string Specifies the ribbon tab header text under which the specified items needs to be hidden / shown.
indexes number[] Specifies the toolbar indexes which needs to be shown/hidden from UI.
hide boolean Set true / false to hide / show the toolbar items.

Returns void

insertChart

Used to set the chart in spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Insert Chart</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Used to set the chart in spreadsheet.
    spreadsheet.insertChart([{ type: "Line", theme: "Material", isSeriesInRows: false, range: "A1", id: "Chart1"}]); //Specifies the options to insert chart in spreadsheet.
};
Parameter Type Description
chart (optional) ChartModel[] Specifies the options to insert chart in spreadsheet.

Returns void

insertColumn

Used to insert columns in to the spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Insert Column</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To insert the column
 spreadsheet.insertColumn([{index: 1, width: 95}], 1); // startColumn (index, column width), endColumn
};
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

insertImage

Used to set the image in spreadsheet.

    <div id="spreadsheet"></div>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        created: (): void => {
            // Used to set the image in spreadsheet.
            spreadsheet.insertImage([{ src: "https://www.w3schools.com/images/w3schools_green.jpg", height: 400,
            width: 400 }], "A1"); // images - Specifies the options to insert image in spreadsheet, Specifies the range in spreadsheet.
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');
Parameter Type Description
images ImageModel[] Specifies the options to insert image in spreadsheet.
range (optional) string Specifies the range in spreadsheet.

Returns void

insertRow

Used to insert rows in to the spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Insert Row</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To insert the row
 spreadsheet.insertRow(4, 4); // startRow, endRow
};
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

insertSheet

Used to insert sheets in to the spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Insert Sheet</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To insert sheets in to the spreadsheet.
   spreadsheet.insertSheet(0, 2); // startSheet, endSheet
};
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

lockCells

Applies cell lock to the specified range of cells.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Lock Cells</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To Applies cell lock to the specified range of cells.
   let protectSetting:ProtectSettingsModel = {
    selectCells: true,
    formatCells: false,
    formatRows: false,
    formatColumns: false,
    insertLink: false
  }
  spreadsheet.protectSheet("Issues", protectSetting);
  spreadsheet.lockCells('A2:AZ100', false); // to unlock the A2:Az100 cells
  spreadsheet.lockCells('A1:Z1', true); // to lock the A1:Z1 cells
};
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

merge

Used to merge the range of cells.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Merge</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To merge the range of cells.
   spreadsheet.merge('B1:E2'); // to pass the range
};
Parameter Type Description
range (optional) string Specifies the range of cells as address.
type (optional) string 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

moveSheet

Used to move the sheets to the specified position in the list of sheets.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Move Sheet</button>
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        sheets: [{},{},{}]
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Moves the active sheet to the position in the list of sheets.
    spreadsheet.moveSheet(1); // position to move
    // Moves the list of specified sheets to the position in the list of sheets.
    spreadsheet.moveSheet(0, [1,2]); // position to move, indexes of the sheets to be moved
};
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

numberFormat

Applies the number format (number, currency, percentage, short date, etc…) to the specified range of cells.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Number Format</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, getFormatFromType } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    //To Applies the number format (number, currency, percentage, short date, etc…) to the specified range of cells.
    spreadsheet.numberFormat('$#,##0.00', 'E1:E3');
    // Applied Accounting format to the cells from C3 to E10 range.
    spreadsheet.numberFormat(getFormatFromType('Accounting'), 'C3:E10');
    // Applied Percentage format to the cells from F3 to F10 range in Sheet1.
    spreadsheet.numberFormat('0%', 'Sheet1!F3:F10');
};
Parameter Type Description
format string Specifies the number format code.
range (optional) string Specifies the address for the range of cells.

Returns void

open

Opens the Excel file.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Open</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        openUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/open',
        saveUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/save'
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To opens the Excel file.
    fetch("https://js.syncfusion.com/demos/ejservices/data/Spreadsheet/LargeData.xlsx")
    .then((response) => {
      response.blob().then((fileBlob) => {
        var file = new File([fileBlob], "Sample.xlsx");
        spreadsheet.open({ file: file });
      })
    })
};
Parameter Type Description
options OpenOptions Options for opening the excel file.

Returns void

openFromJson

Opens the specified JSON object.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="save">Save Json</button>
    <button class="e-btn" id="load">load Json</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';

    let response;
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        openUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/open',
        saveUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/save'
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("save").onclick = () => {
   spreadsheet.saveAsJson().then(Json => (response = Json)); 
};

document.getElementById("load").onclick = () => {
  spreadsheet.openFromJson({ file: response.jsonObject }); // To load JSON data in the Spreadsheet.
};

The available arguments in options are:

  • file: Specifies the spreadsheet model as object or string. And the object contains the jsonObject, which is saved from spreadsheet using saveAsJson method.
Parameter Type Description
options Object Options for opening the JSON object.

Returns void

paste

This method is used to paste the cut or copied cells in to specified address.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Paste</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To paste the cut or copied cells in to specified address.
    spreadsheet.paste(); //paste the selected cell
    spreadsheet.paste("B2", "All"); // to pass the range, Specifies the type of paste.
    spreadsheet.paste("B3", "Values"); // to pass the range, Specifies the type of paste.
    spreadsheet.paste("B4", "Formats"); // to pass the range, Specifies the type of paste.
    spreadsheet.paste("B5", "Formulas");// to pass the range, Specifies the type of paste.
};
Parameter Type Description
address (optional) string Specifies the cell or range address.
type (optional) string Specifies the type of paste.

Returns void

protectSheet

To protect the particular sheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Protect Sheet</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet, ProtectSettingsModel } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        sheets: [{ name: 'Car Sales Report'}],
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To protect the particular sheet.
    let protectSetting:ProtectSettingsModel = {
    selectCells: true,
    formatCells: false,
    formatRows: false,
    formatColumns: false,
    insertLink: false
  }
    spreadsheet.protectSheet('Car Sales Report',protectSetting); // To provide sheet name, protectSetting
};
Parameter Type Description
sheet (optional) number | string Specifies the sheet to protect.
protectSettings (optional) ProtectSettingsModel Specifies the protect sheet options.

Returns void

redo

To perform the redo operation in spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Redo</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To perform the redo operation in spreadsheet.
    spreadsheet.redo();
};

Returns void

refresh

Used to refresh the spreadsheet in UI level.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Refresh</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Used to refresh the spreadsheet
    spreadsheet.refresh(false); // specifies `true` / `false` to create new workbook in spreadsheet.
};
Parameter Type Description
isNew (optional) boolean Specifies true / false to create new workbook in spreadsheet.

Returns void

removeContextMenuItems

To remove existing context menu items.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Remove ContextMenu Items</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        // To remove existing context menu items.
        contextMenuBeforeOpen: (): void => {
          spreadsheet.removeContextMenuItems(["Cut"]); //Items that needs to be removed, Set `true` if the given `text` is a unique id.
        }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');
Parameter Type Description
items string[] Items that needs to be removed.
isUniqueId (optional) boolean Set true if the given text is a unique id.

Returns void

removeDataValidation

This method is used for remove validation.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Remove DataValidation</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // This method is used for remove validation.
   spreadsheet.removeDataValidation("A2:A5"); // to pass the range
};
Parameter Type Description
range (optional) string range that needs to be remove validation.

Returns void

removeDefinedName

Removes the defined name from the Spreadsheet.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Remove Defined Name</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To Removes the defined name from the Spreadsheet.
    spreadsheet.removeDefinedName({ name: 'value' , scope: 'Workbook'}); //Specifies the name, Specifies the scope of the defined name.
};
Parameter Type Description
definedName string Specifies the name.
scope string Specifies the scope of the defined name.

Returns boolean

removeEventListener

Removes the handler from the given event listener.

Returns void

To remove the hyperlink in the cell

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Remove Hyperlink</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To remove the hyperlink in the cell
   spreadsheet.removeHyperlink("A10"); // to pass the range
   spreadsheet.removeHyperlink("Sheet1!A1"); // you can also pass the range with sheet name
};
Parameter Type Description
range string To specify the range

Returns void

removeInvalidHighlight

This method is used for remove highlight from invalid data.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Remove InvalidHighlight</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To remove highlight from invalid data.
   spreadsheet.removeInvalidHighlight("A1:H5"); // to pass the range
};
Parameter Type Description
range (optional) string range that needs to be remove invalid highlight.

Returns void

replace

To replace the specified cell value.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Replace</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // To replace the specified cell value.
    spreadsheet.replace({replaceValue: '20', replaceBy: 'replace', value: '10'}); // Specifies the replace value with find args to replace specified cell value.
};
Parameter Type Description
args FindOptions Specifies the replace value with find args to replace specified cell value.

Returns void

resize

Used to resize the Spreadsheet.

    <div id="spreadsheet"></div>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

window.addEventListener('resize', onResize);

function onResize(): void {
    document.body.style.height = `${document.documentElement.clientHeight}px`;
    spreadsheet.resize();
}

Returns void

save

Saves the Spreadsheet data to Excel file.

The available arguments in saveOptions are:

  • url: Specifies the save URL.
  • fileName: Specifies the file name.
  • saveType: Specifies the file type need to be saved.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Save</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        openUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/open',
        saveUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/save'
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Saves the Spreadsheet data to Excel file.
   spreadsheet.save({ url: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/save', fileName: 'Worksheet', saveType: 'Xlsx' }); // Specifies the save URL, filename, file type need to be saved.
};
Parameter Type Description
saveOptions SaveOptions Options for saving the excel file.

Returns void

saveAsJson

Saves the Spreadsheet data as JSON object.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="save">Save Json</button>
    <button class="e-btn" id="load">load Json</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';

    let response;
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        openUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/open',
        saveUrl: 'https://ej2services.syncfusion.com/production/web-services/api/spreadsheet/save'
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("save").onclick = () => {
   spreadsheet.saveAsJson().then(Json => (response = Json)); // to save JSON data in Spreadsheet.
};

document.getElementById("load").onclick = () => {
  spreadsheet.openFromJson({ file: response.jsonObject }); // To load JSON data in the Spreadsheet.
};

Returns Promise

selectRange

Selects the cell / range of cells with specified address.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Select Range</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Selects the cell / range of cells with specified address.
  spreadsheet.selectRange("B7:B8");
};
Parameter Type Description
address string Specifies the range address.

Returns void

setBorder

Sets the border to specified range of cells.

    <div id="spreadsheet"></div>
    <button class="e-btn" id="btn">Set Border</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
    // Sets the border to specified range of cells.
    spreadsheet.setBorder({ border: '1px solid #000000' }, 'C6:G8', 'Outer'); // Specifies the style property which contains border value,Specifies the range of cell reference. If not specified, it will considered the active cell reference, Specifies the Border type
    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) string Specifies the range of cell reference. If not specified, it will considered the active cell reference.

Returns void

setColWidth

Set the width of column.

    <div id="spreadsheet"></div>
    <button id="btn">Set Column Width</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // set the width, column index and sheet index in arguments.
   spreadsheet.setColWidth(120, 2, 1);
};
Parameter Type Description
width number | string To specify the width
colIndex number To specify the colIndex
sheetIndex (optional) number To specify the sheetIndex

Returns void

setRowHeight

Set the height of row.

     <div id="spreadsheet"></div>
    <button id="btn">Set Row Height</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // set the height, row index and sheet index in arguments.
   spreadsheet.setRowHeight(40, 2, 1);
};
Parameter Type Description
height number | string Specifies height needs to be updated. If not specified, it will set the default height 20.
rowIndex number Specifies the row index. If not specified, it will consider the first row.
sheetIndex (optional) number Specifies the sheetIndex. If not specified, it will consider the active sheet.
edited (optional) boolean Specifies the boolean value.

Returns void

showSpinner

By default, Spreadsheet shows the spinner for all its actions. To manually show spinner you this method at your needed time.

     <div id="spreadsheet"></div>
    <button id="btn">Show Spinner</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // By default, Spreadsheet shows the spinner for all its actions. To manually show spinner you this method at your needed time.
   spreadsheet.showSpinner();
};

Returns void

sort

Sorts the range of cells in the active sheet.

     <div id="spreadsheet"></div>
    <button id="btn">Sort</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To perform sorting on multiple columns
   spreadsheet.sort({ containsHeader: true}, 'A1:H11'); // SortOptions(containsHeader, caseSensitive, sortDescriptors) , Range
};
Parameter Type Description
sortOptions (optional) SortOptions options for sorting.
range (optional) string address of the data range.

Returns Promise

startEdit

Start edit the active cell.

     <div id="spreadsheet"></div>
    <button id="btn">Start Edit</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // Start edit the active cell.
   spreadsheet.startEdit();
};

Returns void

undo

To perform the undo operation in spreadsheet.

     <div id="spreadsheet"></div>
    <button id="btn">Undo</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To perform the undo operation in spreadsheet.
   spreadsheet.undo();
};

Returns void

unprotectSheet

To unprotect the particular sheet.

     <div id="spreadsheet"></div>
    <button id="btn">UnprotectSheet</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To unprotect the particular sheet.
   spreadsheet.unprotectSheet("1"); // specify the sheet name to Unprotect.
   spreadsheet.unprotectSheet("Sheet1"); // specify the sheet name  to Unprotect.
};
Parameter Type Description
sheet (optional) number | string Specifies the sheet name or index to Unprotect.

Returns void

updateAction

To update the action which need to perform.

     <div id="spreadsheet"></div>
    <button id="btn">Update Action</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
        sheets: [
            {
                name: 'Car Sales Report'
            }]
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To update the action which need to perform.
   spreadsheet.updateAction({action: 'cellSave', eventArgs:{ value: 'Custom value', address: 'Car Sales Report!M2'}}); // acion name, event options.
   spreadsheet.updateAction({action: 'wrap', eventArgs:{ address: 'Car Sales Report!M2', wrap: true}});
};
Parameter Type Description
options CollaborativeEditArgs It describes an action and event args to perform.

Returns void

updateCell

To update a cell properties.

     <div id="spreadsheet"></div>
    <button id="btn">Update Cell</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To update a cell properties.
   spreadsheet.updateCell({ value: 'Custom Value' }, "A3"); //  to specify the cell value, range
   spreadsheet.updateCell({ value: 'Custom Value' }, "Sheet1!A3"); //to specify the cell value, range with sheet name.
};
Parameter Type Description
cell CellModel Cell properties.
address (optional) string Address to update.

Returns void

updateUndoRedoCollection

To update the undo redo collection in spreadsheet.

     <div id="spreadsheet"></div>
     <button id="customBtn" class="e-btn"> Add/remove Class</button>
     <style>
		.customClass.e-cell {
			background-color: red;
		}
	</style>
import { enableRipple, addClass, removeClass } from '@syncfusion/ej2-base';
import { Spreadsheet, getRangeIndexes } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    actionComplete: (args): void => {
        let actionEvents: any = args;
        if (actionEvents.eventArgs.action == "customCSS") {
          let Element: HTMLElement = spreadsheet.getCell(actionEvents.eventArgs.rowIdx, actionEvents.eventArgs.colIdx);
          if (actionEvents.eventArgs.requestType == "undo") {
            removeClass([Element], 'customClass'); // To remove the custom class in undo action
          }
          else {
            addClass([Element], 'customClass');// To add the custom class in redo action
          }
        }
      }
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');
    document.getElementById("customBtn").addEventListener('click', updateCollection);

function updateCollection() {
    let cell: string = spreadsheet.getActiveSheet().activeCell;
    let cellIdx: number[] = getRangeIndexes(cell);
    let Element: HTMLElement = spreadsheet.getCell(cellIdx[0], cellIdx[1]);
    if (!Element.classList.contains("customClass")) {
        addClass([Element], 'customClass'); // To add the custom class in active cell element
        spreadsheet.updateUndoRedoCollection({ eventArgs: { class: 'customClass', rowIdx: cellIdx[0], colIdx: cellIdx[1], action: 'customCSS' } }); // To update the undo redo collection
    }
}
Parameter Type Description
args Object options for undo redo.

Returns void

wrap

This method is used to wrap/unwrap the text content of the cell.

     <div id="spreadsheet"></div>
    <button id="btn">Wrap</button>
import { enableRipple } from '@syncfusion/ej2-base';
import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';
 
    //Initialize Spreadsheet component
    let spreadsheet: Spreadsheet = new Spreadsheet({
    });

    //Render initialized Spreadsheet component
    spreadsheet.appendTo('#spreadsheet');

document.getElementById("btn").onclick = () => {
   // To wrap/unwrap the text content of the cell.
   spreadsheet.wrap("B5", true); // address, set true if the text content of the cell to be wrapped.
};
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

Inject

Dynamically injects the required modules to the component.

Returns void

Events

actionBegin

EmitType<``BeforeCellFormatArgs|BeforeOpenEventArgs|BeforeSaveEventArgs|BeforeSelectEventArgs|BeforeSortEventArgs|CellEditEventArgs|MenuSelectEventArgs>

Triggers when the Spreadsheet actions (such as editing, formatting, sorting etc..) are starts.

<div id='Spreadsheet'></div>
new Spreadsheet({
      actionBegin: (args: BeforeCellFormatArgs|BeforeOpenEventArgs|BeforeSaveEventArgs|BeforeSelectEventArgs
                   |BeforeSortEventArgs|CellEditEventArgs|MenuSelectEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

actionComplete

EmitType<CellSaveEventArgs>|SaveCompleteEventArgs|Object

Triggers when the spreadsheet actions (such as editing, formatting, sorting etc..) gets completed.

<div id='Spreadsheet'></div>
new Spreadsheet({
      actionComplete: (args: SortEventArgs|CellSaveEventArgs|SaveCompleteEventArgs|Object) => {
      }
     ...
 }, '#Spreadsheet');

afterHyperlinkClick

EmitType<AfterHyperlinkArgs>

Triggers when the Hyperlink function gets completed.

<div id='Spreadsheet'></div>
new Spreadsheet({
      afterHyperlinkClick: (args: AfterHyperlinkArgs ) => {
      }
     ...
 }, '#Spreadsheet');

afterHyperlinkCreate

EmitType<AfterHyperlinkArgs>

Triggers after the hyperlink inserted.

<div id='Spreadsheet'></div>
new Spreadsheet({
      afterHyperlinkCreate: (args: afterHyperlinkArgs ) => {
      }
     ...
 }, '#Spreadsheet');

beforeCellFormat

EmitType<BeforeCellFormatArgs>

Triggers before the cell format applied to the cell.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeCellFormat: (args: BeforeCellFormatArgs) => {
      }
     ...
 }, '#Spreadsheet');

beforeCellRender

EmitType<CellRenderEventArgs>

Triggers before the cell appended to the DOM.

<div id='Spreadsheet'></div>
new Spreadsheet({
     beforeCellRender: (args: CellRenderEventArgs) => {
     }
     ...
 }, '#Spreadsheet');

beforeCellSave

EmitType<CellEditEventArgs>

Triggers when before the cell is saved.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeCellSave: (args: CellEditEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

beforeConditionalFormat

EmitType<ConditionalFormatEventArgs>

Triggers before apply or remove the conditional format from a cell in a range.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeConditionalFormat: (args: ConditionalFormatEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

beforeDataBound

EmitType<Object>

Triggers before the data is populated to the worksheet.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeDataBound: (args: Object) => {
      }
     ...
 }, '#Spreadsheet');

beforeHyperlinkClick

EmitType<BeforeHyperlinkArgs>

Triggers when the Hyperlink is clicked.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeHyperlinkClick: (args: BeforeHyperlinkArgs ) => {
      }
     ...
 }, '#Spreadsheet');

beforeHyperlinkCreate

EmitType<BeforeHyperlinkArgs>

Triggers before insert a hyperlink.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeHyperlinkCreate: (args: BeforeHyperlinkArgs ) => {
      }
     ...
 }, '#Spreadsheet');

beforeOpen

EmitType<BeforeOpenEventArgs>

Triggers before opening an Excel file.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeOpen: (args: BeforeOpenEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

beforeSave

EmitType<BeforeSaveEventArgs>

Triggers before saving the Spreadsheet as Excel file.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeSave: (args: BeforeSaveEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

beforeSelect

EmitType<BeforeSelectEventArgs>

Triggers before the cell or range of cells being selected.

<div id='Spreadsheet'></div>
new Spreadsheet({
     beforeSelect: (args: BeforeSelectEventArgs) => {
     }
     ...
 }, '#Spreadsheet');

beforeSort

EmitType<BeforeSortEventArgs>

Triggers before sorting the specified range.

<div id='Spreadsheet'></div>
new Spreadsheet({
      beforeSort: (args: BeforeSortEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

cellEdit

EmitType<CellEditEventArgs>

Triggers when the cell is being edited.

<div id='Spreadsheet'></div>
new Spreadsheet({
      cellEdit: (args: CellEditEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

cellEditing

EmitType<CellEditEventArgs>

Triggers every time a request is made to access cell information. This will be triggered when editing a cell.

<div id='Spreadsheet'></div>
new Spreadsheet({
      cellEditing: (args: CellEditEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

cellSave

EmitType<CellSaveEventArgs>

Triggers when the edited cell is saved.

<div id='Spreadsheet'></div>
new Spreadsheet({
      cellSave: (args: CellSaveEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

contextMenuBeforeClose

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before closing the context menu.

<div id='Spreadsheet'></div>
new Spreadsheet({
      contextMenuBeforeClose: (args: BeforeOpenCloseMenuEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

contextMenuBeforeOpen

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before opening the context menu and it allows customizing the menu items.

<div id='Spreadsheet'></div>
new Spreadsheet({
      contextMenuBeforeOpen: (args: BeforeOpenCloseMenuEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

contextMenuItemSelect

EmitType<MenuSelectEventArgs>

Triggers when the context menu item is selected.

<div id='Spreadsheet'></div>
new Spreadsheet({
      contextMenuItemSelect: (args: MenuSelectEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

created

EmitType<Event>

Triggers when the component is created.

<div id='Spreadsheet'></div>
new Spreadsheet({
      created: () => {
      }
     ...
 }, '#Spreadsheet');

dataBound

EmitType<Object>

Triggers when the data is populated in the worksheet.

<div id='Spreadsheet'></div>
new Spreadsheet({
      dataBound: (args: Object) => {
      }
     ...
 }, '#Spreadsheet');

dataSourceChanged

EmitType<DataSourceChangedEventArgs>

Triggers during data changes when the data is provided as dataSource in the Spreadsheet.

<div id='Spreadsheet'></div>
new Spreadsheet({
      dataSourceChanged: (args: DataSourceChangedEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

dialogBeforeOpen

EmitType<DialogBeforeOpenEventArgs>

Triggers before opening the dialog box.

<div id='Spreadsheet'></div>
new Spreadsheet({
      dialogBeforeOpen: (args: DialogBeforeOpenEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

fileMenuBeforeClose

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before closing the file menu.

<div id='Spreadsheet'></div>
new Spreadsheet({
      fileMenuBeforeClose: (args: BeforeOpenCloseMenuEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

fileMenuBeforeOpen

EmitType<BeforeOpenCloseMenuEventArgs>

Triggers before opening the file menu.

<div id='Spreadsheet'></div>
new Spreadsheet({
      fileMenuBeforeOpen: (args: BeforeOpenCloseMenuEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

fileMenuItemSelect

EmitType<MenuSelectEventArgs>

Triggers when the file menu item is selected.

<div id='Spreadsheet'></div>
new Spreadsheet({
      fileMenuItemSelect: (args: MenuSelectEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

openComplete

EmitType<Object>

Triggers when the spreadsheet importing gets completed.

<div id='Spreadsheet'></div>
new Spreadsheet({
      openComplete: (args: Object) => {
      }
     ...
 }, '#Spreadsheet');

openFailure

EmitType<OpenFailureArgs>

Triggers when the opened Excel file fails to load.

<div id='Spreadsheet'></div>
new Spreadsheet({
      openFailure: (args: OpenFailureArgs) => {
      }
     ...
 }, '#Spreadsheet');

queryCellInfo

EmitType<CellInfoEventArgs>

Triggered every time a request is made to access cell information.

<div id='Spreadsheet'></div>
new Spreadsheet({
     queryCellInfo: (args: CellInfoEventArgs) => {
     }
     ...
 }, '#Spreadsheet');

saveComplete

EmitType<SaveCompleteEventArgs>

Triggers after saving the Spreadsheet as Excel file.

<div id='Spreadsheet'></div>
new Spreadsheet({
      saveComplete: (args: SaveCompleteEventArgs) => {
      }
     ...
 }, '#Spreadsheet');

select

EmitType<SelectEventArgs>

Triggers after the cell or range of cells is selected.

<div id='Spreadsheet'></div>
new Spreadsheet({
     select: (args: SelectEventArgs) => {
     }
     ...
 }, '#Spreadsheet');

sortComplete

EmitType<SortEventArgs>

Triggers after sorting action is completed.

<div id='Spreadsheet'></div>
new Spreadsheet({
      sortComplete: (args: SortEventArgs) => {
      }
     ...
 }, '#Spreadsheet');
Contents
Contents