New to KendoReactStart a free 30-day trial

Represents the Spreadsheet handle object.

Definition

Package:@progress/kendo-react-spreadsheet

Properties

element

null | HTMLDivElement

The current element or null if there is no one.

Represents the SpreadsheetWidget object, holding the core functionality of the Spreadsheet.

The props values of the Spreadsheet.

Accessors

Returns the View object of the Spreadsheet.

Returns the Workbook object of the Spreadsheet.

Methods

Gets or sets the active sheet.

Parameters:sheet?SheetReturns:

void | Sheet

Executes the passed command against the selected cell/range.

Parameters:optionsany

An object containing the command name and the required by it options.

Clears the Spreadsheet and populates it with data from the specified Excel (.xlsx) file.

Parameters:fileBlob | File

Loads the workbook data from an object with the format that is defined in the configuration.

Note: All existing sheets and their data will be lost.

Parameters:jsonDocumentDescriptor

The object from where data will be loaded. This has to be the deserialized object, not the JSON string.

Re-renders all data in the Spreadsheet.

Initiates the Excel export. Also fires the excelExport event.

Note: Calling this method may trigger the built-in popup blocker of the browser. To avoid that, always call it as a response to an end-user action, for example, a button click.

Parameters:optionsany

Serializes the workbook. This method does not return the JSON, but a Promise object which will yield the JSON data when it is available. The method is functionally similar to toJSON, but it is also able to save the embedded images (this is the reason why it must be asynchronous).

Returns:

Promise​<DocumentDescriptor>

Returns an array with the sheets in the workbook.

Returns:

Sheet[]

Serializes the workbook.