@sheetwrite/coretype
Grid creation options accepted when hydrating a validated snapshot.
- Package
@sheetwrite/core- Source
packages/core/src/persistence.ts#L19
Declaration
export type SnapshotGridOptions = Omit<GridOptionsinterface GridOptions {
workbook: Workbook;
data?: ColumnarData;
datasource?: DataSource;
datasourceStorage?: DataSourceStorageOptions;
renderer?: "canvas" | "worker";
workerUrl?: string | URL;
theme?: Partial<Theme>;
readOnly?: boolean;
protectionResolver?: ProtectionResolver;
mutationPolicy?: MutationPolicyMode;
transactionResourceLimits?: Partial<TransactionResourceLimits>;
renderers?: Record<string, CellRenderer>;
overscan?: number;
minColumns?: number;
// … 2 more lines — see the API reference
}interface GridOptions {
workbook: Workbook;
data?: ColumnarData;
datasource?: DataSource;
datasourceStorage?: DataSourceStorageOptions;
renderer?: "canvas" | "worker";
workerUrl?: string | URL;
theme?: Partial<Theme>;
readOnly?: boolean;
protectionResolver?: ProtectionResolver;
mutationPolicy?: MutationPolicyMode;
transactionResourceLimits?: Partial<TransactionResourceLimits>;
renderers?: Record<string, CellRenderer>;
overscan?: number;
minColumns?: number;
// … 2 more lines — see the API reference
}interface GridOptions {
workbook: Workbook;
data?: ColumnarData;
datasource?: DataSource;
datasourceStorage?: DataSourceStorageOptions;
renderer?: "canvas" | "worker";
workerUrl?: string | URL;
theme?: Partial<Theme>;
readOnly?: boolean;
protectionResolver?: ProtectionResolver;
mutationPolicy?: MutationPolicyMode;
transactionResourceLimits?: Partial<TransactionResourceLimits>;
renderers?: Record<
string,
CellRenderer
>;
overscan?: number;
minColumns?: number;
config?: GridConfig;
}Workbook, data, rendering, policy, and built-in UI options used to create a Grid.API reference →, "workbook" | "data"> & { snapshotResourceLimits?: Partial<SnapshotResourceLimitsinterface SnapshotResourceLimits {
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxMetadataEntries: number;
maxSerializedBytes: number;
maxLogicalCellsPerSheet: number;
maxDenseCells: number;
}interface SnapshotResourceLimits {
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxMetadataEntries: number;
maxSerializedBytes: number;
maxLogicalCellsPerSheet: number;
maxDenseCells: number;
}interface SnapshotResourceLimits {
maxSheets: number;
maxRowsPerSheet: number;
maxColumnsPerSheet: number;
maxMetadataEntries: number;
maxSerializedBytes: number;
maxLogicalCellsPerSheet: number;
maxDenseCells: number;
}Resource ceilings applied before snapshot normalization or store allocation.API reference →>;};