On this page
Framework-neutral simple columns, rows, sizing, and grid options.
Members 5
columns
defaultRows
defaultRows: readonly Row[];
sheetName
getRowId Opt-in stable data-row identity extractor.
getRowId?: (row: Row, index: number) => Id;
createRowId Optional identity factory for rows inserted by the Grid.
Declaration
View full TypeScript declaration
export interface SimpleSheetwriteOptions<
defaultRows: readonly Row[];
getRowId?: (row: Row, index: number) => Id;
Referenced by
Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency
@sheetwrite/docs-startdependency
@sheetwrite/reactdependency
@sheetwrite/sveltedependency
@sheetwrite/vuedependency
@sheetwrite/xlsxdependency
Public exports naming SimpleSheetwriteOptions
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;
}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 →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;
readonly maxRecentTransactions?: number;
}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;
readonly maxRecentTransactions?: number;
}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;
readonly maxRecentTransactions?: number;
}Options for the framework-neutral, opt-in row bridge.API reference →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 →type RowBridgeId = string | number;type RowBridgeId = string | number;type RowBridgeId =
string | number;A stable host identity for one data-space row.API reference →