# SyGridPinnedRowsResult

Fields, allowed values, and APIs that use SyGridPinnedRowsResult.

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

<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 SyGridPinnedRowsResult<TData = GridData> {
  readonly status: 'applied' | 'unchanged' | 'refused';
  readonly changes: ReadonlyArray<SyGridPinnedRowChange<TData>>;
  readonly rejected: ReadonlyArray<SyGridPinnedRowRejection>;
  readonly top: ReadonlyArray<GridRowId>;
  readonly bottom: ReadonlyArray<GridRowId>;
}
```

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

## APIs using this type

- [setPinnedRows](https://grid.syidax.com/docs/methods/setPinnedRows.md) — Sets top/bottom pinned row data and returns the application result.

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

## Contracts containing this type

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

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

## Related types

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