Class SpreadsheetModule

A loaded WebSheets engine module, driven through its stable, versioned C ABI (wsheet_sdk_*). SpreadsheetModule.attach asserts the ABI version, forwards any license/host-device option, and installs the device-lifecycle hooks. The workbook facade is SpreadsheetModule.spreadsheets.

const wasm = await createSpreadsheetsEngine();     // the host loads the Emscripten factory
const engine = await SpreadsheetModule.attach(wasm);
const book = await engine.spreadsheets.create();
const viewport = (await engine.createViewport(canvas)).start();

Implements

Index

Properties

`Readonly`device

device: GpuDevice

The engine's WebGPU device, adapter, queue, and readiness lifecycle.

`Readonly`poisonDestroyed

poisonDestroyed: boolean

Whether destroyed wrappers are poisoned (see AttachOptions.poisonDestroyed).

Accessors

spreadsheets

get spreadsheets(): SpreadsheetEngine
The workbook facade of this engine build.

Returns SpreadsheetEngine
- Defined in src/spreadsheets/module.ts:103

Methods

`Static`attach

attach(
wasm: SpreadsheetWasm,
options?: AttachOptions,
): Promise<SpreadsheetModule>
Attach the SDK to a loaded WebSheets engine module. Asserts the ABI version (a hard failure on mismatch — there is no downgrade) and shares a host device if given.
Parameters
- wasm: SpreadsheetWasm
- options: AttachOptions = {}
Returns Promise<SpreadsheetModule>
- Defined in src/spreadsheets/module.ts:88

createViewport

createViewport(
canvas: HTMLCanvasElement | OffscreenCanvas,
options?: ViewportOptions,
): Promise<Viewport>
Attach a live WebGPU view to a host canvas. The engine presents to it through the swapchain; resize and device-pixel-ratio are handled by the returned Viewport. A workbook must be open first.
Parameters
- canvas: HTMLCanvasElement | OffscreenCanvas
- options: ViewportOptions = {}
Returns Promise<Viewport>
Implementation of EngineModule.createViewport
- Defined in src/spreadsheets/module.ts:112

detach

detach(): void
Close the workbook, detach every viewport, and restore the global device hooks.

Returns void
Implementation of EngineModule.detach
- Defined in src/spreadsheets/module.ts:131

Class SpreadsheetModule

Implements

Index

Properties

Accessors

Methods

Properties

`Readonly`device

`Readonly`poisonDestroyed

Accessors

spreadsheets

Returns SpreadsheetEngine

Methods

`Static`attach

Parameters

Returns Promise<SpreadsheetModule>

createViewport

Parameters

Returns Promise<Viewport>

detach

Returns void

Settings

On This Page

Class SpreadsheetModule

Implements

Index

Properties

Accessors

Methods

Properties

Readonlydevice

ReadonlypoisonDestroyed

Accessors

spreadsheets

Returns SpreadsheetEngine

Methods

Staticattach

Parameters

Returns Promise<SpreadsheetModule>

createViewport

Parameters

Returns Promise<Viewport>

detach

Returns void

Settings

On This Page

`Readonly`device

`Readonly`poisonDestroyed

`Static`attach