# getPinnedRows

Reads current pinned row data as a report.

Canonical: https://grid.syidax.com/docs/methods/getPinnedRows/

<a id="meaning"></a>

## What does this API do?

Reads current pinned row data as a report.

<a id="contract"></a>

## Exact input and result types

```typescript
getPinnedRows(): Promise<SyGridPinnedRowsReport<GridRow>>
```

| Arguments | Required | Type |
| --- | --- | --- |

The return type is `Promise<SyGridPinnedRowsReport<GridRow>>`.

<a id="usage"></a>

## Usage flow

After registering and initializing the Grid element, call grid.getPinnedRows(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

<a id="types"></a>

## Read related types

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

<a id="recipes"></a>

## Feature explanations and examples

- [Row height and pinned rows](https://grid.syidax.com/docs/features/row-layout.md) — Row height, top/bottom pinned rows, full-width rows, and merged cells are separate layout features. Choose based on whether you need persistent summaries or wide detail content.