@worksheet-js/core
API Reference
Complete reference for all public methods, properties, and types across the Worksheet.js package ecosystem.
@worksheet-js/coreRequiredCore grid engine — Worksheet class, canvas renderer, formula integration.
@worksheet-js/reactFramework<Worksheet /> component and useWorksheet() hook for React 16.8+.
@worksheet-js/vueFramework<Worksheet /> component and useWorksheet() composable for Vue 3.
@worksheet-js/angularFramework<WorksheetComponent> and WorksheetModule for Angular 14+ with Ivy partial-compilation support.
@worksheet-js/formulaStandaloneStandalone formula engine. Runs server-side in Node.js 18+ or in-browser.
@worksheet-js/excelStandaloneHigh-fidelity XLSX import/export — styles, merges, formulas, images.
@worksheet-js/pluginsPluginsAI copilot (15+ modules), charts, pivots, shapes, slicers. Pro or Enterprise.
@worksheet-js/drawStandaloneZero-dependency, draw.io-style diagramming engine — flowcharts, org charts, BPMN, UML, ER & network diagrams.
Type conventions
| Token | Meaning |
|---|---|
address: string | A1-style cell address or range, e.g. 'A1', 'B2:D10', 'Sheet2!A1' |
index: number | Zero-based sheet index |
Promise<T> | All async methods return a native Promise |
Partial<T> | All properties of T are optional |