API REFERENCE

getWorkbookBinding

Reads current workbook and sheet connection information, or null when disconnected.

What does this API do?

Reads current workbook and sheet connection information, or null when disconnected.

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

Exact input and result types

typescript
getWorkbookBinding(): Promise<GridWorkbookBinding | null>
ArgumentsRequiredType

The return type is Promise<GridWorkbookBinding | null>.

Usage flow

After registering and initializing the Grid element, call grid.getWorkbookBinding(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

Feature explanations and examples