# SyGridColSpanParams

Fields, allowed values, and APIs that use SyGridColSpanParams.

Canonical: https://grid.syidax.com/docs/types/SyGridColSpanParams/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface SyGridColSpanParams<TData = GridData> {
  readonly row: TData;
  readonly rowIndex: number;
  readonly column: ColumnDef<TData>;
  readonly colIndex: number;
  readonly container: 'left' | 'middle' | 'right';
}
```

<a id="used-by"></a>

## APIs using this type

- [colSpan](https://grid.syidax.com/docs/columns/colSpan.md) — Returns the horizontal column span from cell context. Account for pinned boundaries and hidden columns.

<a id="parents"></a>

## Contracts containing this type

- [ColumnDef](https://grid.syidax.com/docs/types/ColumnDef.md)

<a id="related"></a>

## Related types

- [GridData](https://grid.syidax.com/docs/types/GridData.md)
- [ColumnDef](https://grid.syidax.com/docs/types/ColumnDef.md)