SimpleSheetwriteOptions | @sheetwrite/core/adapter

Framework-neutral simple columns, rows, sizing, and grid options.

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

Members 5

columns

columns: readonly SimpleColumninterface SimpleColumn<Row extends Record<string, CellScalar>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}interface SimpleColumn<Row extends Record<string, CellScalar>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}interface SimpleColumn<
  Row extends Record<
    string,
    CellScalar
  >,
> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}Column definition accepted by the adapters’ simple row-object API.API reference →<Row>[];

defaultRows

defaultRows: readonly Row[];

sheetName

sheetName?: string;

getRowId Opt-in stable data-row identity extractor.

getRowId?: (row: Row, index: number) => Id;

createRowId Optional identity factory for rows inserted by the Grid.

createRowId?: RowBridgeOptionsinterface RowBridgeOptions<
  Row extends Record<string, CellScalar>,
  Id extends RowBridgeId = RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (row: Row, index: number) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (context: RowBridgeInsertContext) => Id;
}interface RowBridgeOptions<
  Row extends Record<string, CellScalar>,
  Id extends RowBridgeId = RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (row: Row, index: number) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (context: RowBridgeInsertContext) => Id;
}interface RowBridgeOptions<
  Row extends Record<
    string,
    CellScalar
  >,
  Id extends RowBridgeId =
    RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (
    row: Row,
    index: number,
  ) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (
    context: RowBridgeInsertContext,
  ) => Id;
}Options for the framework-neutral, opt-in row bridge.API reference →<Row, Id>["createRowId"];

Declaration

View full TypeScript declaration

export interface SimpleSheetwriteOptions<
  Row extends Record<string, CellScalartype CellScalar = string | number | boolean | null;type CellScalar = string | number | boolean | null;type CellScalar =
  | string
  | number
  | boolean
  | null;A scalar that can be displayed directly.API reference →>,
  Id extends RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
  string | number;A stable host identity for one data-space row.API reference → = RowBridgeIdtype RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
  string | number;A stable host identity for one data-space row.API reference →,
> {
  columns: readonly SimpleColumninterface SimpleColumn<Row extends Record<string, CellScalar>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}interface SimpleColumn<Row extends Record<string, CellScalar>> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}interface SimpleColumn<
  Row extends Record<
    string,
    CellScalar
  >,
> {
  key: keyof Row & string;
  title: string;
  width?: number;
  type?: CellFormat;
  numberFormat?: string;
  headerStyle?: CellStyle;
  editor?: string;
  cellStyle?: CellStyle;
  visible?: boolean;
}Column definition accepted by the adapters’ simple row-object API.API reference →<Row>[];
  defaultRows: readonly Row[];
  sheetName?: string;
  getRowId?: (row: Row, index: number) => Id;
  createRowId?: RowBridgeOptionsinterface RowBridgeOptions<
  Row extends Record<string, CellScalar>,
  Id extends RowBridgeId = RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (row: Row, index: number) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (context: RowBridgeInsertContext) => Id;
}interface RowBridgeOptions<
  Row extends Record<string, CellScalar>,
  Id extends RowBridgeId = RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (row: Row, index: number) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (context: RowBridgeInsertContext) => Id;
}interface RowBridgeOptions<
  Row extends Record<
    string,
    CellScalar
  >,
  Id extends RowBridgeId =
    RowBridgeId,
> {
  readonly columns: readonly RowBridgeColumn<Row>[];
  readonly defaultRows: readonly Row[];
  readonly getRowId: (
    row: Row,
    index: number,
  ) => Id;
  readonly sheet?: SheetId;
  readonly createRowId?: (
    context: RowBridgeInsertContext,
  ) => Id;
}Options for the framework-neutral, opt-in row bridge.API reference →<Row, Id>["createRowId"];
}