# SyGridPinnedRowInfo

Fields, allowed values, and APIs that use SyGridPinnedRowInfo.

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

<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 SyGridPinnedRowInfo<TData = GridData> {
  readonly displayIndex: number;
  readonly band: SyGridPinnedRowBand;
  readonly index: number;
  readonly row: SyGridPinnedRow<TData> | null;
  readonly policy: ReadonlyArray<SyGridPinnedRowPolicyDecision>;
}
```

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

## APIs using this type

- [getPinnedRowInfo](https://grid.syidax.com/docs/methods/getPinnedRowInfo.md) — Reads details of a specified pinned row.

<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)
- [SyGridPinnedRowBand](https://grid.syidax.com/docs/types/SyGridPinnedRowBand.md)
- [SyGridPinnedRow](https://grid.syidax.com/docs/types/SyGridPinnedRow.md)
- [SyGridPinnedRowPolicyDecision](https://grid.syidax.com/docs/types/SyGridPinnedRowPolicyDecision.md)