ImportSpreadsheetConfig

ImportSpreadsheetConfig:

{
  fileName?: string;
  format?: SpreadsheetImportFileFormat;
  abortSignal?: AbortSignal;
  onProgress?: (progress: SpreadsheetImportProgress) => void;
}

Options for DocAuthSystem.importSpreadsheet.

Experimental: the spreadsheet API may change or be removed in any release, including minor and patch releases.

Examples

// Everything is optional; the content decides the format and the name only breaks ties
const spreadsheet = await system.importSpreadsheet(blob, { fileName: 'quarterly.xlsx' });

// Progress and cancellation together. Progress is per phase: `done` and `total` start again when it changes.
const controller = new AbortController();
const spreadsheet = await system.importSpreadsheet(file, {
  abortSignal: controller.signal,
  onProgress: ({ phase, done, total }) => showProgress(phase, total === null ? null : Math.min(1, done / total)),
});

Experimental

This API should not be used in production and may be trimmed from a public release.

Properties

fileName?

readonly optional fileName: string

A hint for detection when the content is ambiguous. The content decides; the name breaks ties.

---

format?

readonly optional format: SpreadsheetImportFileFormat

The format to read. The content is checked against it.

---

abortSignal?

readonly optional abortSignal: AbortSignal

Aborts the import. A cancelled import rejects; it never resolves with a partly-read spreadsheet.

---

onProgress()?

readonly optional onProgress: (progress) => void

Called while the spreadsheet opens, at most about ten times a second.

Not called at all for a file small enough to be read in one step, which covers most spreadsheets — so treat its absence as “still working”, not as “nothing is happening”, and show something of your own from the moment the import starts. An exception thrown from here does not fail the import.

Parameters

progress

SpreadsheetImportProgress

Returns

void