DataSource | @sheetwrite/core

Host callback that asynchronously loads cancellable rectangular pages.

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

Members 2

capabilities

readonly capabilities: DataSourceCapabilitiesinterface DataSourceCapabilities {
  protocol: 2;
  columns: "windowed" | "full-width";
}interface DataSourceCapabilities {
  protocol: 2;
  columns: "windowed" | "full-width";
}interface DataSourceCapabilities {
  protocol: 2;
  columns:
    "windowed" | "full-width";
}Declares whether a source can load only the requested column runs.API reference →;

getRows Loads the requested rows and columns; implementations should stop work when its signal aborts.

getRows(request: DataSourceRequestinterface DataSourceRequest {
  protocol: 2;
  sheet: SheetId;
  start: number;
  end: number;
  columns: readonly DataSourceColumnBand[];
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  protocol: 2;
  sheet: SheetId;
  start: number;
  end: number;
  columns: readonly DataSourceColumnBand[];
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  protocol: 2;
  sheet: SheetId;
  start: number;
  end: number;
  columns: readonly DataSourceColumnBand[];
  signal: AbortSignal;
  revision: number;
}Cancellable sheet rectangle requested from a DataSource.API reference →): Promise<DataSourcePageinterface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBand[];
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBand[];
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBand[];
  rows: RowData[];
  revision?: string | number;
}One resolved rectangular page returned by a DataSource.API reference →>;

Declaration

View full TypeScript declaration

export interface DataSource {
  readonly capabilities: DataSourceCapabilitiesinterface DataSourceCapabilities {
  protocol: 2;
  columns: "windowed" | "full-width";
}interface DataSourceCapabilities {
  protocol: 2;
  columns: "windowed" | "full-width";
}interface DataSourceCapabilities {
  protocol: 2;
  columns:
    "windowed" | "full-width";
}Declares whether a source can load only the requested column runs.API reference →;
  getRows(request: DataSourceRequestinterface DataSourceRequest {
  protocol: 2;
  sheet: SheetId;
  start: number;
  end: number;
  columns: readonly DataSourceColumnBand[];
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  protocol: 2;
  sheet: SheetId;
  start: number;
  end: number;
  columns: readonly DataSourceColumnBand[];
  signal: AbortSignal;
  revision: number;
}interface DataSourceRequest {
  protocol: 2;
  sheet: SheetId;
  start: number;
  end: number;
  columns: readonly DataSourceColumnBand[];
  signal: AbortSignal;
  revision: number;
}Cancellable sheet rectangle requested from a DataSource.API reference →): Promise<DataSourcePageinterface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBand[];
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBand[];
  rows: RowData[];
  revision?: string | number;
}interface DataSourcePage {
  protocol: 2;
  start: number;
  columns: readonly DataSourceColumnBand[];
  rows: RowData[];
  revision?: string | number;
}One resolved rectangular page returned by a DataSource.API reference →>;
}