실시간 열 API
열 객체를 조회하고 현재 너비, 순서, 표시 상태와 연결합니다.
옵션
아래 항목을 바꾸면 Grid와 코드에 바로 반영됩니다.
위 표에서 제품 헤더 경계를 드래그해 너비를 바꿔보세요. 실행 결과의 columnResized에서 변경 전후 너비를 볼 수 있습니다.
코드 보기
코드에 포함된 샘플 데이터 · 6행
사용 가이드
#사용자가 열 너비나 표시 순서를 바꿨을 때 앱에서도 현재 열 구성을 읽고 싶다면 열 API를 사용합니다. 열을 설명하는 설정과 화면에서 동작 중인 열 객체를 구분하는 것이 핵심입니다.
앱에서 연결하는 순서
- 화면에서 열 바꾸기
위 표에서 제품 헤더 경계를 드래그해 너비를 바꿔보세요. 실행 결과의 columnResized에서 변경 전후 너비를 볼 수 있습니다.
- 현재 열 상태 조회
표 위 열 상태 조회를 누르면 실행 결과에 현재 너비·순서·고정 상태가 표시됩니다. 제품 너비나 고정 위치를 바꾸고 다시 조회해 비교하세요.
- 저장할 값 따로 읽기
너비·순서·고정 상태를 저장하려면 getColumnState()를 호출하세요. 현재 열 객체 자체를 JSON으로 저장하는 대신 이 상태 배열을 사용합니다.
열 조작 이벤트와 API 조회 결과를 통해 화면의 열 구성을 앱과 연결할 수 있습니다.
열 상태 조회는 getColumnState()를 호출합니다. 앱에서 현재 열 객체가 필요하면 getColumn('product') 또는 getColumns()를 사용하세요. 없는 이름을 조회하면 null이 돌아올 수 있습니다.
알아두면 쉬운 용어
- field / colId
- product처럼 열을 찾을 때 쓰는 이름입니다.
- 열 객체 / 열 상태
- 열 객체는 현재 Grid와 연결된 참조이고, 열 상태는 저장하기 위한 값의 모음입니다.
핵심 API 예시
등록된 Grid 요소를 grid로 참조하는 앱 코드입니다.
const column = await grid.getColumn('product');
const columns = await grid.getColumns();
const savedColumns = await grid.getColumnState();
console.log(column, columns, savedColumns);API reference
#메서드4
| 메서드 / 인수 | 반환 타입 | 설명 |
|---|---|---|
| columnId: string | Promise<GridColumnRef<GridData, TValue, unknown> | null> | 이름을 선택해 타입 계약을 확인하세요. |
Promise<ReadonlyArray<GridColumnRef<GridData, unknown, unknown>>> | 이름을 선택해 타입 계약을 확인하세요. | |
| groupId: string | Promise<GridColumnGroupRef<GridData, unknown> | null> | 이름을 선택해 타입 계약을 확인하세요. |
Promise<ReadonlyArray<GridColumnGroupRef<GridData, unknown>>> | 이름을 선택해 타입 계약을 확인하세요. |
기능별로 자세히 살펴보기
기능별 사용 상황과 설정 방법을 살펴보세요. 직접 체험하는 예제와 앱에서 연결하는 기능을 각 가이드에 안내합니다.