API 개요
생성자
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
rowsCount: 20,
colsCount: 20
});
매개변수:
- HTML 컨테이너 (또는 HTML 컨테이너의 ID)
- 구성 옵션의 해시 (아래 참조)
Spreadsheet 메서드
| 이름 | 설명 |
|---|---|
| addColumn() | 스프레드시트에 새 열을 추가합니다 |
| addFormula() | 셀 수식에서 사용할 수 있는 사용자 정의 수식 함수를 등록합니다 |
| addRow() | 스프레드시트에 새 행을 추가합니다 |
| clear() | 스프레드시트를 초기화합니다 |
| deleteColumn() | 스프레드시트에서 열을 제거합니다 |
| deleteRow() | 스프레드시트에서 행을 제거합니다 |
| eachCell() | 스프레드시트의 셀을 순회합니다 |
| endEdit() | 선택된 셀의 편집을 종료하고, 에디터를 닫으며, 입력된 값을 저장합니다 |
| fitColumn() | 열 너비를 해당 열에서 가장 긴 값에 맞게 조정합니다 |
| freezeCols() | 열을 고정("동결")합니다 |
| freezeRows() | 행을 고정("동결")합니다 |
| getFilter() | 데이터 필터링에 지정된 기준이 포함된 객체를 반환합니다 |
| getFormat() | 셀 값에 적용된 숫자 형식을 반환합니다 |
| getFormula() | 셀의 수식을 반환합니다 |
| getStyle() | 셀에 적용된 스타일을 반환합니다 |
| getValue() | 셀(들)의 값을 반환합니다 |
| hideCols() | 열을 숨깁니다 |
| hideRows() | 행을 숨깁니다 |
| hideSearch() | 검색 바를 숨깁니다 |
| insertLink() | 셀에 하이퍼링크를 삽입하거나 제거합니다 |
| isLocked() | 셀(들)이 잠겨 있는지 확인합니다 |
| load() | 외부 파일에서 데이터를 로드합니다 |
| lock() | 지정한 셀을 잠급니다 |
| mergeCells() | 셀 범위를 하나로 병합하거나 병합된 셀을 분리합니다 |
| parse() | 로컬 데이터 소스에서 스프레드시트로 데이터를 로드합니다 |
| redo() | 취소된 작업을 다시 적용합니다 |
| serialize() | 스프레드시트 데이터를 JSON 객체로 직렬화합니다 |
| search() | 지정한 매개변수로 셀을 검색합니다 |
| setFilter() | 지정된 기준으로 스프레드시트의 데이터를 필터링합니다 |
| setFormat() | 셀 값에 지정된 형식을 설정합니다 |
| setStyle() | 셀에 스타일을 설정합니다 |
| setValidation() | 셀에 드롭다운 목록을 추가하여 유효성 검사를 설정합니다 |
| setValue() | 셀에 값을 설정합니다 |
| showCols() | 숨겨진 열을 표시합니다 |
| showRows() | 숨겨진 행을 표시합니다 |
| startEdit() | 선택된 셀에서 편집을 시작합니다 |
| undo() | 마지막 작업을 되돌립니다 |
| unfreezeCols() | 고정("동결")된 열의 고정을 해제합니다 |
| unfreezeRows() | 고정("동결")된 행의 고정을 해제합니다 |
| unlock() | 잠긴 셀의 잠금을 해제합니다 |
Spreadsheet 이벤트
| 이름 | 설명 |
|---|---|
| afterAction | 액션이 실행된 후 발생합니다 |
| afterClear | 스프레드시트가 초기화된 후 발생합니다 |
| afterDataLoaded | 데이터 로딩이 완료된 후 발생합니다 |
| afterEditEnd | 셀 편집이 완료된 후 발생합니다 |
| afterEditStart | 셀 편집이 시작된 후 발생합니다 |
| afterFocusSet | 셀에 포커스가 설정된 후 발생합니다 |
| afterSelectionSet | 셀이 선택된 후 발생합니다 |
| afterSheetChange | 현재 활성 시트가 변경된 후 발생합니다 |
| beforeAction | 액션이 실행되기 전에 발생합니다 |
| beforeClear | 스프레드시트가 초기화되기 전에 발생합니다 |
| beforeEditEnd | 셀 편집이 완료되기 전에 발생합니다 |
| beforeEditStart | 셀 편집이 시작되기 전에 발생합니다 |
| beforeFocusSet | 셀에 포커스가 설정되기 전에 발생합니다 |
| beforeSelectionSet | 셀이 선택되기 전에 발생합니다 |
| beforeSheetChange | 현재 활성 시트가 변경되기 전에 발생합니다 |
Spreadsheet 속성
| 이름 | 설명 |
|---|---|
| colsCount | 선택 사항. 초기화 시 스프레드시트의 열 수를 설정합니다 |
| editLine | 선택 사항. 편집 바를 표시하거나 숨깁니다 |
| exportModulePath | 선택 사항. 내보내기 모듈의 경로를 설정합니다 |
| formats | 선택 사항. 숫자 형식 목록을 정의합니다 |
| importModulePath | 선택 사항. import 모듈의 경로를 설정합니다 |
| localization | 선택 사항. 숫자, 날짜, 시간 및 통화 형식을 정의합니다 |
| menu | 선택 사항. 메뉴를 표시하거나 숨깁니다 |
| multiSheets | 선택 사항. 스프레드시트에서 여러 시트를 사용하는 기능을 활성화하거나 비활성화합니다 |
| readonly | 선택 사항. 읽기 전용 모드를 활성화하거나 비활성화합니다 |
| rowsCount | 선택 사항. 초기화 시 스프레드시트의 행 수를 설정합니다 |
| toolbarBlocks | 선택 사항. 스프레드시트 툴바에 표시할 버튼 블록을 지정합니다 |
Sheet Manager 메서드
| 이름 | 설명 |
|---|---|
| add() | 스프레드시트에 새로운 빈 시트를 추가하고, 새로 생성된 시트의 고유 식별자를 반환합니다 |
| clear() | 특정 시트의 내용을 지웁니다(시트 자체는 삭제하지 않고 모든 셀 값, 스타일, 서식을 제거합니다) |
| get() | 식별자로 단일 시트 객체를 반환합니다 |
| getActive() | 스프레드시트에서 현재 활성(표시) 상태인 시트 객체를 반환합니다 |
| getAll() | 스프레드시트에 현재 존재하는 모든 시트 객체의 배열을 반환합니다 |
| remove() | 식별자로 스프레드시트에서 시트를 제거합니다 |
| setActive() | 식별자로 지정한 시트로 활성(표시) 시트를 전환합니다 |
Selection 메서드
| 이름 | 설명 |
|---|---|
| getFocusedCell() | 포커스가 있는 셀의 id를 반환합니다 |
| getSelectedCell() | 선택된 셀의 id를 반환합니다 |
| removeSelectedCell() | 지정된 셀에서 선택을 해제합니다 |
| setFocusedCell() | 지정된 셀에 포커스를 설정합니다 |
| setSelectedCell() | 지정된 셀을 선택합니다 |
Events Bus 메서드
| 이름 | 설명 |
|---|---|
| detach() | on() 메서드로 이전에 연결된 이벤트 핸들러를 분리합니다 |
| fire() | 내부 이벤트를 트리거합니다 |
| on() | Spreadsheet의 내부 이벤트에 핸들러를 연결합니다 |
내보내기 메서드
| 이름 | 설명 |
|---|---|
| json() | 스프레드시트의 데이터를 JSON 파일로 내보냅니다 |
| xlsx() | 스프레드시트의 데이터를 Excel(.xlsx) 파일로 내보냅니다 |