API REFERENCE

SyGridPinnedRowChange

Fields, allowed values, and APIs that use SyGridPinnedRowChange.

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 type SyGridPinnedRowChange<TData = GridData> =
  | { readonly kind: 'pinned'; readonly id: GridRowId; readonly section: SyGridPinnedRowSection; readonly index: number; readonly row: SyGridPinnedRow<TData> }
  | { readonly kind: 'unpinned'; readonly id: GridRowId; readonly section: SyGridPinnedRowSection; readonly index: number; readonly row: SyGridPinnedRow<TData> }
  | { readonly kind: 'moved'; readonly id: GridRowId; readonly from: { readonly section: SyGridPinnedRowSection; readonly index: number }; readonly to: { readonly section: SyGridPinnedRowSection; readonly index: number }; readonly row: SyGridPinnedRow<TData> }
  | { readonly kind: 'updated'; readonly id: GridRowId; readonly section: SyGridPinnedRowSection; readonly index: number; readonly row: SyGridPinnedRow<TData>; readonly previous: SyGridPinnedRow<TData> };

Contracts containing this type