# getApi

현재 Grid의 타입 지정 API와 앱 context에 접근합니다. 초기화가 완료된 요소에서 읽으세요.

Canonical: https://grid.syidax.com/ko/docs/methods/getApi/

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

## 무엇을 하는 API인가요

현재 Grid의 타입 지정 API와 앱 context에 접근합니다. 초기화가 완료된 요소에서 읽으세요.

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

## 입력과 결과의 정확한 타입

```typescript
getApi<TData = GridData, TContext = unknown, TValue = unknown, TFilterModel = unknown>(): Promise<SyGridApi<TData, TContext, TValue, TFilterModel>>
```

| 인수 | 필수 여부 | 타입 |
| --- | --- | --- |

반환 타입은 `Promise<SyGridApi<TData, TContext, TValue, TFilterModel>>`입니다.

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

## 사용 흐름

등록과 초기화를 마친 Grid 요소에서 grid.getApi(…)를 호출합니다. 반환값은 await로 읽으세요. boolean이나 보고서를 반환하는 메서드는 결과를 확인한 뒤 다음 작업을 진행합니다.

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

## 관련 타입 읽기

- [GridData](https://grid.syidax.com/ko/docs/types/GridData.md)
- [SyGridApi](https://grid.syidax.com/ko/docs/types/SyGridApi.md)

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

## 기능별 설명과 예제

- [데이터와 이벤트](https://grid.syidax.com/ko/docs/guides/data-event-access.md) — Grid API는 현재 상태를 읽거나 변경하는 호출이고, 이벤트는 사용자가 조작하거나 데이터가 바뀐 결과를 알리는 통로입니다. 둘을 연결하면 앱의 저장 버튼·상세 패널·변경 내역을 구성할 수 있습니다.