ColumnStateEntry

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.

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;
}

APIs using this type

• getColumnState

  Reads serializable column width, order, visibility, sorting, and pinning state.

• applyColumnState

  Restores saved column state. Verify that IDs match current columns.