@sheetwrite/coreinterface
Pluggable first-row-header, first-sheet table export backend.
- Package
@sheetwrite/core- Source
packages/core/src/export.ts#L271
Members 2
name
name: string;toXlsxTable
toXlsxTable(workbook: Workbook, store: Store, options?: XlsxWorkbookOptions): Promise<Uint8Array>(workbook: Workbook, store: Store, options?: XlsxWorkbookOptions): Promise<Uint8Array>(workbook: Workbook, store: Store, options?: XlsxWorkbookOptions): Promise<Uint8Array>Exports a table model through the registered optional XLSX backend.API reference →(workbook: Workbookinterface Workbook {
sheets: Sheet[];
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
}interface Workbook {
sheets: Sheet[];
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
}interface Workbook {
sheets: Sheet[];
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
}Live workbook schema containing ordered sheets and the active sheet ID.API reference →, store: Storeinterface Store {
getWorkbook(): Workbook;
getCell(addr: CellAddress): ResolvedCell;
getFormula(addr: CellAddress): string | null;
getRefTarget(addr: CellAddress): CellAddress | null;
recalculateVolatile(now?: Date): void;
getVisibleWindow(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
): VisibleWindowView;
getDataWindow?(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
// … 22 more lines — see the API reference
}interface Store {
getWorkbook(): Workbook;
getCell(addr: CellAddress): ResolvedCell;
getFormula(addr: CellAddress): string | null;
getRefTarget(addr: CellAddress): CellAddress | null;
recalculateVolatile(now?: Date): void;
getVisibleWindow(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
): VisibleWindowView;
getDataWindow?(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
// … 22 more lines — see the API reference
}interface Store {
getWorkbook(): Workbook;
getCell(
addr: CellAddress,
): ResolvedCell;
getFormula(
addr: CellAddress,
): string | null;
getRefTarget(
addr: CellAddress,
): CellAddress | null;
recalculateVolatile(
now?: Date,
): void;
getVisibleWindow(
sheet: SheetId,
rows: {
start: number;
end: number;
// … 53 more lines — see the API reference
}Columnar workbook storage, query, transaction, and subscription contract.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>;Declaration
View full TypeScript declaration
export interface XlsxTableExportBackend { name: string; toXlsxTable(workbook: Workbook, store: Store, options?: XlsxWorkbookOptions): Promise<Uint8Array>(workbook: Workbook, store: Store, options?: XlsxWorkbookOptions): Promise<Uint8Array>(workbook: Workbook, store: Store, options?: XlsxWorkbookOptions): Promise<Uint8Array>Exports a table model through the registered optional XLSX backend.API reference →( workbook: Workbookinterface Workbook {
sheets: Sheet[];
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
}interface Workbook {
sheets: Sheet[];
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
}interface Workbook {
sheets: Sheet[];
activeSheet: SheetId;
namedRanges?: NamedRangeSnapshot[];
}Live workbook schema containing ordered sheets and the active sheet ID.API reference →, store: Storeinterface Store {
getWorkbook(): Workbook;
getCell(addr: CellAddress): ResolvedCell;
getFormula(addr: CellAddress): string | null;
getRefTarget(addr: CellAddress): CellAddress | null;
recalculateVolatile(now?: Date): void;
getVisibleWindow(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
): VisibleWindowView;
getDataWindow?(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
// … 22 more lines — see the API reference
}interface Store {
getWorkbook(): Workbook;
getCell(addr: CellAddress): ResolvedCell;
getFormula(addr: CellAddress): string | null;
getRefTarget(addr: CellAddress): CellAddress | null;
recalculateVolatile(now?: Date): void;
getVisibleWindow(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
): VisibleWindowView;
getDataWindow?(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
// … 22 more lines — see the API reference
}interface Store {
getWorkbook(): Workbook;
getCell(
addr: CellAddress,
): ResolvedCell;
getFormula(
addr: CellAddress,
): string | null;
getRefTarget(
addr: CellAddress,
): CellAddress | null;
recalculateVolatile(
now?: Date,
): void;
getVisibleWindow(
sheet: SheetId,
rows: {
start: number;
end: number;
// … 53 more lines — see the API reference
}Columnar workbook storage, query, transaction, and subscription contract.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>;}