DataSourcePage | @sheetwrite/core

One resolved rectangular page returned by a DataSource.

Package: @sheetwrite/core
Source: packages/core/src/types/data.ts#L48

Members 5

protocol Paging contract version.

protocol: 2;

start Inclusive row index of the first returned row.

start: number;

columns Exact column runs represented by every returned row.

columns: readonly DataSourceColumnBandinterface DataSourceColumnBand {
  start: number;
  end: number;
  keys: readonly string[];
}interface DataSourceColumnBand {
  start: number;
  end: number;
  keys: readonly string[];
}interface DataSourceColumnBand {
  start: number;
  end: number;
  keys: readonly string[];
}One half-open run of workbook columns, in stable sheet order.API reference →[];

rows

rows: RowDatatype RowData = Record<string, DataCell>;type RowData = Record<string, DataCell>;type RowData = Record<
  string,
  DataCell
>;Object-shaped datasource row keyed by workbook column keys.API reference →[];

revision

revision?: string | number;

Declaration

View full TypeScript declaration

export interface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBandinterface DataSourceColumnBand {
  start: number;
  end: number;
  keys: readonly string[];
}interface DataSourceColumnBand {
  start: number;
  end: number;
  keys: readonly string[];
}interface DataSourceColumnBand {
  start: number;
  end: number;
  keys: readonly string[];
}One half-open run of workbook columns, in stable sheet order.API reference →[];
  rows: RowDatatype RowData = Record<string, DataCell>;type RowData = Record<string, DataCell>;type RowData = Record<
  string,
  DataCell
>;Object-shaped datasource row keyed by workbook column keys.API reference →[];
  revision?: string | number;
}