GridReadyEvent | @sheetwrite/vue

Grid handle, generation, and reason published after adapter initialization.

Package: @sheetwrite/vue
Source: packages/core/dist/adapter.d.ts#L27

Members 3

grid Live handle just published by the adapter; replaced on the next reset generation.

grid: Gridinterface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(
    id: SheetId,
  ): void;
  scrollToCell(
    addr: CellAddress,
  ): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(
    row: number,
    col: number,
  ): CellInputSnapshot | null;
  getSelection(): Selection | null;
  // … 229 more lines — see the API reference
}Imperative grid handle for document commands, events, rendering, and teardown.API reference →;

generation One-based adapter generation, incremented whenever a Grid is replaced.

generation: number;

reason Whether readiness followed first initialization, an input reset, or a renderer reset.

reason: GridReadyReasontype GridReadyReason = "initial" | GridResetReason;type GridReadyReason = "initial" | GridResetReason;type GridReadyReason =
  "initial" | GridResetReason;Reason an adapter published a ready Grid generation.API reference →;

Declaration

View full TypeScript declaration

export interface GridReadyEvent {
  grid: Gridinterface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(id: SheetId): void;
  scrollToCell(addr: CellAddress): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(row: number, col: number): CellInputSnapshot | null;
  getSelection(): Selection | null;
  setSelection(sel: Selection | null): void;
  setTheme(theme: Partial<Theme>): void;
  replaceTheme(theme: Partial<Theme> | undefined): void;
  // … 106 more lines — see the API reference
}interface Grid {
  readonly store: Store;
  readonly actions: GridActions;
  setActiveSheet(
    id: SheetId,
  ): void;
  scrollToCell(
    addr: CellAddress,
  ): void;
  getCellAtPoint(
    clientX: number,
    clientY: number,
  ): CellAddress | null;
  getActiveSheet(): SheetId;
  getCellInput(
    row: number,
    col: number,
  ): CellInputSnapshot | null;
  getSelection(): Selection | null;
  // … 229 more lines — see the API reference
}Imperative grid handle for document commands, events, rendering, and teardown.API reference →;
  generation: number;
  reason: GridReadyReasontype GridReadyReason = "initial" | GridResetReason;type GridReadyReason = "initial" | GridResetReason;type GridReadyReason =
  "initial" | GridResetReason;Reason an adapter published a ready Grid generation.API reference →;
}