# SyGridColumnState

Fields, allowed values, and APIs that use SyGridColumnState.

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

<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 SyGridColumnState {
  field: string;
  width: number | null;
  order: number | null;
  hidden: boolean;
  sortDirection: 'asc' | 'desc' | null;
  isSorted: boolean;
  sortIndex?: number | null;
  pinned?: 'left' | 'right' | null;
}
```

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

## Contracts containing this type

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