API REFERENCE

colSpan

Returns the horizontal column span from cell context. Account for pinned boundaries and hidden columns.

What does this API do?

Returns the horizontal column span from cell context. Account for pinned boundaries and hidden columns.

Exact input and result types

typescript

colSpan?: (params: SyGridColSpanParams<TData>) => number

Item	Value
Required	Optional
Input type	(params: SyGridColSpanParams<TData>) => number

Usage flow

Set this on an individual column object in columnDefs. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

Read related types

SyGridColSpanParams

Feature explanations and examples

Row height and pinned rows
Row height, top/bottom pinned rows, full-width rows, and merged cells are separate layout features. Choose based on whether you need persistent summaries or wide detail content.