DataSourceRequest | @sheetwrite/core

Cancellable sheet rectangle requested from a DataSource.

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

Members 7

protocol Paging contract version.

protocol: 2;

sheet

sheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;

start Inclusive row index.

start: number;

end Exclusive row index.

end: number;

columns Exact visible, frozen, or prefetched column runs required by the Grid.

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

signal

signal: AbortSignal;

revision

revision: number;

Declaration

View full TypeScript declaration

export interface DataSourceRequest {
  protocol: 2;
  sheet: SheetIdtype SheetId = string;type SheetId = string;type SheetId = string;Stable identifier used to address a workbook sheet.API reference →;
  start: number;
  end: 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 →[];
  signal: AbortSignal;
  revision: number;
}