SheetwriteGridExpose | @sheetwrite/vue

Imperative Grid handle exposed by the Vue advanced component.

Package: @sheetwrite/vue
Source: packages/vue/src/index.ts#L46

Members 1

grid Live Grid after readiness, or null before initialization and during teardown.

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 → | null;

Declaration

View full TypeScript declaration

export interface SheetwriteGridExpose {
  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 → | null;
}