# ColumnStateEntry

Fields, allowed values, and APIs that use ColumnStateEntry.

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

<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 ColumnStateEntry {
  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="used-by"></a>

## APIs using this type

- [getColumnState](https://grid.syidax.com/docs/methods/getColumnState.md) — Reads serializable column width, order, visibility, sorting, and pinning state.
- [applyColumnState](https://grid.syidax.com/docs/methods/applyColumnState.md) — Restores saved column state. Verify that IDs match current columns.