SimpleGridInput | @sheetwrite/core/adapter

Normalized workbook and columnar data produced from simple adapter props.

Package: @sheetwrite/core/adapter
Source: packages/core/src/adapter.ts#L273

Members 3

workbook

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 →;

data

data: ColumnarDatainterface ColumnarData {
  rowCount: number;
  columns: Record<string, ArrayLike<CellScalar | CellValue>>;
}interface ColumnarData {
  rowCount: number;
  columns: Record<string, ArrayLike<CellScalar | CellValue>>;
}interface ColumnarData {
  rowCount: number;
  columns: Record<
    string,
    ArrayLike<
      CellScalar | CellValue
    >
  >;
}Eager column-oriented values used to initialize a sheet.API reference →;

presentation Simple row-object input always opts into semantic data-grid presentation.

presentation: "data-grid";

Declaration

View full TypeScript declaration

export interface SimpleGridInput {
  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 →;
  data: ColumnarDatainterface ColumnarData {
  rowCount: number;
  columns: Record<string, ArrayLike<CellScalar | CellValue>>;
}interface ColumnarData {
  rowCount: number;
  columns: Record<string, ArrayLike<CellScalar | CellValue>>;
}interface ColumnarData {
  rowCount: number;
  columns: Record<
    string,
    ArrayLike<
      CellScalar | CellValue
    >
  >;
}Eager column-oriented values used to initialize a sheet.API reference →;
  presentation: "data-grid";
}