API REFERENCE
ColumnDef · 열 설정
sy-grid의 ColumnDef · 열 설정 53개를 이름으로 찾고 설명·타입·예제로 이동할 수 있습니다.
전체 목록
- field
원본 행에서 값을 읽는 필수 필드 경로입니다. 표시 제목이 아니라 데이터의 키를 사용합니다.
- colId
열을 API·상태 저장에서 안정적으로 식별할 ID입니다. 제목 변경과 무관하게 유지하세요.
- headerName
사용자에게 보여 줄 열 제목입니다. 원본 데이터 키와 다르게 작성할 수 있습니다.
- headerTooltip
머리글에 제공할 보조 설명입니다.
- sortable
이 열을 사용자 정렬 대상으로 허용할지 정합니다.
- sort
열의 초기 오름차순·내림차순 정렬 또는 정렬 해제를 지정합니다.
- sortIndex
여러 초기 정렬 기준 중 이 열의 우선순위를 지정합니다.
- filter
이 열에 사용할 기본 필터 종류 또는 사용자 필터 정의입니다.
- valueGetter
원본 행에서 계산한 셀 값을 반환합니다. 단순 표시 문자열만 바꾸려면 valueFormatter를 사용합니다.
- formula
이 열에 적용할 수식 문자열입니다. 수식 기능과 원본 좌표 규칙을 함께 확인합니다.
- valueFormatter
셀 값을 통화·날짜 등 읽기 쉬운 문자열로 표시합니다. 저장된 원본 타입은 바꾸지 않습니다.
- tooltipField
툴팁에 사용할 원본 데이터 필드입니다.
- tooltipValueGetter
현재 셀 문맥으로 툴팁 내용을 계산합니다. 권한 없는 값을 우회 노출하지 마세요.
- cellRenderer
셀을 text·html·vnode 또는 등록된 사용자 렌더러로 표시합니다.
- cellRendererMeta
셀 렌더러에 전달할 추가 메타데이터입니다.
- cellEditor
사용자 정의 셀 편집기를 선언합니다. 기본 편집기 종류는 editor로 선택합니다.
- floatingFilterComponent
머리글 아래에 표시할 사용자 필터 입력 컴포넌트입니다.
- cellClass
셀에 적용할 CSS 클래스 또는 클래스를 반환하는 콜백입니다.
- cellClassRules
조건별로 CSS 클래스를 적용하는 규칙입니다.
- cellStyle
셀에 적용할 인라인 스타일 객체·콜백 또는 이들의 배열입니다.
- width
열의 초기 너비를 픽셀로 지정합니다.
- minWidth
사용자 조정과 자동 크기 계산에서 허용할 최소 너비입니다.
- maxWidth
열 너비의 상한입니다.
- flex
남는 공간을 나눠 가질 상대 비율입니다. 고정 너비·최소·최대 너비와 함께 확인합니다.
- resizable
이 열의 너비를 사용자가 조절할 수 있는지 정합니다.
- reorderable
이 열의 위치를 사용자가 바꿀 수 있는지 정합니다.
- pinned
열을 왼쪽·오른쪽에 고정하거나 null로 고정을 해제합니다.
- columnGroupShow
부모 열 그룹이 펼쳐졌거나 접혔을 때 이 열을 보여 줄지 선택합니다.
- aggFunc
행 그룹·분석에서 사용할 기본 또는 등록된 사용자 집계 함수 이름입니다.
- hidden
이 열을 처음에 숨길지 설정합니다. 값 읽기 권한을 차단하는 설정은 아닙니다.
- hide
열 숨김의 호환 이름입니다. hidden과 모순된 값으로 중복 지정하지 마세요.
- editable
이 열의 편집을 허용합니다. 행별 권한·검증 정책은 추가로 적용됩니다.
- editor
텍스트·숫자·날짜·선택·체크박스 등 기본 편집기 종류를 지정합니다.
- valueParser
입력 문자열을 저장할 타입으로 변환합니다. 숫자·날짜 등의 정규화에 사용합니다.
- valueSetter
변환된 값을 원본 행에 반영하는 사용자 저장 로직입니다. 변경 여부의 반환 계약을 확인하세요.
- comparator
두 값과 행을 받아 정렬 순서를 비교합니다. 음수·0·양수로 앞·같음·뒤를 표현합니다.
- options
선택형 편집기의 값과 표시 라벨 목록입니다. 일부 선택지를 disabled로 막을 수 있습니다.
- min
숫자·날짜 편집에서 허용하는 최솟값입니다.
- max
숫자·날짜 편집에서 허용하는 최댓값입니다.
- step
숫자 입력의 증가·감소 단위입니다.
- decimals
숫자 편집의 소수 자릿수를 정합니다.
- nullable
편집 값으로 null을 허용할지 지정합니다.
- allowEmpty
편집 중 빈 값을 허용할지 지정합니다. 필수 입력 검증과 함께 확인합니다.
- storeAs
날짜 편집 결과를 Date 객체 또는 ISO 문자열 중 어떤 형태로 저장할지 정합니다.
- rows
여러 줄 텍스트 편집기의 기본 표시 줄 수입니다.
- maxRows
여러 줄 편집기가 늘어날 수 있는 최대 줄 수입니다.
- cols
여러 줄 텍스트 편집기의 표시 폭 기준입니다.
- maxLength
텍스트 편집에 허용할 최대 길이입니다.
- rowDrag
이 열에 행 드래그 핸들을 제공합니다. Grid의 드래그 정책과 함께 사용합니다.
- wrapText
셀 텍스트 줄바꿈을 허용합니다. 충분한 높이가 없으면 내용이 잘릴 수 있습니다.
- autoHeight
셀 내용에 맞춘 행 높이 계산을 사용합니다. 가상화와 큰 데이터의 비용을 함께 확인합니다.
- rowSpan
셀 문맥에서 세로로 차지할 행 수를 반환합니다. 충돌과 표시 모델의 제한은 span 보고서에서 확인합니다.
- colSpan
셀 문맥에서 가로로 차지할 열 수를 반환합니다. 고정 영역과 숨긴 열의 경계를 고려합니다.