@sheetwrite/core/adapterfunction
Applies live-updatable adapter option changes to an existing Grid.
- Package
@sheetwrite/core/adapter- Source
packages/core/src/adapter.ts#L145
Declaration
function applyChangedLiveGridOptions( controller: GridControllerinterface GridController {
readonly grid: Grid;
setTheme(theme: Partial<Theme> | undefined): void;
setReadOnly(readOnly: boolean): void;
setConfig(config: GridConfig | undefined): void;
setOverscan(overscan: number | undefined): void;
setMinColumns(minColumns: number | undefined): void;
destroy(): void;
}interface GridController {
readonly grid: Grid;
setTheme(theme: Partial<Theme> | undefined): void;
setReadOnly(readOnly: boolean): void;
setConfig(config: GridConfig | undefined): void;
setOverscan(overscan: number | undefined): void;
setMinColumns(minColumns: number | undefined): void;
destroy(): void;
}interface GridController {
readonly grid: Grid;
setTheme(
theme:
Partial<Theme> | undefined,
): void;
setReadOnly(
readOnly: boolean,
): void;
setConfig(
config:
GridConfig | undefined,
): void;
setOverscan(
overscan: number | undefined,
): void;
setMinColumns(
minColumns:
number | undefined,
// … 3 more lines — see the API reference
}The lifecycle handle returned by createGridController: the live grid, a theme passthrough, and a single teardown that detaches every subscription and destroys the grid.API reference →, previous: 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 →, next: 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 →,): void