# SyGridPinnedRowsReport

Fields, allowed values, and APIs that use SyGridPinnedRowsReport.

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

<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 SyGridPinnedRowsReport<TData = GridData> {
  readonly loaded: boolean;
  readonly top: ReadonlyArray<SyGridPinnedRow<TData>>;
  readonly bottom: ReadonlyArray<SyGridPinnedRow<TData>>;
  readonly count: number;
  readonly displayCount: number;
  readonly centerCount: number;
  readonly dangling: ReadonlyArray<GridRowId>;
  readonly idCollisions: ReadonlyArray<GridRowId>;
  readonly stableRowIds: boolean;
  readonly policy: ReadonlyArray<SyGridPinnedRowPolicyDecision>;
}
```

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

## APIs using this type

- [getPinnedRows](https://grid.syidax.com/docs/methods/getPinnedRows.md) — Reads current pinned row data as a report.

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