ExportSpreadsheetConfig

ExportSpreadsheetConfig:

type ExportSpreadsheetConfig =
  | { format: "xlsx" }
  | { format: "pdf"; sheet?: number };

Options for DocAuthSpreadsheet.export.

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

Export formats are for handing the spreadsheet to other software. To keep a spreadsheet in the format it can be reopened from without loss, use DocAuthSpreadsheet.saveSpreadsheet.

Experimental

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

Type Declaration

{ format: "xlsx"; }

format

readonly format: "xlsx"

{ format: "pdf"; sheet?: number; }

format

readonly format: "pdf"

sheet?

readonly optional sheet: number

Which sheet to print, 0-based. Leave it out for every visible sheet, in spreadsheet order, as one document; hidden sheets print only when named here. An index with no sheet makes the export reject.

An editor exporting what a user is looking at passes DocAuthSpreadsheetEditor.activeSheet.

Example

// What a download menu offers
const formats = [
  { label: 'Excel (.xlsx)', config: { format: 'xlsx' } },
  { label: 'PDF', config: { format: 'pdf' } },
] as const satisfies readonly { label: string; config: ExportSpreadsheetConfig }[];