# getDataAsCsv

CSV 문자열과 출력 행·열 수가 담긴 객체를 반환합니다. 문자열은 결과의 csv 필드에서 읽습니다.

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

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

## 무엇을 하는 API인가요

CSV 문자열과 출력 행·열 수가 담긴 객체를 반환합니다. 문자열은 결과의 csv 필드에서 읽습니다.

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

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

```typescript
getDataAsCsv(options?: Omit<CsvExportOptions<GridRow>, 'columns' | 'rows'>): Promise<CsvExportResult>
```

| 인수 | 필수 여부 | 타입 |
| --- | --- | --- |
| options | 선택 | Omit<CsvExportOptions<GridRow>, 'columns' \| 'rows'> |

반환 타입은 `Promise<CsvExportResult>`입니다.

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

## 사용 흐름

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

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

## 관련 타입 읽기

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

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

## 기능별 설명과 예제

- [CSV 내보내기](https://grid.syidax.com/ko/docs/features/csv-export.md) — CSV 내보내기는 표 데이터를 다른 도구로 넘기기 쉬운 텍스트 파일로 만듭니다. 셀 색·열 너비·상세 패널 같은 화면 모양을 보존하는 형식은 아닙니다.