API REFERENCE
importDataFromXlsx
Parses file bytes into a workbook and returns XlsxImportResult. Read the Grid snapshot from the xlsxImported event.
What does this API do?
Parses file bytes into a workbook and returns XlsxImportResult. Read the Grid snapshot from the xlsxImported event.
Exact input and result types
importDataFromXlsx(source: ArrayBuffer | Uint8Array, options?: { sheetName?: string; snapshot?: SheetToRowDataOptions }): Promise<XlsxImportResult>| Arguments | Required | Type |
|---|---|---|
| source | Required | ArrayBuffer | Uint8Array |
| options | Optional | { sheetName?: string; snapshot?: SheetToRowDataOptions } |
The return type is Promise<XlsxImportResult>.
Usage flow
After registering and initializing the Grid element, call grid.importDataFromXlsx(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
Feature explanations and examples
- Excel import
XLSX import reads a workbook and converts the selected sheet into a Grid column-and-row snapshot. The full parsed workbook and the display snapshot are different data.