# Grid API reference

Grid API는 Grid 전체 속성, 개별 열 설정, 호출 메서드, 결과 이벤트, 그리고 이들이 공유하는 타입으로 나뉩니다. 이 문서의 각 항목은 현재 공개된 계약을 이름별로 찾아 읽을 수 있게 연결되어 있습니다.

Canonical: https://grid.syidax.com/ko/docs/guides/api-reference/

<a id="understand"></a>

## 동작 원리와 선택 기준

기능을 처음 구성한다면 기능별 매뉴얼을 먼저 읽고, 정확한 인수·반환값·기본값이 필요할 때 API 항목으로 이동하세요. 검색에는 한국어 목적과 API 이름을 모두 사용할 수 있습니다.

코드의 grid는 설치와 연결 장에서 준비한 Grid 요소입니다. 예제마다 필요한 데이터·설정을 확인하고, 코드에서 소개하는 앱 함수와 서버 주소는 프로젝트에 맞게 구현하세요.

- [설치와 연결 · 공통 예제 데이터](https://grid.syidax.com/ko/docs/guides/getting-started.md)

<a id="example-1"></a>

## 예제 1. Grid 속성과 열 설정 구분

pagination은 Grid 전체에, editable은 개별 열 또는 defaultColDef에 설정합니다.

```javascript
grid.pagination = true;
grid.defaultColDef = { editable: true };
grid.columnDefs = [{ field: 'id', editable: false }, { field: 'quantity', editor: 'number' }];
```

결과 확인: 수량은 편집할 수 있고 ID는 개별 열 설정으로 편집을 막습니다. 모든 옵션이 같은 위치에 들어가는 것은 아닙니다.

<a id="example-2"></a>

## 예제 2. 메서드의 결과 타입 읽기

applyTransaction의 인수와 반환 타입에서 실제 지원하는 변경과 보고 정보를 확인합니다. Promise<T>라면 await 뒤의 값이 T입니다.

결과 확인: 반환 타입의 링크를 열어 status·reason·문제 목록의 의미를 확인하고 앱에서 성공·거절을 나누어 처리합니다.

<a id="example-3"></a>

## 예제 3. 이벤트로 결과 연결

이벤트 목록에서 cellValueChanged를 열고 detail 타입을 확인합니다. 타입에 없는 필드를 임의로 참조하지 말고 연관된 기능 예제도 함께 읽습니다.

결과 확인: 복사할 수 있는 이벤트 구독 예제와 수명 정리 방법을 찾을 수 있습니다. API 이름은 정확한 대소문자를 사용하세요.

<a id="pitfalls"></a>

## 조합할 때와 문제를 해결할 때

타입 사전은 JavaScript에서 import할 모듈 경로 목록이 아닙니다. 타입 정의와 실제 런타임 패키지 export를 구분합니다.

Pro 표시는 사용 조건을 나타냅니다. 이름이 같거나 타입을 읽을 수 있다는 이유로 Community에서 기능이 활성화되지는 않습니다.

<a id="related-api"></a>

## 이 기능에 사용하는 API

공통 설정과 아래 관련 문서를 함께 참고하세요.

- [Grid 속성](https://grid.syidax.com/ko/docs/options.md)
- [열 설정](https://grid.syidax.com/ko/docs/columns.md)
- [메서드](https://grid.syidax.com/ko/docs/methods.md)

<a id="next"></a>

## 함께 읽기

- [행·열·ID의 관계](https://grid.syidax.com/ko/docs/guides/concepts.md)
- [결과와 이벤트 연결](https://grid.syidax.com/ko/docs/guides/data-event-access.md)
- [Features에서 살펴보기](https://grid.syidax.com/grid/api-reference) — 직접 체험 가능한 범위는 해당 가이드에 안내되어 있습니다.