Inbound hooks implemented by framework adapters for scheduling and imperative-handle publication.
Members 3
publish Resolves only after the imperative handle is visible to consumers. publish (grid: Grid | null ): void | Promise <void> ;
setInitializationStatesetInitializationState (state: "loading" | "ready" | "error" ): void ;
reportConsumerFailure Receives asynchronous construction or consumer failures unchanged. reportConsumerFailure (thrown: unknown): void ;
Receives asynchronous construction or consumer failures unchanged.
The value may be any thrown value, including a SheetwriteError from construction;
it is never reclassified as an initialization error.
Declaration
View full TypeScript declaration
export interface GridPublicationAdapter {
publish ( grid : Grid | null ) : void | Promise < void >; setInitializationState ( state : "loading" | "ready" | "error" ) : void ;
reportConsumerFailure ( thrown : unknown ) : void ;
Referenced by
Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency @sheetwrite/docs-startdependency @sheetwrite/reactdependency @sheetwrite/sveltedependency @sheetwrite/vuedependency @sheetwrite/xlsxdependency
Public exports naming GridPublicationAdapter
interface Grid {
readonly store: Store;
readonly actions: GridActions;
getRuntimeResourceSnapshot(
operation: RuntimeResourceOperation,
phase: RuntimeResourcePhase,
runtime?: RuntimeMemoryObservation,
): RuntimeResourceSnapshot;
getCommandState(command: GridCommandName): GridCommandState;
setActiveSheet(id: SheetId): void;
scrollToCell(addr: CellAddress): void;
getCellAtPoint(
clientX: number,
clientY: number,
): CellAddress | null;
// … 122 more lines — see the API reference
} interface Grid { readonly store : Store ; readonly actions : GridActions ; getRuntimeResourceSnapshot ( operation : RuntimeResourceOperation , phase : RuntimeResourcePhase , runtime ?: RuntimeMemoryObservation , ) : RuntimeResourceSnapshot ; getCommandState ( command : GridCommandName ) : GridCommandState ; setActiveSheet ( id : SheetId ) : void ; scrollToCell ( addr : CellAddress ) : void ; getCellAtPoint ( clientX : number , clientY : number , ) : CellAddress | null ; // … 122 more lines — see the API reference } interface Grid { readonly store : Store ; readonly actions : GridActions ; getRuntimeResourceSnapshot ( operation : RuntimeResourceOperation , phase : RuntimeResourcePhase , runtime ?: RuntimeMemoryObservation , ) : RuntimeResourceSnapshot ; getCommandState ( command : GridCommandName , ) : GridCommandState ; setActiveSheet ( id : SheetId , ) : void ; scrollToCell ( addr : CellAddress , ) : void ; getCellAtPoint ( clientX : number , // … 259 more lines — see the API reference } Imperative grid handle for document commands, events, rendering, and teardown. @example import type { Grid } from "@sheetwrite/core"; function updateTotal(grid: Grid) { const sheet = grid.getActiveSheet(); const result = grid.applyTransaction({ patches: [{ op: "set", addr: { sheet, row: 0, col: 0 }, value: { kind: "literal", value: 42 } }], }); if (result.status === "applied") grid.scrollToCell({ sheet, row: 0, col: 0 }); return grid.aggregate(0, "sum"); } @see createGrid @see Grid.applyTransaction API reference →