API REFERENCE
Grid 속성
sy-grid의 Grid 속성 136개를 이름으로 찾고 설명·타입·예제로 이동할 수 있습니다.
전체 목록
- rowData
표에 공급할 원본 행 배열입니다. 전체 조회 결과를 교체할 때 새 배열을 전달하고, 일부 행만 바꿀 때는 applyTransaction을 사용합니다.
- columnDefs
열의 데이터 필드·제목·크기·표시·편집을 정의합니다. 열 그룹 정의를 함께 넣어 다단 머리글을 구성할 수 있습니다.
- context
앱의 공통 문맥을 콜백과 Grid API에 전달합니다. 사용자 권한·서비스 등 앱이 관리하는 정보를 연결할 때 사용합니다.
- components
이 Grid에서 사용할 사용자 정의 렌더러·편집기·필터 등의 로컬 컴포넌트 정의를 등록합니다.
- externalFilter
앱 바깥의 검색 조건으로 각 행의 통과 여부를 판단합니다. 필터 활성 여부와 행 판정 콜백 또는 수명 주기를 가진 인스턴스를 전달합니다.
- componentTimeoutMs
비동기 사용자 컴포넌트를 준비할 때 기다릴 최대 시간입니다. 지연·실패는 componentError와 함께 처리하세요.
- csvImport
CSV 가져오기 버튼과 열 매핑 흐름을 제공합니다. 가져오기로 기존 열·데이터가 교체되는지 사용자에게 안내하세요.
- pdfFontUrl
한글 등 PDF 기본 글꼴에 없는 문자를 출력할 앱 호스팅 TTF/OTF 파일 주소입니다.
- pdfAutoFont
fontBytes가 없을 때 PDF 글꼴을 자동으로 찾습니다. 지정한 pdfFontUrl을 먼저 사용하고 가능한 환경에서 로컬 글꼴 접근을 시도합니다.
- formulas
=로 시작하는 셀 문자열을 수식으로 계산합니다. A1 참조는 화면 정렬 순서가 아닌 원본 열·행 순서를 기준으로 합니다.
- showFormulas
수식 셀에 계산 결과 대신 수식 원문을 보여 줍니다. formulas를 켠 표에서 검토 용도로 사용합니다.
- formulaBar
활성 셀의 원본 값이나 수식을 확인하고 편집하는 수식 바를 표시합니다. Enter로 확정하고 Escape로 취소합니다.
- workbookId
여러 Grid 시트를 같은 워크북에 연결할 식별자입니다. 시트 간 참조를 사용할 때 sheetName과 함께 설정합니다.
- sheetName
워크북 안에서 이 Grid 시트를 구분할 이름입니다. 다른 시트의 수식이 참조하므로 이름 변경 영향을 확인하세요.
- defaultColDef
모든 열에 공통으로 적용할 기본 설정입니다. 개별 columnDefs의 값으로 특정 열만 다르게 구성할 수 있습니다.
- theme
밝은·어두운 프리셋 또는 프리셋을 확장한 토큰 객체로 Grid의 색상과 표현을 설정합니다.
- height
Grid 컨테이너 높이를 지정합니다. 숫자 또는 CSS 길이 문자열을 사용하며 가상 스크롤과 하단 도구의 공간을 함께 고려합니다.
- locale
한국어·영어·일본어 프리셋 또는 기본 메시지를 덮어쓸 객체입니다. 원본 데이터와 열 제목은 앱에서 번역합니다.
- pagination
표를 여러 페이지로 나눠 표시합니다. 서버 데이터 조회 방식 자체를 바꾸는 옵션은 아닙니다.
- pageSize
한 페이지에 표시할 행 수입니다. 그룹 행을 포함하는 표시 행 모델과 원본 데이터 개수를 구분하세요.
- pageSizeOptions
사용자가 페이지 크기 선택기에서 고를 수 있는 숫자 목록입니다.
- rowHeight
기본 행 높이를 픽셀 단위로 정합니다. 글자 크기·셀 편집기·터치 영역에 맞게 선택합니다.
- rowHeightFn
행 인덱스와 데이터를 받아 개별 행 높이를 계산합니다. 높이에 영향을 주는 데이터가 바뀌면 refreshRowHeights로 다시 계산합니다.
- virtualScroll
화면 주변의 행만 렌더링하는 세로 가상화를 사용합니다. 전체 데이터 다운로드를 줄이는 옵션과는 다릅니다.
- quickFilter
표 전체 검색 입력을 표시합니다. 초기 검색어나 외부 입력 연결에는 quickFilterText를 사용합니다.
- quickFilterText
빠른 검색에 적용할 문자열입니다. 앱의 외부 검색창에서도 새 문자열을 지정할 수 있습니다.
- quickFilterPlaceholder
빠른 검색 입력의 안내 문구입니다. 검색할 수 있는 데이터 범위를 구체적으로 설명하세요.
- quickFilterMode
여러 검색어를 모두 만족해야 하는 and 또는 하나라도 만족하면 되는 or로 연결합니다.
- quickFilterRegex
빠른 검색 문자열을 정규식으로 해석하도록 설정합니다. 일반 텍스트 검색과 입력 의미가 달라집니다.
- quickFilterDebounce
빠른 검색 입력 후 필터를 적용하기까지 기다릴 시간입니다. 연속 입력의 처리량과 반응 속도를 조절합니다.
- showEmptyState
데이터가 없을 때 빈 상태 안내를 표시합니다. 요청 실패와 정상적인 빈 결과를 앱에서 구분합니다.
- emptyMessage
원본 데이터가 비어 있을 때 보여 줄 안내 문구입니다.
- noMatchesMessage
데이터는 있지만 현재 검색·필터에 맞는 행이 없을 때의 문구입니다.
- clearFiltersLabel
빈 결과 화면에서 필터를 지우는 작업의 버튼 문구입니다.
- loading
앱의 데이터 요청 진행 상태를 표시합니다. 요청이 성공하거나 실패한 뒤 모두 해제하세요.
- loadingMessage
로딩 중 사용자에게 보여 줄 설명입니다.
- loadingMode
Grid의 로딩 표시 방식을 선택합니다. 지원 값은 LoadingMode 타입에서 확인합니다.
- minLoadingDuration
로딩 표시가 너무 짧게 깜박이지 않도록 유지할 최소 시간입니다.
- datasource
무한 스크롤 모델의 데이터 공급자입니다. 요청된 행 범위에 대해 성공 또는 실패 콜백을 완료해야 합니다.
- cacheBlockSize
원격 행을 한 번에 요청하고 캐시할 블록 크기입니다.
- maxBlocksInCache
무한 행 모델에서 유지할 캐시 블록 수를 제한합니다. 메모리와 재조회 비용의 균형을 정합니다.
- serverSideDatasource
서버가 정렬·필터·그룹 등의 요청을 처리하는 행 모델의 데이터 공급자입니다.
- serverSideGroupCols
서버에서 그룹화할 열을 바깥 그룹부터 순서대로 지정합니다. 빈 배열은 평면 데이터입니다.
- serverSideTransactionWaitMs
비동기 서버 행 트랜잭션을 모아 처리하기까지 기다릴 시간입니다.
- viewportDatasource
현재 화면에 보이는 행 범위에 맞춰 데이터를 공급하는 뷰포트 모델입니다. 초기화·범위 변경·정리를 구현합니다.
- rowDragManaged
Grid가 행 드래그 결과의 순서 변경을 관리하게 합니다. 정렬·필터·다른 행 모델과의 조합 제한을 확인합니다.
- spanExportMode
병합 셀을 복사·출력할 때 원점 값을 한 번만 쓸지 각 위치에 반복할지 선택합니다.
- rowDragMultiRow
여러 선택 행을 함께 드래그할 수 있게 합니다. 개별 열의 rowDrag와 행 선택 설정도 준비합니다.
- rowDragText
드래그 중 표시할 문구를 행 수와 기본 라벨로 구성합니다.
- cellChangeFlash
편집·붙여넣기·트랜잭션으로 값이 바뀐 셀을 잠시 강조합니다.
- enableCellChangeFlash
셀 값 변경 강조를 설정하는 호환 이름입니다. cellChangeFlash와 모순된 값으로 중복 설정하지 마세요.
- contextMenu
셀 우클릭 메뉴를 표시합니다. 기본 복사·행 복사·CSV 작업을 사용하거나 콜백으로 목록을 대체할 수 있습니다.
- columnMenu
열 머리글에서 열에 관한 작업 메뉴를 사용할 수 있게 합니다.
- find
로드된 읽기 가능한 셀에서 일치 위치를 찾고 이동하는 찾기 기능을 제공합니다. 서버 전체 검색과는 다릅니다.
- cellNotes
안정적인 ID가 있고 읽을 수 있는 셀에 독립 메모를 제공합니다. 저장 어댑터와 Pro 권한이 필요합니다.
- cellNotesAdapter
독립 셀 메모의 조회와 revision 기반 원자적 저장을 구현합니다. 내장 임시 저장소로 자동 대체되지 않습니다.
- batchEditToolbar
일괄 편집의 시작·확정·취소를 위한 도구를 표시합니다.
- columnMenuItems
현재 열 문맥을 받아 사용자에게 제공할 열 메뉴 항목을 구성합니다.
- contextMenuItemsCallback
셀 우클릭 메뉴 목록을 반환합니다. 설정하면 기본 메뉴에 추가되는 것이 아니라 전체 기본 목록을 대체합니다.
- keyboardNavigation
셀과 Grid 내부 기능을 키보드로 탐색하는 동작을 설정합니다.
- rowSelection
행 선택을 사용하지 않을지, 단일 또는 복수로 선택할지 정합니다. 셀 범위 선택과 별개입니다.
- getRowId
데이터에서 안정적이고 고유한 행 ID를 반환합니다. 정렬·필터·수정 후에도 같은 업무 행은 같은 ID여야 합니다.
- selectionCheckbox
행 선택을 위한 체크박스를 표시합니다.
- showSelectionCheckbox
행 선택 체크박스를 설정하는 호환 이름입니다. selectionCheckbox와 함께 사용할 때 충돌을 피하세요.
- shiftClickAdditive
Shift 클릭으로 범위를 선택할 때 기존 선택을 유지해 추가할지 정합니다.
- rowHover
CSS 강조만 사용하거나, 이벤트와 상태가 있는 hover를 사용하거나, hover를 끕니다.
- resizableColumns
사용자가 열 경계를 드래그해 너비를 바꿀 수 있게 합니다.
- reorderableColumns
사용자가 머리글을 드래그해 열 순서를 바꿀 수 있게 합니다.
- columnHiding
열 숨김 기능을 활성화합니다. 숨긴 열을 복원할 메뉴나 패널도 함께 제공합니다.
- hideableColumns
열 숨김 기능의 호환 설정입니다. columnHiding과 일관된 값으로 사용합니다.
- autoSizeOnDoubleClick
열 경계 두 번 클릭으로 내용에 맞는 자동 너비를 적용합니다.
- multiSort
여러 열의 정렬 기준을 함께 사용합니다. 우선순위는 정렬 모델의 순서로 확인합니다.
- enableMultiSort
다중 정렬의 호환 이름입니다. multiSort와 모순되지 않게 설정합니다.
- headerFilterRow
머리글 아래에서 열별 필터를 조작하는 행을 표시합니다.
- conditionBuilder
여러 조건을 AND·OR로 묶는 조건 구성 UI를 표시합니다.
- virtualizeColumns
화면 주변의 열만 렌더링하는 가로 가상화를 설정합니다.
- groupBy
같은 값의 행을 그룹으로 묶습니다. 문자열 배열은 앞 항목부터 다단계 그룹을 만듭니다.
- pivotMode
행 축·열 축·값 축으로 데이터를 교차 집계하는 피벗 표시를 켭니다. 세 축 설정을 함께 준비합니다.
- pivotRowGroupColumns
피벗 결과의 왼쪽 행 축을 구성하는 필드 목록입니다.
- pivotColumns
고유 값이 피벗의 상단 결과 열로 펼쳐질 필드 목록입니다.
- pivotValueColumns
피벗 각 교차 셀에서 집계할 값 필드 목록입니다.
- pivotAggFuncs
값 필드마다 사용할 집계 함수 이름을 지정합니다. 기본 집계와 등록한 사용자 함수를 사용할 수 있습니다.
- pivotSubtotals
다단계 피벗 소계를 숨기거나 펼친 그룹의 위·아래에 배치합니다.
- pivotGrandTotal
피벗 전체 합계를 숨기거나 결과의 맨 위·아래에 배치합니다.
- pivotPanelShow
피벗 패널을 항상 표시할지, 피벗 모드일 때만 표시할지, 숨길지 선택합니다.
- pivotPanel
피벗 패널의 호환 boolean 설정입니다. true는 pivotPanelShow의 always에 해당합니다.
- groupPanel
열을 끌어 넣어 행 그룹 기준을 구성하는 패널을 표시합니다.
- getDataPath
행의 루트부터 현재 노드까지 경로 배열을 반환해 트리를 만듭니다. ID 기반 트리 설정보다 우선합니다.
- treeIdField
부모 ID 방식 트리에서 각 노드의 ID를 담은 필드입니다. treeParentField와 함께 지정합니다.
- treeParentField
부모 ID 방식 트리에서 부모 노드의 ID를 담은 필드입니다.
- treeLabelField
부모 ID 방식 트리에서 표시할 라벨 필드입니다. 지정하지 않으면 ID를 사용합니다.
- masterDetail
주문 아래 품목처럼 원본 행을 펼쳐 전체 폭의 상세 패널을 표시합니다.
- detailRowHeight
펼친 상세 패널의 높이를 픽셀로 정합니다.
- detailCellRenderer
상세 패널의 내용을 text·html·vnode 계약으로 만듭니다. 선언형 하위 Grid보다 우선합니다.
- detailGridOptions
상세 패널에 자동으로 생성할 하위 Grid의 열과 옵션입니다. getDetailRowData와 함께 사용합니다.
- getDetailRowData
펼친 부모 행에 해당하는 상세 행을 배열 또는 Promise로 반환합니다. 한 번 펼치는 동안 결과를 재사용합니다.
- detailNestingLevel
중첩 상세 Grid의 깊이입니다. 자동 생성된 하위 Grid는 부모가 설정하며 재귀 깊이 제한에 사용됩니다.
- rangeSelection
셀 사각 범위를 선택할 수 있게 합니다. 행 선택과 독립적이며 복사·채우기·차트 연동의 입력이 됩니다.
- clipboardEscapeFormulae
클립보드로 나가는 텍스트의 스프레드시트 수식 접두사를 이스케이프합니다.
- statusBar
기본 행 수 안내 또는 지정한 상태 패널을 표 아래에 표시합니다. true가 모든 집계 패널을 켜는 것은 아닙니다.
- sideBar
열·필터 도구 패널과 기본 열림 패널을 구성합니다. true는 탭을 제공하고 문자열은 지정 패널을 엽니다.
- rows
원본 행을 공급하는 호환 입력입니다. 새 구성에서는 rowData를 우선 사용하고 두 입력이 충돌하지 않게 합니다.
- columns
열 정의를 공급하는 호환 입력입니다. 새 구성에서는 columnDefs를 우선 사용합니다.
- maxRendered
한 번에 렌더링할 행 수의 상한을 설정합니다. 데이터 전체 개수와는 별개의 렌더링 제약입니다.
- engine
자동 선택·표준 JavaScript·Pro 중 요청할 처리 모드를 지정합니다. 실제 결과는 getActiveTier로 확인합니다.
- proThreshold
자동 엔진 선택에서 Pro 경로를 고려할 데이터 규모 기준입니다.
- unavailable
요청한 엔진을 사용할 수 없을 때 대체 경로로 실행할지 오류로 처리할지 정합니다.
- brandLogo
기본 로고·none·지원하는 이미지 data URL 중 하나를 지정합니다. 제거와 변경에는 grid.branding 권한이 필요하며 위치는 표 하단 오른쪽입니다.
- collaborationRoom
편집과 참여 상태를 공유할 협업 방 식별자입니다. 여러 기기 연결에는 원격 서비스 설정이 필요합니다.
- realtimeUrl
원격 협업을 연결할 WebSocket 주소입니다. 생략하면 같은 페이지·프로세스의 데모 범위로 사용합니다.
- collabUserName
다른 협업 참가자에게 표시할 사용자 이름입니다.
- collabUserColor
협업 참가자의 커서·표시에 사용할 구분 색상입니다.
- collabPresence
협업 참가자의 현재 위치와 참여 상태 표시를 설정합니다.
- collabConflictUi
동시 편집 충돌에 대한 사용자 안내 UI를 설정합니다.
- auditLog
행·셀·선택·편집 이력 전이를 감사 로그로 기록합니다. 기본 비활성 상태이며 장기 서버 보존과는 별개입니다.
- auditLogMax
메모리에 보관할 감사 로그 수의 상한입니다. 초과 시 오래된 기록부터 빠집니다.
- canReadCell
셀을 읽을 수 있는지 동기적으로 판단하는 권한 콜백입니다. 서버의 접근 제어와 함께 사용합니다.
- maskedCellValue
읽기 제한된 셀 대신 표시할 마스킹 문구입니다.
- canEditCell
행·열·현재 값과 앱 권한에 따라 편집을 허용할지 판단합니다.
- conditionalFormats
조건에 맞는 셀의 배경·글자 등의 표현을 바꾸는 규칙 배열입니다. 원본 값은 수정하지 않습니다.
- conditionalFormatUi
사용자가 조건부 서식 규칙을 조정하는 UI를 제공합니다.
- validationRules
입력값의 필수 여부·범위·목록·패턴·사용자 검증 등을 정의합니다.
- invalidEditMode
검증 실패 시 오류를 표시하고 반영하는 allow, 기존 값으로 되돌리는 revert, 확정을 막는 block 중 선택합니다.
- maxSnapshots
메모리에 보관할 데이터 스냅샷 수의 상한입니다. 오래된 스냅샷이 제거될 수 있습니다.
- collabPersistence
협업 상태의 로컬 영속 저장을 사용하지 않을지 IndexedDB를 사용할지 선택합니다. 서버 백업을 대신하지 않습니다.
- initialState
Grid의 첫 초기화에 한 번 적용할 버전 포함 화면 상태입니다. 실행 중 복원은 setState를 사용합니다.
- editType
한 셀씩 편집할지 한 행의 여러 셀을 묶어 편집할지 선택합니다.
- enableFillHandle
선택 범위 모서리의 채우기 핸들을 활성화합니다.
- fillHandleAxes
채우기를 가로·세로·양방향 중 어디로 허용할지 정합니다.
- fillHandleMode
채우기에서 기존 값을 복사할지 연속 패턴으로 확장할지 선택합니다.
- alignedGrids
열 배치 등을 함께 맞출 Grid 연결을 지정합니다. 연결 결과와 순환 제한은 정렬된 Grid 보고서에서 확인합니다.
- isFullWidthRow
특정 행을 열별 셀이 아닌 전체 폭 행으로 표시할지 판단합니다.
- fullWidthCellRenderer
전체 폭 행의 내용을 그리는 렌더러입니다. 일반 셀 렌더러와 다른 입력 계약을 사용합니다.
- fullWidthRowHeight
전체 폭 행의 고정 높이 또는 행별 높이 계산 함수를 지정합니다.
- pinnedTopRowData
스크롤과 별개로 표 위쪽에 고정할 행 데이터입니다.
- pinnedBottomRowData
스크롤과 별개로 표 아래쪽에 고정할 행 데이터입니다.