API REFERENCE

workbookId

Identifies the workbook connecting multiple Grid sheets. Set it together with sheetName for cross-sheet references.

What does this API do?

Identifies the workbook connecting multiple Grid sheets. Set it together with sheetName for cross-sheet references.

API for Pro features: Built-in formulas, references, dependency recalculation and calculated columns

Exact input and result types

typescript
workbookId: string
ItemValue
JavaScript nameworkbookId
HTML attributeworkbook-id
Defaultundefined
Input typestring

Usage flow

Set this on a property of the Grid element. In HTML, you can also use the workbook-id attribute. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

Feature explanations and examples