ws.bindings

WorksheetBindings

Sub-API for worksheet data binding operations.

10 methods

list

→ Promise<SheetDataBindingInfo[]>

list(): Promise<SheetDataBindingInfo[]>;

List all data bindings on the sheet. @returns Array of binding info objects

SheetDataBindingInfo

get

→ Promise<SheetDataBindingInfo | null>

get(bindingId: string): Promise<SheetDataBindingInfo | null>;

Parameter	Type	Required
bindingId	string	required

Get a data binding by ID. @param bindingId - The binding ID to retrieve @returns The binding info, or null if not found

SheetDataBindingInfo

getCount

→ Promise<number>

getCount(): Promise<number>;

Get the total number of data bindings on this sheet. @returns The count of bindings

clear

→ Promise<void>

clear(): Promise<void>;

Remove all data bindings from the sheet.

add

→ Promise<SheetDataBindingInfo>

add(config: CreateBindingConfig): Promise<SheetDataBindingInfo>;

Parameter	Type	Required
config	CreateBindingConfig	required

Add a new data binding on the sheet. @param config - Binding configuration (connection, column mappings, etc.) @returns The created binding info

CreateBindingConfig SheetDataBindingInfo

remove

→ Promise<void>

remove(bindingId: string): Promise<void>;

Parameter	Type	Required
bindingId	string	required

Remove a data binding by ID. @param bindingId - The binding ID to remove

getProjectionRange

→ Promise<CellRange | null>

getProjectionRange(row: number, col: number): Promise<CellRange | null>;

Parameter	Type	Required
row	number	required
col	number	required

Get the spill range for a projected (dynamic array) cell. @param row - Row index (0-based) @param col - Column index (0-based) @returns The spill range, or null if the cell is not a projection source

CellRange

getProjectionSource

→ Promise<{ row: number; col: number } | null>

getProjectionSource(row: number, col: number): Promise<{ row: number; col: number } | null>;

Parameter	Type	Required
row	number	required
col	number	required

Get the source cell of a projected value. @param row - Row index (0-based) @param col - Column index (0-based) @returns The source cell position, or null if the cell is not a projection

isProjectedPosition

→ Promise<boolean>

isProjectedPosition(row: number, col: number): Promise<boolean>;

Parameter	Type	Required
row	number	required
col	number	required

Check whether a cell position is a projected (spilled) value. @param row - Row index (0-based) @param col - Column index (0-based) @returns True if the cell holds a projected value

getViewportProjectionData

→ Promise<Array<{ originRow: number; originCol: number; rows: number; cols: number }>>

getViewportProjectionData(
    range: string | CellRange,
  ): Promise<Array<{ originRow: number; originCol: number; rows: number; cols: number }>>;

Parameter	Type	Required
range	string \| CellRange	required

Get all projection data overlapping a viewport range (batch query). Returns one entry per projection with origin position and dimensions. @param range - A1-style range string or CellRange object

CellRange