XlsxWorkbookBackend | @sheetwrite/core

Optional backend contract for complete workbook XLSX interchange.

Package: @sheetwrite/core
Source: packages/core/src/export.ts#L368

Members 3

name

name: string;

toXlsxWorkbook

toXlsxWorkbook(input: WorkbookSnapshot | Pick<Grid, "exportSnapshot">, options?: XlsxWorkbookOptions): Promise<Uint8Array>(input: WorkbookSnapshot | Pick<Grid, "exportSnapshot">, options?: XlsxWorkbookOptions): Promise<Uint8Array>(input: WorkbookSnapshot | Pick<Grid, "exportSnapshot">, options?: XlsxWorkbookOptions): Promise<Uint8Array>Formula-preserving, multi-sheet workbook export through the optional XLSX backend.API reference →(snapshot: WorkbookSnapshotinterface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}Schema-versioned serializable workbook document.API reference →, options?: XlsxWorkbookOptionsinterface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<
    Omit<
      XlsxResourceLimits,
      "maxCells"
    >
  >;
  onWarning?: (
    warning: XlsxWorkbookWarning,
  ) => void;
}Shared options passed to every registered table and workbook XLSX backend.API reference →): Promise<Uint8Array>;

fromXlsxWorkbook

fromXlsxWorkbook(data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptions): Promise<WorkbookSnapshot>(data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptions): Promise<WorkbookSnapshot>(data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptions): Promise<WorkbookSnapshot>Formula-preserving, multi-sheet workbook import through the optional XLSX backend.API reference →( data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptionsinterface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<
    Omit<
      XlsxResourceLimits,
      "maxCells"
    >
  >;
  onWarning?: (
    warning: XlsxWorkbookWarning,
  ) => void;
}Shared options passed to every registered table and workbook XLSX backend.API reference →, ): Promise<WorkbookSnapshotinterface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}Schema-versioned serializable workbook document.API reference →>;

Declaration

View full TypeScript declaration

export interface XlsxWorkbookBackend {
  name: string;
  toXlsxWorkbook(input: WorkbookSnapshot | Pick<Grid, "exportSnapshot">, options?: XlsxWorkbookOptions): Promise<Uint8Array>(input: WorkbookSnapshot | Pick<Grid, "exportSnapshot">, options?: XlsxWorkbookOptions): Promise<Uint8Array>(input: WorkbookSnapshot | Pick<Grid, "exportSnapshot">, options?: XlsxWorkbookOptions): Promise<Uint8Array>Formula-preserving, multi-sheet workbook export through the optional XLSX backend.API reference →(
    snapshot: WorkbookSnapshotinterface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}Schema-versioned serializable workbook document.API reference →,
    options?: XlsxWorkbookOptionsinterface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<
    Omit<
      XlsxResourceLimits,
      "maxCells"
    >
  >;
  onWarning?: (
    warning: XlsxWorkbookWarning,
  ) => void;
}Shared options passed to every registered table and workbook XLSX backend.API reference →,
  ): Promise<Uint8Array>;
  fromXlsxWorkbook(data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptions): Promise<WorkbookSnapshot>(data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptions): Promise<WorkbookSnapshot>(data: ArrayBuffer | Uint8Array, options?: XlsxWorkbookOptions): Promise<WorkbookSnapshot>Formula-preserving, multi-sheet workbook import through the optional XLSX backend.API reference →(
    data: ArrayBuffer | Uint8Array,
    options?: XlsxWorkbookOptionsinterface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<Omit<XlsxResourceLimits, "maxCells">>;
  onWarning?: (warning: XlsxWorkbookWarning) => void;
}interface XlsxWorkbookOptions {
  signal?: AbortSignal;
  maxCells?: number;
  resourceLimits?: Partial<
    Omit<
      XlsxResourceLimits,
      "maxCells"
    >
  >;
  onWarning?: (
    warning: XlsxWorkbookWarning,
  ) => void;
}Shared options passed to every registered table and workbook XLSX backend.API reference →,
  ): Promise<WorkbookSnapshotinterface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}interface WorkbookSnapshot {
  schemaVersion: 1;
  documentId?: string;
  version?: number;
  workbook: {
    activeSheet: SheetId;
    namedRanges?: NamedRangeSnapshot[];
  };
  sheets: SheetSnapshot[];
}Schema-versioned serializable workbook document.API reference →>;
}