# getState

Reads an immutable, versioned snapshot of the complete view state. Does not back up source row data.

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

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

## What does this API do?

Reads an immutable, versioned snapshot of the complete view state. Does not back up source row data.

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

## Exact input and result types

```typescript
getState(): Promise<SyGridState>
```

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

The return type is `Promise<SyGridState>`.

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

## Usage flow

After registering and initializing the Grid element, call grid.getState(…). 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

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

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

## Feature explanations and examples

- [Settings and data fundamentals](https://grid.syidax.com/docs/guides/concepts.md)
- [API calls and event integration](https://grid.syidax.com/docs/guides/data-event-access.md)