Options for the framework-neutral, opt-in row bridge.
Package @sheetwrite/core
Source packages/core/src/row-bridge.ts#L23
Members 5
columnsreadonly columns : readonly RowBridgeColumn interface RowBridgeColumn<Row extends Record<string, CellScalar>> {
readonly key: keyof Row & string;
} interface RowBridgeColumn < Row extends Record < string , CellScalar >> { readonly key : keyof Row & string ; } interface RowBridgeColumn < Row extends Record < string , CellScalar >, > { readonly key : keyof Row & string ; } Semantic column key accepted by the row bridge. API reference → < Row > [];
defaultRowsreadonly defaultRows : readonly Row[];
getRowIdreadonly getRowId : ( row : Row , index : number ) => Id;
sheet Sheet identity used by the simple data-first adapter. readonly sheet ?: SheetId type SheetId = string; type SheetId = string ; type SheetId = string ; Stable identifier used to address a workbook sheet. API reference → ; Sheet identity used by the simple data-first adapter. Defaults to `sheet1`.
createRowId Optional identity factory for rows created by an addRows operation. readonly createRowId ?: ( context : RowBridgeInsertContext interface RowBridgeInsertContext {
readonly sheet: SheetId;
readonly at: number;
readonly offset: number;
readonly transactionId: string;
} interface RowBridgeInsertContext { readonly sheet : SheetId ; readonly at : number ; readonly offset : number ; readonly transactionId : string ; } interface RowBridgeInsertContext { readonly sheet : SheetId ; readonly at : number ; readonly offset : number ; readonly transactionId : string ; } Context supplied when a canonical row insertion needs a host identity. API reference → ) => Id;
Declaration
View full TypeScript declaration
export interface RowBridgeOptions <
Row extends Record < string , CellScalar type 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 RowBridgeId type RowBridgeId = string | number; type RowBridgeId = string | number ; type RowBridgeId = string | number ; A stable host identity for one data-space row. API reference → = RowBridgeId type RowBridgeId = string | number; type RowBridgeId = string | number ; type RowBridgeId = string | number ; A stable host identity for one data-space row. API reference → , readonly columns : readonly RowBridgeColumn interface RowBridgeColumn<Row extends Record<string, CellScalar>> {
readonly key: keyof Row & string;
} interface RowBridgeColumn < Row extends Record < string , CellScalar >> { readonly key : keyof Row & string ; } interface RowBridgeColumn < Row extends Record < string , CellScalar >, > { readonly key : keyof Row & string ; } Semantic column key accepted by the row bridge. API reference → < Row >[]; readonly defaultRows : readonly Row [];
readonly getRowId : ( row : Row , index : number ) => Id ;
readonly sheet ?: SheetId type SheetId = string; type SheetId = string ; type SheetId = string ; Stable identifier used to address a workbook sheet. API reference → ; readonly createRowId ?: ( context : RowBridgeInsertContext interface RowBridgeInsertContext {
readonly sheet: SheetId;
readonly at: number;
readonly offset: number;
readonly transactionId: string;
} interface RowBridgeInsertContext { readonly sheet : SheetId ; readonly at : number ; readonly offset : number ; readonly transactionId : string ; } interface RowBridgeInsertContext { readonly sheet : SheetId ; readonly at : number ; readonly offset : number ; readonly transactionId : string ; } Context supplied when a canonical row insertion needs a host identity. API reference → ) => Id ;