wb.viewport

WorkbookViewport

Viewport management sub-API on the Workbook. Consumer-scoped: createRegion() returns a handle with per-viewport refresh, prefetch, and lifecycle management.

5 methods

createRegion

→ ViewportRegion

createRegion(sheetId: string, bounds: ViewportBounds, viewportId?: string): ViewportRegion;

Parameter	Type	Required
sheetId	string	required
bounds	ViewportBounds	required
viewportId	string	optional

Create a tracked viewport region. Returns a handle — dispose when done.

ViewportBounds ViewportRegion

resetSheetRegions

→ void

resetSheetRegions(sheetId: string): void;

Parameter	Type	Required
sheetId	string	required

Reset all regions for a sheet (e.g., on sheet switch).

setRenderScheduler

→ void

setRenderScheduler(scheduler: RenderScheduler | null): void;

Parameter	Type	Required
scheduler	RenderScheduler \| null	required

Inject (or clear) the render scheduler for "Write = Invalidate" integration. When set, mutation patches applied to viewport buffers automatically trigger a render frame via the scheduler.

RenderScheduler

→ () => void

subscribe(cb: (event: ViewportChangeEvent) => void): () => void;

Parameter	Type	Required
cb	(event: ViewportChangeEvent) => void	required

Subscribe to viewport state change events from all viewport coordinators. Events are emitted synchronously after each state change. Returns an unsubscribe function.

ViewportChangeEvent

setShowFormulas

→ void

setShowFormulas(value: boolean): void;

Parameter	Type	Required
value	boolean	required

Set the show-formulas mode. When true, Rust substitutes formula strings into the display text field of viewport cells that have formulas. Invalidates all prefetch bounds so the next viewport refresh fetches fresh data with the correct display mode.