@thinkfree.dev/tfo-sdk 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,4201 @@
1
+ # Thinkfree Office SDK — API 기능 명세
2
+
3
+ > 기준일 2026-09-22 · SDK 빌드 시 자동 생성되는 문서입니다 (`npm run generate:doc`).
4
+ > dist 안의 원본은 빌드마다 덮어써집니다 — 내용을 편집하려면 전달받은 사본에서 작업하세요.
5
+
6
+ 외부 서비스에서 Thinkfree Office 문서(Word · Spreadsheet · Presentation)를 제어할 수 있는 기능 목록입니다.
7
+
8
+ ## 목차
9
+
10
+ - [**Word**](#mod-word) — 객체 18 · 기능 277
11
+ - [Document](#word-worddocument) (문서) — 37
12
+ - [Body](#word-wordbody) (본문) — 25
13
+ - [Bookmark](#word-wordbookmark) (책갈피) — 5
14
+ - [ChangeTracking](#word-wordchangetracking) — 5
15
+ - [Chart](#word-wordchart) — 16
16
+ - [Comment](#word-wordcomment) (댓글) — 5
17
+ - [Hyperlink](#word-wordhyperlink) (하이퍼링크) — 8
18
+ - [Image](#word-wordimage) (이미지) — 0
19
+ - [List](#word-wordlist) (목록) — 2
20
+ - [Note](#word-wordnote) (각주/미주) — 6
21
+ - [Paragraph](#word-wordparagraph) (문단) — 44
22
+ - [Range](#word-wordrange) (텍스트 범위) — 50
23
+ - [Section](#word-wordsection) (구역) — 15
24
+ - [Shape](#word-wordshape) (도형) — 18
25
+ - [Style](#word-wordstyle) (스타일) — 3
26
+ - [Table](#word-wordtable) (표) — 22
27
+ - [TableCell](#word-wordtablecell) (표 셀) — 10
28
+ - [TableRow](#word-wordtablerow) (표 행) — 6
29
+ - [**Spreadsheet**](#mod-cell) — 객체 7 · 기능 173
30
+ - [Workbook](#cell-workbook) (통합 문서) — 13
31
+ - [Worksheet](#cell-worksheet) (워크시트) — 33
32
+ - [Chart](#cell-chart) (차트) — 21
33
+ - [Filter](#cell-filter) (자동 필터) — 6
34
+ - [Name](#cell-name) (이름 정의) — 9
35
+ - [Range](#cell-range) (셀 범위) — 76
36
+ - [Table](#cell-table) (표) — 15
37
+ - [**Presentation**](#mod-show) — 객체 15 · 기능 349
38
+ - [Document](#show-document) (문서) — 56
39
+ - [Slide](#show-slide) (슬라이드) — 60
40
+ - [BasePathShape](#show-basepathshape) (도형 (패스)) — 31
41
+ - [BaseShape](#show-baseshape) (도형 공통) — 35
42
+ - [Chart](#show-chart) (차트) — 15
43
+ - [Comment](#show-comment) (댓글) — 14
44
+ - [Control](#show-control) — 0
45
+ - [Diagram](#show-diagram) — 0
46
+ - [Group](#show-group) (그룹) — 2
47
+ - [Image](#show-image) (이미지) — 3
48
+ - [Line](#show-line) (선) — 4
49
+ - [OleObject](#show-oleobject) — 0
50
+ - [Shape](#show-shape) (도형) — 51
51
+ - [Table](#show-table) (표) — 21
52
+ - [TableCell](#show-tablecell) (표 셀) — 57
53
+ - [**Common — 모듈 공통 상수**](#mod-common) — 상수 8
54
+
55
+ <a id="mod-word"></a>
56
+ ## Word
57
+
58
+ Word 문서를 다루는 기능입니다. 문단·표·이미지 삽입과 서식 적용, 책갈피·하이퍼링크·댓글 관리 등을 외부 서비스에서 호출할 수 있습니다.
59
+
60
+ <a id="word-worddocument"></a>
61
+ ### Document — 문서 (`WordDocument`)
62
+
63
+ 문서의 진입점이다. 본문·구역으로 이동하고, 문서 요소를 찾고, 문서 전역 설정을 바꾼다. - getBody()와 getSection()으로 본문·구역에 접근하고, 단락·표·도형·차트·책갈피 등을 조회한다. - 페이지 번호·변경 추적·보기 설정과 문서 저장·다운로드·인쇄를 제공한다.
64
+
65
+ | 기능 | 설명 | 입력 | 결과 |
66
+ |---|---|---|---|
67
+ | `getParagraph` | 지정한 ID의 단락을 반환한다. - 단락이 속한 영역(본문/머리글/바닥글)을 자동으로 찾아 연결하므로, 머리글/바닥글 단락도 본문과 동일하게 서식·편집할 수 있다. | `paragraphId` 문자열 — 단락 ID | 단락 객체(영역 자동 연결)<br>[`WordParagraph`](#word-wordparagraph) |
68
+ | `getTable` | 지정한 ID의 표를 반환한다. - 표가 속한 영역(본문/머리글/바닥글/텍스트박스)을 자동으로 찾아 연결하므로, 그 영역의 표도 동일하게 다룰 수 있다. | `tableId` 문자열 — 표 ID | 표 객체(영역 자동 연결)<br>[`WordTable`](#word-wordtable) |
69
+ | `getRange` | 지정한 좌표(RangeData)의 범위를 반환하며, 인자 없이 부르면 본문 전체 범위를 반환한다. - 단락이 속한 영역(본문/머리글/바닥글)을 자동으로 찾아 연결하므로, 머리글/바닥글 단락의 paragraphId 를 넘겨도 본문과 동일하게 다룰 수 있다. - 인자를 생략한 호출은 `getBody().getRange(RangePosition.WHOLE)` 의 단축이다. 범위는 한 영역 안에만 존재하므로 본문만 해당하고 머리글·바닥글·각주는 포함하지 않는다. - 좌표를 넘길 때는 startParaId 가 필요하다. startParaId 없는 options 객체는 즉시 거부하므로, 키 이름을 잘못 써서 본문 전체가 되는 일은 없다. - 영역 맨앞/맨끝은 `getBody().getRange(RangePosition.START/END)`, 선택은 `getSelection()` 으로 얻는다.<br><br><b>예제</b><pre><code>doc.getRange(); // whole body<br>doc.getRange({ startParaId: "p1" }); // whole paragraph<br>doc.getRange({ startParaId: "p1", startOffset: 0, endOffset: 5 }); // characters 0~5 within the paragraph</code></pre> | `options` (선택) [`RangeData`](#word-rangedata) — 좌표 범위 정보. 생략하면 본문 전체 (기본값: whole body) | 범위 객체<br>[`WordRange`](#word-wordrange) |
70
+ | `getSelection` | 현재 선택 영역을 반환한다. - 선택한 내용이 없으면 커서 위치의 빈 범위를 반환한다. | — | 선택 영역 범위<br>[`WordRange`](#word-wordrange) |
71
+ | `getBody` | 문서 본문의 콘텐츠 영역을 반환한다. - 본문의 텍스트·구조 조회와 단락·표 삽입에 사용한다.<br><br><b>예제</b><pre><code>doc.getBody().getText(); // get body text<br>doc.getBody().insertParagraph("New paragraph"); // append a paragraph at the end of the body</code></pre> | — | 본문 body<br>[`WordBody`](#word-wordbody) |
72
+ | `getSection` | 지정한 인덱스의 구역을 반환한다. - 구역의 본문·머리글·바닥글 조회와 페이지 설정에 사용한다.<br><br><b>예제</b><pre><code>doc.getSection(); // first section (index omitted)<br>doc.getSection(1).getBody(); // body of the second section<br>doc.getSection(0).getHeader(HeaderFooterVariant.DEFAULT); // default header of the first section</code></pre> | `index` (선택) 숫자 — 구역 인덱스(0부터 시작하는, 문서 순서. 0=첫 구역) (기본값: 0) | 구역 객체(인덱스 검증은 머리글/바닥글/페이지설정 호출 시점)<br>[`WordSection`](#word-wordsection) |
73
+ | `getSections` | 문서의 구역 목록을 문서 순서로 반환한다. | — | 구역 목록(없으면 빈 배열)<br>[`WordSection`](#word-wordsection) 목록 |
74
+ | `setPageNumber` | 머리글·바닥글에 페이지 번호를 설정하거나 제거한다. - 영역이 없으면 자동 생성하고, 기존 페이지 번호는 교체한다. - remove가 true이면 페이지 번호 단락만 제거한다. 영역이나 번호가 없으면 변경하지 않는다.<br><br><b>예제</b><pre><code>doc.setPageNumber(PageNumberArea.FOOTER); // show page number in the footer<br>doc.setPageNumber(PageNumberArea.FOOTER, { align: PageNumberAlign.CENTER }); // center alignment<br>doc.setPageNumber(PageNumberArea.FOOTER, { remove: true }); // remove page number</code></pre> | `area` [`PageNumberArea`](#word-pagenumberarea) — 대상 영역(header/footer)<br>`options` (선택) `{ align?: PageNumberAlign; variant?: HeaderFooterVariant; sectionIndex?: number; remove?: boolean }` — 페이지 번호 설정<br> · `align` 정렬(left/center/right). remove:true 면 무시 (기본값: PageNumberAlign.LEFT)<br> · `variant` 머리글/바닥글 종류(default/first/even) (기본값: HeaderFooterVariant.DEFAULT)<br> · `sectionIndex` 0부터 시작하는 구역 인덱스(0=첫 구역) (기본값: 0)<br> · `remove` true 면 페이지 번호 제거(align 무시) (기본값: false) | — |
75
+ | `setChangeTracking` | 변경 추적(track changes)을 켜거나 끈다. - 켜면 이후 편집이 삽입/삭제/서식 변경으로 추적되고, 끄면 일반 편집으로 돌아간다(이미 기록된 추적 내용은 유지).<br><br><b>예제</b><pre><code>doc.setChangeTracking(true); // track subsequent edits<br>doc.setChangeTracking(false); // stop tracking, keeping existing tracked changes</code></pre> | `enabled` 참/거짓 — true 면 켜기, false 면 끄기 | — |
76
+ | `isChangeTrackingEnabled` | 변경 추적(track changes)이 켜져 있는지 반환한다. | — | 켜져 있으면 true, 꺼져 있으면 false<br>참/거짓 |
77
+ | `save` | 문서를 저장한다. - 편집된 내용이 없거나 저장이 이미 진행 중이면 무동작이다. | — | — |
78
+ | `download` | 문서를 원본 형식으로 내려받는다. | — | — |
79
+ | `print` | 현재 문서를 인쇄한다. - 데스크톱 Chrome·Edge에서는 브라우저 인쇄를 사용하고, 그 외 환경에서는 PDF로 변환해 내려받는다. - 인쇄가 비활성화된 문서에서는 아무 작업도 수행하지 않는다. | — | — |
80
+ | `setZoom` | 보기 배율을 바꾼다.<br><br><b>예제</b><pre><code>doc.setZoom(ZoomMode.SCALE_100); // 100% zoom<br>doc.setZoom(ZoomMode.FIT_WIDTH); // fit to screen width</code></pre> | `mode` [`ZoomMode`](#word-zoommode) — 배율 프리셋(50~200%)·맞춤(fitWidth/fitInWindow)·단계(zoomIn/zoomOut) | — |
81
+ | `setFormattingMarks` | 서식 기호(단락 기호·공백·탭 등)를 모두 표시하거나 숨긴다.<br><br><b>예제</b><pre><code>doc.setFormattingMarks(true); // show formatting marks<br>doc.setFormattingMarks(false); // hide formatting marks</code></pre> | `visible` 참/거짓 — true 면 표시, false 면 숨김 | — |
82
+ | `setBackgroundColor` | 문서(용지) 배경색을 설정하거나 제거한다.<br><br><b>예제</b><pre><code>doc.setBackgroundColor("#FFF8DC"); // set page background color<br>doc.setBackgroundColor(null); // remove background color</code></pre> | `color` 문자열 (없을 수 있음) — 배경색("#RRGGBB"). null 또는 빈 문자열이면 배경색을 제거한다. | — |
83
+ | `setEvenAndOddHeaders` | 문서 전체의 홀수·짝수 페이지에 서로 다른 머리글·바닥글을 사용하도록 설정한다.<br><br><b>예제</b><pre><code>doc.setEvenAndOddHeaders(true); // separate odd/even headers<br>doc.getSection().getHeader(HeaderFooterVariant.EVEN).insertText("Even page", { replace: true }); // enter the even-page header</code></pre> | `enabled` 참/거짓 — true 면 켜기, false 면 끄기 | — |
84
+ | `getBookmark` | 지정한 이름의 책갈피를 반환한다. - 삭제/이동/존재/정보 등 대상별 동작의 진입점이다. | `name` 문자열 — 책갈피 이름 | 책갈피 객체<br>[`WordBookmark`](#word-wordbookmark) |
85
+ | `getBookmarks` | 문서의 책갈피 목록을 반환한다.<br><br><b>예제</b><pre><code>doc.getBookmarks(); // get regular bookmarks<br>doc.getBookmarks(true); // include hidden bookmarks</code></pre> | `includeHidden` (선택) 참/거짓 — true 면 숨김 책갈피("_" 접두사)도 포함 (기본값: false) | 책갈피 목록(없으면 빈 배열)<br>[`WordBookmark`](#word-wordbookmark) 목록 |
86
+ | `getComment` | 지정한 ID의 댓글을 반환한다. | `commentId` 문자열 — 댓글 ID | 댓글 객체<br>[`WordComment`](#word-wordcomment) |
87
+ | `getComments` | 문서의 댓글 목록을 반환한다. | — | 댓글 목록<br>[`WordComment`](#word-wordcomment) 목록 |
88
+ | `getChangeTrackings` | 문서 전체의 변경 추적 항목 목록을 문서 순서로 반환한다. | — | 변경 추적 목록<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
89
+ | `getChangeTracking` | 지정한 ID의 변경 추적 항목을 반환한다. | `id` 문자열 — 변경 추적 항목 ID | 변경 추적 객체<br>[`WordChangeTracking`](#word-wordchangetracking) |
90
+ | `acceptChangeTrackings` | 문서 전체의 변경 추적 항목을 일괄 수락한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
91
+ | `rejectChangeTrackings` | 문서 전체의 변경 추적 항목을 일괄 거부한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
92
+ | `getNote` | 지정한 ID의 각주·미주를 반환한다. | `noteId` 문자열 — 각주/미주 영역 ID | note 객체<br>[`WordNote`](#word-wordnote) |
93
+ | `getNotes` | 문서의 각주·미주 목록을 문서 순서로 반환한다.<br><br><b>예제</b><pre><code>word.getNotes().forEach(note =&gt; console.log(note.getBody().getText())); // get footnote/endnote content<br>word.getFootnotes().forEach(note =&gt; note.delete()); // delete all footnotes</code></pre> | — | 각주·미주 목록<br>[`WordNote`](#word-wordnote) 목록 |
94
+ | `getFootnotes` | 문서의 각주 목록을 문서 순서로 반환한다. | — | 각주 목록<br>[`WordNote`](#word-wordnote) 목록 |
95
+ | `getEndnotes` | 문서의 미주 목록을 문서 순서로 반환한다. | — | 미주 목록<br>[`WordNote`](#word-wordnote) 목록 |
96
+ | `getStyle` | 지정한 키의 스타일을 반환한다. - 스타일 정보와 정의된 서식을 조회하거나 수정할 때 사용한다. | `style` `Style \| string` — 내장 스타일은 Style enum(값=키), 커스텀 문서 스타일은 getStyles() 의 style 값(예 "heading_1"/"strong") | 스타일 객체<br>[`WordStyle`](#word-wordstyle) |
97
+ | `getStyles` | 문서에 정의된 스타일 목록을 반환한다. | — | 스타일 목록(없으면 빈 배열)<br>[`WordStyle`](#word-wordstyle) 목록 |
98
+ | `getShape` | 지정한 ID의 도형을 반환한다. - 이미지·차트·일반 도형의 종류에 맞는 객체를 반환한다. | `shapeId` 문자열 — 도형 ID (getShapes / insertShape 으로 획득) | 도형 객체 (그림 → WordImage, 차트 → WordChart)<br>`WordShape \| WordImage \| WordChart` |
99
+ | `getShapes` | 문서의 도형 목록을 반환한다. - 글자처럼 배치한 도형과 글 앞·뒤에 배치한 도형을 모두 포함한다.<br><br><b>예제</b><pre><code>doc.getShapes(); // shapes in the body<br>doc.getShapes({ type: ShapeType.PICTURE }); // images only</code></pre> | `options` (선택) `{ storyId?: string; type?: ShapeType; anchorParagraphId?: string }` — 목록 필터<br> · `storyId` 대상 영역 ID(기본값: 본문) (기본값: "0")<br> · `type` 도형 종류 필터(기본값: 전체 종류) (기본값: all types)<br> · `anchorParagraphId` 앵커 단락 필터(기본값: 전체) (기본값: all) | 도형 목록(그림은 WordImage, 차트는 WordChart, 없으면 빈 배열)<br>`(WordShape \| WordImage \| WordChart)[]` |
100
+ | `getChart` | 지정한 ID의 차트를 반환한다. | `shapeId` 문자열 — 차트 도형 ID (getCharts / getShapes 로 획득) | 차트 객체<br>[`WordChart`](#word-wordchart) |
101
+ | `getCharts` | 문서의 차트 목록을 반환한다.<br><br><b>예제</b><pre><code>doc.getCharts(); // get all charts<br>doc.getCharts({ anchorParagraphId: id }); // charts anchored to the given paragraph</code></pre> | `options` (선택) `{ storyId?: string; anchorParagraphId?: string }` — 목록 필터<br> · `storyId` 대상 영역 ID(기본값: 본문) (기본값: "0")<br> · `anchorParagraphId` 앵커 단락 필터(기본값: 전체) (기본값: all) | 차트 목록(없으면 빈 배열)<br>[`WordChart`](#word-wordchart) 목록 |
102
+ | `getHyperlink` | 지정한 ID의 하이퍼링크를 반환한다. | `hyperlinkId` 문자열 — 하이퍼링크 ID (range.insertHyperlink / getHyperlinks 로 획득) | 하이퍼링크 객체<br>[`WordHyperlink`](#word-wordhyperlink) |
103
+ | `getHyperlinks` | 문서(또는 특정 영역)의 하이퍼링크 목록을 반환한다.<br><br><b>예제</b><pre><code>doc.getHyperlinks(); // hyperlinks in the body<br>doc.getHyperlinks({ anchorParagraphId: id }); // links that start in the given paragraph</code></pre> | `options` (선택) `{ storyId?: string; anchorParagraphId?: string }` — 목록 필터<br> · `storyId` 대상 영역 ID(생략 시 본문) (기본값: "0")<br> · `anchorParagraphId` 지정한 단락에서 시작하는 링크만(기본값: 영역 전체) (기본값: whole area) | 하이퍼링크 목록(없으면 빈 배열)<br>[`WordHyperlink`](#word-wordhyperlink) 목록 |
104
+
105
+ <a id="word-wordbody"></a>
106
+ ### Body — 본문 (`WordBody`)
107
+
108
+ 본문, 머리글, 바닥글 등 하나의 콘텐츠 영역을 조회하고 편집한다. - 영역 안의 텍스트와 단락을 조회하고 검색·삽입·교체하거나 내용을 비운다. - 각주, 미주, 댓글 및 텍스트박스의 콘텐츠도 해당 객체의 getBody()로 접근한다. - 특정 위치의 편집은 getRange()가 반환하는 범위를 사용한다.
109
+
110
+ | 기능 | 설명 | 입력 | 결과 |
111
+ |---|---|---|---|
112
+ | `getStoryId` | 이 영역의 식별자를 반환한다. | — | 콘텐츠 영역의 ID<br>문자열 |
113
+ | `exists` | 이 콘텐츠 영역이 실제로 존재하는지 확인한다. - 아직 만들어지지 않은 머리글·바닥글은 첫 콘텐츠 삽입 시 생성한다. | — | 영역이 존재하면 true, 아직 생성되지 않았으면 false<br>참/거짓 |
114
+ | `getRange` | 이 영역 안의 지정한 위치 또는 좌표에 해당하는 범위를 반환한다.<br><br><b>예제</b><pre><code>body.getRange(); // the whole area<br>body.getRange(RangePosition.END); // end of the area (empty range)<br>body.getRange({ startParaId: id, startOffset: 0 }); // coordinate range</code></pre> | `range` (선택) `(RangeData \| RangePosition)` — 좌표 RangeData 객체, 또는 영역 위치 RangePosition("whole"/"start"/"end"/"content"); 생략하면 영역 전체(whole) (기본값: RangePosition.WHOLE) | 이 영역 안에서 조회·편집할 수 있는 범위<br>[`WordRange`](#word-wordrange) |
115
+ | `select` | 이 영역 전체를 화면 선택 영역으로 지정한다(문서 내용은 바꾸지 않는다).<br><br><b>예제</b><pre><code>body.select(); // select the whole area<br>body.select(SelectionMode.END); // place the cursor at the end of the area</code></pre> | `mode` (선택) [`SelectionMode`](#word-selectionmode) — "select"(영역 전체) / "start"(영역 시작에 커서) / "end"(영역 끝에 커서) (기본값: SelectionMode.SELECT) | — |
116
+ | `search` | 이 영역에서 텍스트 또는 특수 문자를 찾아 편집 가능한 범위 목록을 반환한다.<br><br><b>예제</b><pre><code>body.search("hello"); // plain text search<br>body.search("Hello", { caseSensitive: true }); // case-sensitive match<br>body.search("cat", { wholeWord: true }); // only the standalone word "cat" (excludes cat inside catalog)<br>body.search({ character: SpecialCharacter.PAGE_BREAK }); // find page breaks<br>const ranges = body.search("draft"); // returned ranges are directly editable<br>ranges.forEach((range) =&gt; range.setTextFormat({ bold: true })); // e.g. make every match bold</code></pre> | `query` `string \| { character: SpecialCharacter }` — 문자열이면 텍스트 검색, `{ character }` 객체이면 특수 문자 검색<br>`options` (선택) `{ caseSensitive?: boolean; wholeWord?: boolean }` — 텍스트 검색 옵션(특수 문자 검색은 무시)<br> · `caseSensitive` 대소문자 구분 (기본값: false)<br> · `wholeWord` 단어 단위 검색 (기본값: false) | 매칭된 범위 proxy 목록 (없으면 빈 배열)<br>[`WordRange`](#word-wordrange) 목록 |
117
+ | `getText` | 이 영역의 전체 내용을 일반 텍스트로 반환한다. - 각주/미주는 자동 번호 마커와 구분 공백을 제외한다. | — | 읽기용 전체 텍스트. 영역이 없으면 빈 문자열<br>문자열 |
118
+ | `getStructure` | 이 영역의 단락/표 구조를 반환한다. 영역이 없으면 빈 목록. - 단락 entry 의 text 는 끝 경계 개행을 담는다 — 끝의 "\n" 은 항상 단락 경계라 그 단락 안 글자 수는 `text.length - 1` 이고, 중간의 "\n" 은 줄 나눔 개체(수동 줄바꿈·페이지 나눔·단 나눔) 한 칸이다.<br><br><b>예제</b><pre><code>body.getStructure(); // all paragraphs and tables<br>body.getStructure({ type: StructureFilter.TABLE }); // tables only<br>body.getStructure({ type: StructureFilter.LIST }); // list paragraphs only</code></pre> | `options` (선택) `{ type?: StructureFilter }` — 조회 옵션. 대상 영역은 이 body 에 고정된다.<br> · `type` 특정 타입만 조회(table=표만 / list=목록 단락만), 기본 전체 (기본값: all) | 단락·표 entry 목록(문서 순서). id 는 공통 식별자(type 로 종류 판별), type="p"면 text·table 이면 rows/columns 포함<br>`{ paragraphs: { index: number; type: string; id: string; storyId: string; text?: string; rows?: number; columns?: number }[] }` |
119
+ | `getContentHtml` | 이 영역의 전체 내용을 서식이 포함된 HTML로 반환한다. - 단락은 <p> 요소로 표현한다. | — | HTML과 단락 수. 영역이 없으면 빈 문자열과 0<br>`{ html: string; paragraphCount: number }` |
120
+ | `getParagraphs` | 이 영역의 단락 목록을 반환한다. | — | 조회·편집 가능한 단락 목록. 영역이 없으면 빈 배열<br>[`WordParagraph`](#word-wordparagraph) 목록 |
121
+ | `getParagraph` | 이 영역에서 지정한 인덱스의 단락을 반환한다. | `index` (선택) 숫자 — 0부터 시작하는 단락 인덱스 (기본값: 0) | 조회·편집 가능한 단락. 영역 또는 해당 단락이 없으면 null<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
122
+ | `getTables` | 이 영역의 표 목록을 문서 순서로 반환한다. - 영역의 경계는 story 다. 다른 표의 셀 안에 든 표는 같은 story 라 함께 반환하고, 텍스트박스 안의 표는 자기 story 를 가져 포함하지 않는다. 그 표는 해당 텍스트박스의 getBody() 로 조회한다.<br><br><b>예제</b><pre><code>body.getTables(); // all tables in this area<br>body.getTables()[0].getCell(0, 0).setText("Item"); // edit the first table</code></pre> | — | 조회·편집 가능한 표 목록. 영역이 없으면 빈 배열<br>[`WordTable`](#word-wordtable) 목록 |
123
+ | `getComments` | 이 영역의 댓글 목록을 반환한다. 본문 영역에서만 동작하며, 그 외 영역은 빈 배열을 반환한다. | — | 댓글 proxy 배열<br>[`WordComment`](#word-wordcomment) 목록 |
124
+ | `getChangeTrackings` | 이 영역 안의 변경 추적 항목 목록을 문서 순서로 반환한다. | — | 변경 추적 proxy 배열<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
125
+ | `acceptChangeTrackings` | 이 영역 안의 모든 변경 추적 항목을 수락한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
126
+ | `rejectChangeTrackings` | 이 영역 안의 모든 변경 추적 항목을 거부한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
127
+ | `getNotes` | 본문 안의 각주/미주 목록을 반환한다. (본문 영역 한정) | — | note proxy 배열<br>[`WordNote`](#word-wordnote) 목록 |
128
+ | `getFootnotes` | 본문 안의 각주 목록을 반환한다. (본문 영역 한정) | — | 각주 proxy 배열<br>[`WordNote`](#word-wordnote) 목록 |
129
+ | `getEndnotes` | 본문 안의 미주 목록을 반환한다. (본문 영역 한정) | — | 미주 proxy 배열<br>[`WordNote`](#word-wordnote) 목록 |
130
+ | `insertParagraph` | 새 단락을 삽입하며, 위치를 생략하면 영역 맨 끝에 추가한다. - 영역이 없으면 자동 생성한다. 새 단락은 기준 단락의 정렬·여백·들여쓰기 등 직접 단락 서식을 상속한다. - paragraphId를 생략하면 삽입 위치에 따라 영역의 첫 단락 또는 마지막 단락을 기준으로 한다. - 상속한 직접 서식을 초기화하려면 반환된 단락의 clearFormat()을 호출한다.<br><br><b>예제</b><pre><code>body.insertParagraph("New paragraph"); // append at the end<br>body.insertParagraph("First", { position: InsertAt.START }); // add at the very beginning<br>body.insertParagraph("After", { paragraphId: id, position: InsertAt.AFTER }); // after a specific paragraph</code></pre> | `text` 문자열 — 새 단락 텍스트<br>`options` (선택) `{ paragraphId?: string; position?: InsertAt }` — 삽입 옵션<br> · `paragraphId` 기준 단락 ID<br> · `position` 기준 단락이 있으면 그 단락 기준 "before"(위)/"after"(아래), 없으면 영역 위치 "start"(맨 앞)/"end"(맨 끝). 기본값은 기준 단락 있으면 after·없으면 end (기본값: after if a reference paragraph is given, otherwise end) | 삽입 후 조회·편집할 수 있는 새 단락<br>[`WordParagraph`](#word-wordparagraph) |
131
+ | `insertTable` | 표를 삽입하며, 위치를 생략하면 영역 맨 끝에 추가한다. - 표 셀 안에는 삽입할 수 없다. 삽입 지점이 셀 안이면 오류가 발생한다.<br><br><b>예제</b><pre><code>body.insertTable(3, 4); // empty 3x4 table at the end<br>body.insertTable(2, 2, { paragraphId: id, position: InsertAt.BEFORE }); // before a specific paragraph<br>body.insertTable(2, 2, { values: [["Name", "Score"], ["Kim Minsu", "95"]] }); // fill at creation</code></pre> | `rows` 숫자 — 행 수<br>`columns` 숫자 — 열 수<br>`options` (선택) `{ paragraphId?: string; position?: InsertAt; values?: string[][] }` — 삽입 옵션<br> · `paragraphId` 기준 단락 ID<br> · `position` 기준 단락이 있으면 그 단락 기준 "before"(위)/"after"(아래), 없으면 영역 위치 "start"(맨 앞)/"end"(맨 끝). 기본값은 기준 단락 있으면 after·없으면 end (기본값: after if a reference paragraph is given, otherwise end)<br> · `values` 생성 직후 채울 셀 값(2차원 배열, 표 크기 초과 시 발행 전 throw) | 삽입된 표 proxy<br>[`WordTable`](#word-wordtable) |
132
+ | `insertHtml` | HTML을 삽입하고 삽입된 내용의 범위를 반환한다. - 위치를 생략하면 영역 맨 끝에 새 단락을 만들어 삽입한다. - <img> 가 포함되면 먼저 업로드하고 src 를 치환한다. 업로드에 실패한 이미지는 제외되고 나머지는 삽입된다. - 태그가 없는 평문(`"hello"`)·블록 아닌 태그(`"<div>abc</div>"`)도 단락 안의 텍스트로 정규화되고, 여러 단락짜리 HTML(`"<p>a</p><p>b</p>"`)은 그 단락 전체를 포함하는 범위를 돌려준다. - 붙여넣기(paste)와 같은 경로로 들어가므로 **붙여넣기가 지원하지 않는 것은 삽입되지 않는다**: - 목록 스타일이 붙지 않는다 — `<ul>`/`<ol>`/`<li>` 는 번호·불릿 없는 일반 단락으로 들어간다(목록은 `WordParagraph.setList` 로 따로 지정). - 제목 스타일도 붙지 않는다 — `<h1>`~`<h6>` 은 스타일 없는 일반 단락으로 들어간다(스타일은 `WordRange.setStyle` 로 따로 지정). - 문서 콘텐츠가 아닌 태그(`<script>`/`<style>`/`<iframe>` 등)는 내부 텍스트까지 함께 버린다. - 변경 추적(track changes)을 켜 두면 일반 붙여넣기와 같이 삽입 내용이 revision 으로 남는다(메모 안은 제외). - 블록 HTML(`<p>`·`<h1>` 등)은 블록마다 단락 나누기를 함께 넣기 때문에 **마지막 블록 뒤에 빈 단락이 하나 남는다**(평문·인라인은 안 남는다).<br><br><b>예제</b><pre><code>const range = await body.insertHtml("&lt;p&gt;Paragraph&lt;/p&gt;"); // append at the end of the area + get the inserted range<br>range.setTextFormat({ bold: true }); // returned range is directly editable<br>body.insertHtml("&lt;p&gt;First&lt;/p&gt;", { position: InsertAt.START }); // very beginning of the area<br>body.insertHtml("&lt;p&gt;After paragraph&lt;/p&gt;", { paragraphId: id, position: InsertAt.AFTER }); // new paragraph after that paragraph<br>body.insertHtml("&lt;b&gt;appended&lt;/b&gt;", { paragraphId: id }); // inline HTML — appended at the end of that paragraph<br>body.insertHtml("&lt;ul&gt;&lt;li&gt;a&lt;/li&gt;&lt;/ul&gt;"); // list style is not applied — inserted as paragraphs, then set with setList<br>(await body.insertHtml("")).isCollapsed(); // empty HTML — no change, empty range</code></pre> | `html` 문자열 — 삽입할 HTML. 빈 문자열(공백만도 동일)이면 문서를 바꾸지 않고 삽입 지점의 빈 범위만 반환<br>`options` (선택) `{ paragraphId?: string; position?: InsertAt }` — 삽입 위치 옵션<br> · `paragraphId` 기준 단락 ID<br> · `position` 기준 단락이 없으면 "start"(영역 맨 앞)/"end"(영역 맨 끝)에 새 단락을 만들어 그 안에 넣는다. 기준 단락이 있으면 형제 위치가 아니라 **삽입 지점**이다 — "after"는 그 단락의 끝 지점, "before"는 그 단락의 시작 지점. "after"는 앵커 단락 끝에 이어붙으므로 첫 내용이 그 단락에 합쳐지고(`<p>A</p><p>B</p>` = 앵커에 A 합침 + B 는 새 단락), "before"는 블록이면 앵커 앞 새 단락이 되고 인라인이면 앵커 맨 앞에 합쳐진다. 기본값은 기준 단락 있으면 after·없으면 end (기본값: after if a reference paragraph is given, otherwise end) | 삽입된 내용의 범위. 넣을 내용이 없으면(빈 HTML·내용 없는 HTML) 삽입 지점의 빈 범위(collapsed). 삽입 실패는 예외로 알린다.<br>[`WordRange`](#word-wordrange) |
133
+ | `replaceAll` | 이 영역 안에서 일치하는 텍스트를 모두 찾아 교체한다. - 본문에서 부르면 본문 전체, 머리글/바닥글 등에서 부르면 그 영역 안으로 범위가 한정된다.<br><br><b>예제</b><pre><code>doc.getBody().replaceAll("hello", "HI").replacedCount; // replacement count<br>doc.getBody().replaceAll("Draft", "Final", { caseSensitive: true }); // case-sensitive<br>doc.getSection().getHeader().replaceAll("v1", "v2"); // replace only in the header area<br>doc.getFootnotes()[0].getBody().replaceAll("insert", "update"); // replace only within the footnote content<br>doc.getShape(shapeId).getBody().replaceAll("old", "new"); // replace only inside the text box</code></pre> | `findText` 문자열 — 찾을 텍스트<br>`replaceText` 문자열 — 바꿀 텍스트<br>`options` (선택) `{ caseSensitive?: boolean }` — 교체 옵션<br> · `caseSensitive` 대소문자 구분 (기본값: false) | 실제로 교체된 건수(매치가 없으면 0)<br>`{ replacedCount: number }` |
134
+ | `insertText` | 이 영역에 텍스트를 넣는다. 맨 앞에 추가하거나 내용 전체를 교체한다. - replace 를 주지 않으면 영역 맨 앞에 텍스트를 넣고 기존 내용은 그대로 둔다. - replace 를 주면 내용 전체를 교체하고 단락 하나만 남으므로, 여러 단락이던 내용은 한 단락이 된다. - 영역이 아직 없으면 영역을 만들고 이 텍스트를 첫 내용으로 넣는다. - 각주·미주 영역에서 replace 는 자동 번호 마커와 그 뒤 공백을 그대로 두고, 뒤따르는 텍스트만 교체한다. - 텍스트만 바뀌고 영역의 서식은 그대로다. 서식이 필요하면 반환된 범위에 적용한다.<br><br><b>예제</b><pre><code>doc.getBody().insertText("Preface"); // add at the very beginning of the body<br>section.getHeader().insertText("Report", { replace: true }); // replace the header (created if missing)<br>note.getBody().insertText("Footnote content", { replace: true }); // replace the footnote text (number marker kept)</code></pre> | `text` 문자열 — 넣을 텍스트. 빈 문자열에 replace 를 주면 영역이 비워진다<br>`options` (선택) `{ replace?: boolean }` — 삽입 옵션<br> · `replace` true 면 영역 내용 전체를 교체하고, 생략하면 맨 앞에 추가한다 (기본값: false) | 넣은 텍스트의 범위. 각주·미주 replace 는 번호 마커를 포함한 첫 단락 범위다. 각주·미주에 교체할 내용이 없으면 null<br>[`WordRange`](#word-wordrange) (없을 수 있음) |
135
+ | `clear` | 이 영역의 내용을 비우고 빈 단락 하나를 남긴다. - 콘텐츠 영역 자체는 유지한다. | — | 영역이 존재하면 true(이미 빈 영역도 포함), 영역이 없으면 false<br>참/거짓 |
136
+ | `replaceParagraphs` | 여러 단락을 한 번에 제자리 교체한다. 텍스트만 바꾸며, keepFormat 이 아니면 교체 범위 서식을 초기화한다. | `items` `{ paragraphId: string; text: string; keepFormat?: boolean }[]` — 교체할 단락 목록(이 영역 안에서 찾는다). keepFormat 기본 false(서식 초기화) | 교체 성공 개수<br>숫자 |
137
+
138
+ <a id="word-wordbookmark"></a>
139
+ ### Bookmark — 책갈피 (`WordBookmark`)
140
+
141
+ 이름으로 식별되는 책갈피를 조회하고 삭제하거나 해당 위치로 이동한다. - 책갈피는 WordDocument.getBookmark() 또는 getBookmarks()로 얻는다. - 새 책갈피는 WordRange.insertBookmark()로 삽입한다.
142
+
143
+ | 기능 | 설명 | 입력 | 결과 |
144
+ |---|---|---|---|
145
+ | `getName` | 책갈피 이름을 반환한다. | — | 책갈피 이름<br>문자열 |
146
+ | `exists` | 책갈피 존재 여부를 반환한다. | — | 존재하면 true<br>참/거짓 |
147
+ | `delete` | 책갈피를 삭제한다. | — | — |
148
+ | `goTo` | 책갈피 위치로 커서를 이동한다. - 문서 내용은 바꾸지 않으며, 책갈피가 없으면 아무 작업도 수행하지 않는다. | — | — |
149
+ | `getRange` | 책갈피 마커가 놓인 위치 범위를 반환한다.<br><br><b>예제</b><pre><code>word.getBookmark("intro").getRange().getLocation(); // get the bookmark position<br>word.getBookmark("intro").getRange().insertText("headerText");</code></pre> | — | 마커 위치 범위<br>[`WordRange`](#word-wordrange) |
150
+
151
+ <a id="word-wordchangetracking"></a>
152
+ ### ChangeTracking (`WordChangeTracking`)
153
+
154
+ 변경 추적 항목을 조회하고 수락하거나 거부한다. - 문서·영역·단락·범위의 getChangeTrackings()로 항목 목록을 얻는다. - getRange()로 변경 위치를 확인하고 accept() 또는 reject()로 개별 항목을 처리한다.
155
+
156
+ | 기능 | 설명 | 입력 | 결과 |
157
+ |---|---|---|---|
158
+ | `getId` | 변경 추적 항목의 ID를 반환한다. | — | 변경 추적 항목 ID<br>문자열 |
159
+ | `exists` | 변경 추적 항목이 아직 존재하는지 확인한다. - 수락하거나 거부해 처리한 항목은 존재하지 않는 것으로 판단한다. | — | 존재하면 true<br>참/거짓 |
160
+ | `getRange` | 변경 항목이 차지하는 문서 범위를 반환한다. - 여러 변경을 묶으면 처음부터 끝까지 아우르는 범위이며, 대상이 없으면 null 이다. | — | 변경 범위, 대상이 없으면 null<br>[`WordRange`](#word-wordrange) (없을 수 있음) |
161
+ | `accept` | 변경 추적 항목을 수락한다. - 삽입·삭제·서식 변경을 확정한다. 이미 처리한 항목은 다시 변경하지 않는다. | — | 수락하면 true, 대상이 없으면 false<br>참/거짓 |
162
+ | `reject` | 변경 추적 항목을 거부한다. - 삽입·삭제를 취소하고 서식을 원래대로 되돌린다. 이미 처리한 항목은 다시 변경하지 않는다. | — | 거부하면 true, 대상이 없으면 false<br>참/거짓 |
163
+
164
+ <a id="word-wordchart"></a>
165
+ ### Chart (`WordChart`)
166
+
167
+ 차트의 종류와 서식을 조회하고 편집한다. - 종류·스타일·제목·축 제목·범례·데이터 레이블·눈금선을 설정한다. - WordDocument.getChart() 또는 getCharts()로 얻는다. - 크기·위치·배치 변경과 삭제는 WordShape에서 제공하는 메서드를 사용한다.
168
+
169
+ > 📎 [**Shape**](#word-wordshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
170
+
171
+ | 기능 | 설명 | 입력 | 결과 |
172
+ |---|---|---|---|
173
+ | `getType` | 차트 종류를 반환한다. ChartType 에 없는 종류는 "unknown" 을 반환한다. | — | 문자열 |
174
+ | `isEditable` | 이 차트를 편집할 수 있는지 반환한다. 외부 데이터를 소스로 하는 차트는 조회만 되고 편집은 되지 않는다. | — | 참/거짓 |
175
+ | `getTitle` | 차트 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열을 반환한다. | — | 문자열 |
176
+ | `getAxisTitle` | 지정한 축의 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열이고, 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null 을 반환한다. | `axis` [`ChartAxis`](#common-chartaxis) — 제목을 읽을 축(가로축 또는 세로축) | 문자열 (없을 수 있음) |
177
+ | `getLegendPosition` | 범례 위치를 반환한다. 범례를 숨긴 차트는 "none" 이고, 위치를 알아낼 수 없는 차트는 "right" 로 보고한다. | — | [`ChartLegendPosition`](#common-chartlegendposition) |
178
+ | `getDataLabelPosition` | 데이터레이블 위치를 반환한다. 데이터레이블을 표시하지 않는 차트는 "none" 을 반환한다. | — | [`ChartDataLabelPosition`](#common-chartdatalabelposition) |
179
+ | `getGridLine` | 지정한 축의 눈금선 종류를 반환한다. 눈금선을 꺼 둔 축은 "none" 이고, 그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 null 을 반환한다. | `axis` [`ChartAxis`](#common-chartaxis) — 눈금선을 읽을 축(가로축 또는 세로축) | [`ChartGridLineType`](#common-chartgridlinetype) (없을 수 있음) |
180
+ | `getChartInfo` | 차트의 서식 상태를 한 번에 반환한다. 각 값은 이름이 같은 조회 메서드와 같은 규약을 따른다. axisTitle 과 gridLine 의 null 은 그 차트 종류에 해당 축의 제목·눈금선이 아예 없다는 뜻이고, "none" 은 쓸 수는 있지만 꺼져 있다는 뜻이다. | — | `{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string \| null; vertical: string \| null }; gridLine: { horizontal: ChartGridLineType \| null; vertical: ChartGridLineType \| null } }` |
181
+ | `setType` | 차트 종류를 바꾼다. 지금 종류와 같은 값을 넘기면 아무것도 바뀌지 않는다. | `chartType` [`ChartType`](#common-charttype) — 바꿀 차트 종류(enum 문자열, 예: "clustered_column") | — |
182
+ | `setStyle` | 차트의 프리셋 스타일을 바꾼다. 번호에 대응하는 실제 색은 문서 테마를 따른다. | `style` 숫자 — 스타일 번호(1~12 정수). 세 개씩 색 그룹이 나뉘고(1~3, 4~6, 7~9, 10~12), 한 그룹 안의 세 번호는 배경만 다르다(반투명 배경, 흰색 배경, 색상 배경과 계열 테두리 순) | — |
183
+ | `setTitle` | 차트 제목을 설정한다. | `title` 문자열 — 차트에 표시할 제목 | — |
184
+ | `setAxisTitle` | 지정한 축의 제목을 설정한다. 축 제목은 원형 계열·도넛·방사형을 뺀 차트 종류에서 지원한다. | `axis` [`ChartAxis`](#common-chartaxis) — 제목을 설정할 축(가로축 또는 세로축)<br>`title` 문자열 — 축에 표시할 제목 | — |
185
+ | `setLegendPosition` | 범례 위치를 설정한다. "none" 을 넘기면 범례를 숨긴다. | `position` [`ChartLegendPosition`](#common-chartlegendposition) — 범례를 놓을 자리 | — |
186
+ | `setDataLabelPosition` | 데이터레이블 위치를 설정한다. "none" 을 넘기면 데이터레이블을 숨긴다.<br>쓸 수 있는 위치는 차트 종류마다 다르며, "none" 은 모든 종류에서 쓸 수 있다. | `position` [`ChartDataLabelPosition`](#common-chartdatalabelposition) — 데이터레이블을 놓을 자리 | — |
187
+ | `setGridLine` | 지정한 축의 눈금선을 설정한다. "none" 을 넘기면 그 축의 눈금선을 숨긴다.<br>그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 "none" 을 포함해 어떤 값을 넘겨도 오류가 발생한다. | `axis` [`ChartAxis`](#common-chartaxis) — 눈금선을 설정할 축(가로축 또는 세로축)<br>`gridType` [`ChartGridLineType`](#common-chartgridlinetype) — 표시할 눈금선 종류 | — |
188
+ | `getId` | 차트 도형 ID를 반환한다. | — | 차트 도형 ID (영구 GUID)<br>문자열 |
189
+
190
+ <a id="word-wordcomment"></a>
191
+ ### Comment — 댓글 (`WordComment`)
192
+
193
+ 댓글을 조회하고 내용을 편집하거나 삭제한다. - WordDocument.getComment() 또는 getComments()로 얻는다. - getRange()로 댓글이 붙은 위치를 확인하고 getBody()로 댓글 내용을 편집한다. - 새 댓글은 WordRange.insertComment()로 삽입한다.
194
+
195
+ | 기능 | 설명 | 입력 | 결과 |
196
+ |---|---|---|---|
197
+ | `getId` | 댓글 ID를 반환한다. | — | 댓글 ID<br>문자열 |
198
+ | `exists` | 댓글 존재 여부를 반환한다. | — | 존재하면 true<br>참/거짓 |
199
+ | `getRange` | 댓글이 붙은 본문 범위를 반환한다. | — | 댓글이 연결된 본문 범위<br>[`WordRange`](#word-wordrange) |
200
+ | `getBody` | 댓글의 내용 영역을 반환한다. | — | 댓글 본문 영역, 없으면 null<br>[`WordBody`](#word-wordbody) (없을 수 있음) |
201
+ | `delete` | 댓글을 삭제한다. | — | — |
202
+
203
+ <a id="word-wordhyperlink"></a>
204
+ ### Hyperlink — 하이퍼링크 (`WordHyperlink`)
205
+
206
+ 텍스트에 연결된 하이퍼링크를 조회하고 수정하거나 삭제한다. - 주소·설명·종류를 조회하고 getRange()로 링크 텍스트를 편집한다. - 웹 주소, mailto:로 시작하는 이메일 주소, #으로 시작하는 책갈피를 연결한다. - 도형·이미지의 하이퍼링크는 WordShape의 하이퍼링크 메서드를 사용한다.
207
+
208
+ | 기능 | 설명 | 입력 | 결과 |
209
+ |---|---|---|---|
210
+ | `getId` | 하이퍼링크 ID를 반환한다. | — | 하이퍼링크 ID, 아직 삽입 전이면 null<br>문자열 (없을 수 있음) |
211
+ | `exists` | 하이퍼링크 존재 여부를 반환한다. | — | 존재하면 true<br>참/거짓 |
212
+ | `getUrl` | 링크 대상 주소를 반환한다. - 책갈피는 "#이름" 형태로 반환한다. 프로토콜 없이 입력한 웹 주소는 "https://…" 형태로 반환한다.<br><br><b>예제</b><pre><code>word.getHyperlinks().filter(link =&gt; link.getUrl().startsWith("http://")); // pick out insecure links</code></pre> | — | 목적지 url<br>문자열 |
213
+ | `getTooltip` | 링크 툴팁(마우스를 올렸을 때 뜨는 설명)을 반환한다. | — | 툴팁, 지정되지 않았으면 null<br>문자열 (없을 수 있음) |
214
+ | `getLinkType` | 링크 종류를 반환한다. | — | 링크 종류 (link/mailto/bookmark)<br>[`HyperlinkType`](#word-hyperlinktype) |
215
+ | `getRange` | 링크가 연결된 표시 텍스트의 범위를 반환한다. - 링크 시작·끝 표시는 포함하지 않는다. 반환된 범위를 편집하면 링크를 유지하면서 글자만 변경한다.<br><br><b>예제</b><pre><code>word.getHyperlink(id).getRange().getText(); // text the link is attached to<br>word.getHyperlink(id).getRange().insertText("Shortcut", { replace: true }); // replace only the text, keeping the link<br>word.getHyperlink(id).getRange().setTextFormat({ bold: true }); // format only the link text</code></pre> | — | 표시 텍스트 범위<br>[`WordRange`](#word-wordrange) |
216
+ | `update` | 하이퍼링크의 주소·설명·표시 텍스트를 수정한다. - 변경할 필드를 하나 이상 지정한다. url만 지정하면 표시 텍스트를 유지하고, displayText를 지정하면 표시 텍스트를 교체한다.<br><br><b>예제</b><pre><code>link.update({ url: "https://example.com" }); // change only the link target<br>link.update({ url: "mailto:a@b.com", displayText: "mail" }); // replace target + display text<br>link.update({ tooltip: "description" }); // change only the tooltip</code></pre> | `options` `{ url?: string; tooltip?: string; displayText?: string }` — 수정 옵션 (전 필드 생략 가능, 최소 하나)<br> · `url` 새 URL (웹 `http(s)://` · 이메일 `mailto:` · 북마크 `#name`), 생략 시 현재값 유지 (기본값: current value)<br> · `tooltip` 새 툴팁. 생략하면 현재 툴팁을 유지하지만, url 도 함께 바꾸면 툴팁이 새 url 로 바뀐다<br> · `displayText` 새 표시 텍스트 (주면 보이는 글자가 교체됨), 생략 시 현재값 유지 (기본값: current value) | — |
217
+ | `delete` | 하이퍼링크를 삭제한다. - 표시 텍스트는 문서에 남긴다. | — | — |
218
+
219
+ <a id="word-wordimage"></a>
220
+ ### Image — 이미지 (`WordImage`)
221
+
222
+ 문서 안의 이미지 크기·위치·배치와 하이퍼링크를 편집한다. - WordShape에서 제공하는 메서드로 이미지를 편집하거나 삭제한다. - 이미지를 삽입하려면 단락 또는 범위의 insertImage()를 사용한다.
223
+
224
+ > 📎 [**Shape**](#word-wordshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
225
+
226
+ | 기능 | 설명 | 입력 | 결과 |
227
+ |---|---|---|---|
228
+
229
+ <a id="word-wordlist"></a>
230
+ ### List — 목록 (`WordList`)
231
+
232
+ 목록에 속한 단락의 단계와 번호 시작 위치를 변경한다. - WordParagraph.getList()로 얻으며, 목록이 아닌 단락에서는 null을 반환한다. - 새 목록 서식은 단락 또는 범위의 setList()로 적용한다.
233
+
234
+ | 기능 | 설명 | 입력 | 결과 |
235
+ |---|---|---|---|
236
+ | `setLevel` | 이 단락의 목록 단계를 변경한다. - IndentType으로 한 단계씩 이동하거나 0부터 시작하는 숫자로 목표 단계를 지정한다. - 목록의 첫 항목에서도 해당 단락의 단계만 변경한다. 변경은 한 번에 되돌릴 수 있다. - 지정한 단계가 목록에서 지원하는 단계보다 깊으면 그 목록의 마지막 단계까지 이동한다. - 목록을 해제하려면 단락 또는 범위의 clearList()를 사용한다.<br><br><b>예제</b><pre><code>list.setLevel(IndentType.INDENT); // 1 → 1.1<br>list.setLevel(2); // set to level 2<br>list.setLevel(0); // to the outermost level (list kept)<br>list.setLevel(8); // innermost level (maximum allowed)</code></pre> | `value` `IndentType \| number` — "indent"(한 단계 안으로) \| "outdent"(한 단계 밖으로) \| 목표 단계(0~8 정수) | — |
237
+ | `restartNumbering` | 이 단락부터 번호를 다시 매긴다.<br><br><b>예제</b><pre><code>para.getList().restartNumbering(); // restart list numbering from this paragraph</code></pre> | — | — |
238
+
239
+ <a id="word-wordnote"></a>
240
+ ### Note — 각주/미주 (`WordNote`)
241
+
242
+ 각주 또는 미주를 조회하고 내용을 편집하거나 삭제한다. - getRange()로 본문의 표시 위치를 확인하고 getBody()로 각주·미주 내용을 편집한다. - 새 각주·미주는 단락 또는 범위의 insertFootnote()·insertEndnote()로 삽입한다.
243
+
244
+ | 기능 | 설명 | 입력 | 결과 |
245
+ |---|---|---|---|
246
+ | `getId` | 각주/미주 ID를 반환한다. | — | 각주/미주 ID<br>문자열 |
247
+ | `exists` | 각주/미주 존재 여부를 반환한다. | — | 존재하면 true<br>참/거짓 |
248
+ | `getRange` | 각주/미주 마커가 놓인 본문 위치 범위를 반환한다.<br><br><b>예제</b><pre><code>word.getNote(id).getRange().getLocation(); // { startParaId, startOffset, ... }</code></pre> | — | 마커 위치 범위<br>[`WordRange`](#word-wordrange) |
249
+ | `getBody` | 각주·미주의 내용 영역을 반환한다.<br><br><b>예제</b><pre><code>word.getNote(id).getBody().getText(); // get the footnote/endnote content<br>word.getNote(id).getBody().insertText("new content", { replace: true }); // replace the whole content</code></pre> | — | 내용 영역, 없으면 null<br>[`WordBody`](#word-wordbody) (없을 수 있음) |
250
+ | `getIndex` | 문서 안에서 같은 종류의 각주·미주 중 순번을 반환한다. | — | 순번, 없으면 -1<br>숫자 |
251
+ | `delete` | 각주·미주를 삭제한다. - 본문의 표시와 각주·미주 내용을 함께 삭제한다. | — | — |
252
+
253
+ <a id="word-wordparagraph"></a>
254
+ ### Paragraph — 문단 (`WordParagraph`)
255
+
256
+ 단락 하나의 내용과 서식을 조회하고 편집한다. - 텍스트·표·도형·이미지 삽입, 글자·단락 서식 설정, 목록 편집과 삭제를 제공한다. - getRange()로 단락 안의 특정 글자 범위를 조회하고 편집한다.
257
+
258
+ | 기능 | 설명 | 입력 | 결과 |
259
+ |---|---|---|---|
260
+ | `getId` | 단락 ID를 반환한다. | — | 단락 ID<br>문자열 |
261
+ | `getText` | 단락의 텍스트를 반환한다. - 반환된 텍스트에서 계산한 글자 위치는 insertText()의 offset 또는 getRange()의 글자 위치로 사용한다. - 탭은 "\t", 줄·페이지·단 나누기는 "\n", 각주·도형 등의 개체는 "\uFFFC" 한 글자로 표현한다. - 단락 끝을 나타내는 개행은 포함하지 않는다.<br><br><b>예제</b><pre><code>const text = para.getText(); // "Cherry\uFFFCQuality" — the footnote takes one slot<br>const at = text.indexOf("Quality");<br>para.getRange(at, at + 7).insertText("Status", { replace: true }); // replace only the found span</code></pre> | — | 단락 안 글자들을 이은 텍스트 (없으면 "")<br>문자열 |
262
+ | `getStructure` | 이 단락의 구조 정보를 반환한다. - 인덱스·종류·단락 ID·영역 ID·텍스트를 포함한다. | — | 이 단락 항목 하나를 담은 목록<br>`{ paragraphs: { index: number; type: string; id: string; storyId: string; text: string }[] }` |
263
+ | `getContentHtml` | 이 단락의 내용을 서식이 포함된 HTML로 반환한다. - 단락은 <p> 요소로 표현한다. | — | 이 단락 HTML·단락 수<br>`{ html: string; paragraphCount: number }` |
264
+ | `insertText` | 단락 안에 텍스트를 삽입하거나 단락 전체 내용을 교체한다. - 서식은 유지한다. 서식을 변경하거나 초기화하려면 반환된 범위의 setTextFormat()·clearFormat()·setStyle()을 사용한다.<br><br><b>예제</b><pre><code>para.insertText("hello"); // append at paragraph start (default)<br>para.insertText("world", { position: InsertAt.END }); // append at paragraph end<br>para.insertText("X", { offset: 3 }); // insert at the 3rd character position<br>para.insertText("new text", { replace: true }); // replace the entire paragraph</code></pre> | `text` 문자열 — 넣을 텍스트<br>`options` (선택) `{ offset?: number; position?: InsertAt; replace?: boolean }` — 삽입/교체 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 추가 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START)<br> · `replace` true 면 단락 전체 내용을 새 텍스트로 전체 교체(위치 인자 무시) (기본값: false) | 방금 넣은(교체 시 교체된) 텍스트 범위<br>[`WordRange`](#word-wordrange) |
265
+ | `insertShape` | 단락 안에 지정한 모양의 도형을 삽입한다. - 삽입 후 반환된 도형으로 서식과 배치를 설정한다.<br><br><b>예제</b><pre><code>para.insertShape(ShapePreset.RECT); // 100x100 rectangle at paragraph start (default)<br>para.insertShape(ShapePreset.ELLIPSE, { offset: 3 }); // insert at the 3rd character position<br>para.insertShape(ShapePreset.RECT, { position: InsertAt.END }); // insert at paragraph end</code></pre> | `preset` [`ShapePreset`](#common-shapepreset) — 도형의 기본 모양 (예: "rect", "ellipse", "roundRect")<br>`options` (선택) `{ width?: number; height?: number; offset?: number; position?: InsertAt }` — 도형 삽입 옵션<br> · `width` 너비(pt) (기본값: 75)<br> · `height` 높이(pt) (기본값: 75)<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | 삽입된 도형<br>[`WordShape`](#word-wordshape) |
266
+ | `insertTextbox` | 단락 안에 텍스트박스를 삽입한다.<br><br><b>예제</b><pre><code>para.insertTextbox({ text: "Notice" }); // insert a text box<br>para.insertTextbox({ width: 200, height: 100, offset: 3 }); // specify size and position</code></pre> | `options` (선택) `{ width?: number; height?: number; text?: string; offset?: number; position?: InsertAt }` — 텍스트박스 삽입 옵션<br> · `width` 너비(pt) (기본값: 75)<br> · `height` 높이(pt) (기본값: 75)<br> · `text` 초기 내용 텍스트<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | 생성 결과 (shape: 도형 객체 / storyId: 텍스트박스 영역 ID / paragraphId: 첫 단락 ID)<br>`{ shape: WordShape; storyId: string; paragraphId: string }` |
267
+ | `insertImage` | 단락 안에 이미지를 글자처럼 배치해 삽입한다. - 이미지 출처와 관계없이 비동기로 처리한다.<br><br><b>예제</b><pre><code>await para.insertImage({ url: "https://example.com/image.png" }); // insert an external image<br>await para.insertImage({ src: imagePath, width: 200, offset: 3 }); // specify size and position of an uploaded image</code></pre> | `options` `{ src?: string; url?: string; base64?: string; width?: number; height?: number; offset?: number; position?: InsertAt }` — 이미지 삽입 옵션 (출처 src/url/base64 중 정확히 하나 필수)<br> · `src` 이미 업로드된 이미지 경로<br> · `url` 이미지 URL (선업로드 후 삽입)<br> · `base64` base64 데이터 (선업로드 후 삽입)<br> · `width` 너비(pt). 기본값은 원본 크기 (기본값: original size)<br> · `height` 높이(pt). 기본값은 원본 크기 (기본값: original size)<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | 삽입된 이미지<br>[`WordImage`](#word-wordimage) |
268
+ | `insertWebVideo` | 단락 안에 웹 동영상을 글자처럼 배치해 삽입한다. - YouTube와 3DS 3DEXPERIENCE 주소를 지원하며 비동기로 처리한다. - 미리보기 이미지를 가져올 수 없으면 대체 이미지를 사용한다.<br><br><b>예제</b><pre><code>await para.insertWebVideo(videoUrl); // insert a video from a supported URL<br>await para.insertWebVideo(videoUrl, { width: 320, height: 180, position: InsertAt.END }); // specify size at paragraph end</code></pre> | `url` 문자열 — 웹 동영상 URL (YouTube / 3DS 3DEXPERIENCE)<br>`options` (선택) `{ width?: number; height?: number; offset?: number; position?: InsertAt }` — 웹 동영상 삽입 옵션<br> · `width` 너비(pt). 기본값은 썸네일 원본 크기 (기본값: original thumbnail size)<br> · `height` 높이(pt). 기본값은 썸네일 원본 크기 (기본값: original thumbnail size)<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | 삽입된 웹 동영상 이미지 객체<br>[`WordImage`](#word-wordimage) |
269
+ | `insertLineBreak` | 단락 안에 줄 나누기를 삽입한다. - Shift+Enter처럼 단락을 유지하면서 줄만 바꾼다.<br><br><b>예제</b><pre><code>para.insertLineBreak(); // line break at paragraph start<br>para.insertLineBreak({ offset: 3 }); // line break at the given character position</code></pre> | `options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). 단락 끝을 넘는 위치는 단락 끝으로 보정한다. position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | — |
270
+ | `insertTab` | 단락 안에 탭 문자를 삽입한다. - 탭 정지 위치는 setTabs()로 별도 설정한다.<br><br><b>예제</b><pre><code>para.insertTab(); // insert a tab at paragraph start<br>para.insertTab({ position: InsertAt.END }); // insert a tab at paragraph end</code></pre> | `options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). 단락 끝을 넘는 위치는 단락 끝으로 보정한다. position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | — |
271
+ | `insertSymbol` | 단락 안에 기호를 삽입한다. - font 미지정: 해당 유니코드 문자를 일반 텍스트로 삽입한다. - font 지정: 그 글꼴의 기호 글리프로 삽입한다.<br><br><b>예제</b><pre><code>para.insertSymbol("2605"); // insert ★ at paragraph start<br>para.insertSymbol("F0FC", { font: "Wingdings" }); // Wingdings check mark symbol</code></pre> | `charCode` `string \| number` — 유니코드 코드포인트(16진 문자열 "2605" \| "0x2605" \| 숫자 0x2605)<br>`options` (선택) `{ font?: string; offset?: number; position?: InsertAt }` — 기호 삽입 옵션<br> · `font` 지정 시 그 글꼴의 기호 글리프로 삽입<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | — |
272
+ | `insertSectionBreak` | 단락 위치에 구역 나누기를 삽입해 새 구역을 만든다. - 구역 나누기는 본문에만 삽입할 수 있다(머리글/바닥글/텍스트박스에는 불가).<br><br><b>예제</b><pre><code>para.insertSectionBreak(SectionBreakType.NEXT_PAGE); // break at paragraph start (default)<br>para.insertSectionBreak(SectionBreakType.CONTINUOUS, { position: InsertAt.END }); // break at paragraph end<br>para.insertSectionBreak(SectionBreakType.CONTINUOUS, { offset: 5 }); // break at the 5th character position</code></pre> | `type` [`SectionBreakType`](#word-sectionbreaktype) — 새 구역의 시작 유형 (continuous: 이어서 / nextPage: 다음 페이지부터 / evenPage: 짝수 페이지부터 / oddPage: 홀수 페이지부터)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | — |
273
+ | `insertPageBreak` | 단락 안에 페이지 나누기를 삽입한다. - 뒤 내용은 다음 페이지에서 시작한다. 본문에만 삽입할 수 있다.<br><br><b>예제</b><pre><code>para.insertPageBreak(); // page break at paragraph start<br>para.insertPageBreak({ offset: 3 }); // break at the given character position</code></pre> | `options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | — |
274
+ | `insertColumnBreak` | 단락 안에 단 나누기를 삽입한다. - 뒤 내용은 다음 단에서 시작하며, 구역이 1단이면 다음 페이지에서 시작한다. 본문에만 삽입할 수 있다.<br><br><b>예제</b><pre><code>para.insertColumnBreak(); // column break at paragraph start<br>para.insertColumnBreak({ position: InsertAt.END }); // break at paragraph end</code></pre> | `options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | — |
275
+ | `insertFootnote` | 단락 위치에 각주를 삽입한다.<br><br><b>예제</b><pre><code>para.insertFootnote("Source: report"); // insert a footnote at paragraph start<br>para.insertFootnote("Additional note", { offset: 3 }); // insert at the given character position</code></pre> | `text` (선택) 문자열 — 각주 내용 초기 텍스트. 기본값은 빈 각주 (기본값: empty footnote)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | 생성된 각주 객체<br>[`WordNote`](#word-wordnote) |
276
+ | `insertEndnote` | 단락 위치에 미주를 삽입한다.<br><br><b>예제</b><pre><code>para.insertEndnote("References"); // insert an endnote at paragraph start<br>para.insertEndnote("Further note", { position: InsertAt.END }); // insert at paragraph end</code></pre> | `text` (선택) 문자열 — 미주 내용 초기 텍스트. 기본값은 빈 미주 (기본값: empty endnote)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 위치 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는). position 보다 우선<br> · `position` 삽입 위치(offset 없을 때). start(단락 시작) \| end(단락 끝) (기본값: InsertAt.START) | 생성된 미주 객체<br>[`WordNote`](#word-wordnote) |
277
+ | `insertParagraph` | 이 단락의 위·아래에 새 단락을 삽입하거나 지정한 글자 위치에서 단락을 나눈다. - 새 단락은 이 단락의 정렬·여백·들여쓰기 등 직접 단락 서식을 상속한다. - 상속한 직접 서식을 초기화하려면 반환된 단락의 clearFormat()을 호출한다.<br><br><b>예제</b><pre><code>para.insertParagraph("below"); // add below this paragraph<br>para.insertParagraph("above", { position: InsertAt.BEFORE }); // add above this paragraph<br>para.insertParagraph("", { offset: 3 }); // split the paragraph at the 3rd character position (following content preserved)</code></pre> | `text` 문자열 — 새 단락 텍스트 (빈 문자열이면 빈 단락 — offset 지정 시엔 순수 나누기)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — 삽입 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는)에서 나누기(뒤 내용은 새 단락으로 보존). 단락 끝을 넘는 위치는 단락 끝으로 보정한다. 지정 시 position 무시<br> · `position` 형제 삽입 시 이 단락 기준 "before"(위)/"after"(아래) (기본값: InsertAt.AFTER) | 새로 생성된 단락 객체<br>[`WordParagraph`](#word-wordparagraph) |
278
+ | `insertTable` | 이 단락 위/아래에 표를 삽입하거나, 단락 안 글자 위치에서 나눠 그 사이에 삽입한다. - 표 셀 안에는 삽입할 수 없다(중첩 표 미지원 — 삽입 지점이 셀 안이면 오류 발생).<br><br><b>예제</b><pre><code>para.insertTable(3, 4); // 3x4 table below this paragraph<br>para.insertTable(2, 2, { position: InsertAt.BEFORE }); // insert above this paragraph<br>para.insertTable(2, 2, { offset: 3 }); // split at the 3rd character position and insert between the parts<br>para.insertTable(2, 2, { values: [["a", "b"], ["c", "d"]] }); // fill cells on creation</code></pre> | `rows` 숫자 — 행 수<br>`columns` 숫자 — 열 수<br>`options` (선택) `{ offset?: number; position?: InsertAt; values?: string[][] }` — 삽입 옵션<br> · `offset` 단락 내 글자 위치(0부터 시작하는)에서 나누고 그 사이에 표 삽입(뒤 내용은 새 단락으로 보존). 지정 시 position 무시<br> · `position` 형제 삽입 시 이 단락 기준 "before"(위)/"after"(아래) (기본값: InsertAt.AFTER)<br> · `values` 생성 직후 채울 셀 값(2차원 배열, 표 크기 초과 시 발행 전 오류 발생) | 삽입된 표 객체<br>[`WordTable`](#word-wordtable) |
279
+ | `setTextFormat` | 단락 전체 텍스트에 글자 서식을 적용한다.<br><br><b>예제</b><pre><code>para.setTextFormat({ bold: true }); // make all text in the paragraph bold<br>para.setTextFormat({ size: 12, color: "#FF0000" }); // set size and color</code></pre> | `options` [`TextFormat`](#word-textformat) — 적용할 글자 서식 | — |
280
+ | `clearFormat` | 단락 전체의 글자 서식과 단락 서식을 초기화한다. | — | — |
281
+ | `select` | 이 단락을 화면 선택 영역으로 지정한다. - 문서 내용은 변경하지 않는다.<br><br><b>예제</b><pre><code>para.select(); // select the entire paragraph<br>para.select(SelectionMode.END); // place the cursor at paragraph end</code></pre> | `mode` (선택) [`SelectionMode`](#word-selectionmode) — "select"(단락 전체) / "start"(단락 시작에 커서) / "end"(단락 끝에 커서) (기본값: SelectionMode.SELECT) | — |
282
+ | `setParagraphFormat` | 이 단락에 지정한 단락 서식을 적용한다. - 지정한 필드만 변경한다. 글자 서식은 setTextFormat()으로 설정한다.<br><br><b>예제</b><pre><code>para.setParagraphFormat({ align: TextAlign.CENTER }); // center alignment<br>para.setParagraphFormat({ lineSpacing: 1.5, spaceAfter: 10 }); // 1.5x line spacing, 10pt space after paragraph<br>para.setParagraphFormat({ leftIndent: 20, align: null }); // 20pt left indent, remove alignment</code></pre> | `options` [`ParagraphFormat`](#word-paragraphformat) — 적용할 단락 서식 | — |
283
+ | `setParagraphBorder` | 이 단락에 테두리를 설정한다. - 셀 테두리와 같은 Border 형식을 사용한다.<br><br><b>예제</b><pre><code>para.setParagraphBorder({ location: BorderLocation.ALL, style: BorderStyle.SOLID, color: "#0000FF", width: 1 }); // blue solid line on all four sides and between paragraphs<br>para.setParagraphBorder({ location: BorderLocation.BOTTOM, style: BorderStyle.DOUBLE, color: "#000000", width: 2 }); // double line on the bottom only<br>para.setParagraphBorder({ location: BorderLocation.ALL, style: BorderStyle.NONE, color: "#000000", width: 0 }); // remove borders</code></pre> | `border` [`Border`](#word-border) — 테두리 값 | — |
284
+ | `setTabs` | 이 단락의 탭 정지 위치를 설정한다. - 지정한 배열로 기존 설정을 교체하며, 빈 배열은 모든 탭 정지 위치를 제거한다.<br><br><b>예제</b><pre><code>para.setTabs([{ position: 72, alignment: TabAlignment.LEFT }]); // left-aligned tab at 72pt (1 inch)<br>para.setTabs([]); // remove all tab stops</code></pre> | `tabs` [`TabStop`](#word-tabstop) 목록 — 탭 스톱 배열 | — |
285
+ | `setStyle` | 이 단락에 스타일을 적용한다. - 스타일을 적용하면 기존 직접 서식을 초기화한다. - 단락 스타일은 단락에, 글자 스타일은 단락 전체 텍스트에 적용한다.<br><br><b>예제</b><pre><code>para.setStyle(Style.HEADING_1); // Heading 1 paragraph style<br>para.setStyle("MyCustomStyle"); // custom document style (key obtained from getStyles)<br>para.setStyle(null); // remove the style (revert to default)</code></pre> | `style` `Style \| string \| null` — 내장 스타일은 Style enum(값=키), 커스텀 문서 스타일은 getStyles() 의 style 값. null 이면 스타일 제거(기본으로 복귀) | — |
286
+ | `setIndent` | 들여쓰기/내어쓰기를 한 단계 조정한다. - 목록 단락이면 목록 단계가, 목록이 아니면 단락 좌여백이 움직인다. - 목록 첫 항목이어도 그 항목의 단계만 움직인다.<br><br><b>예제</b><pre><code>para.setIndent(IndentType.INDENT); // indent one level<br>para.setIndent(IndentType.OUTDENT); // outdent one level</code></pre> | `type` [`IndentType`](#word-indenttype) — "indent"(들여쓰기)\|"outdent"(내어쓰기) | — |
287
+ | `getRange` | 이 단락에서 지정한 글자 위치 구간의 범위를 반환한다.<br><br><b>예제</b><pre><code>para.getRange(); // range of the paragraph content<br>para.getRange(0, 5); // range of characters 0 to 5<br>para.getRange(3); // from the 3rd character to paragraph end</code></pre> | `startOffset` (선택) 숫자 — 시작 글자 위치(0부터 시작하는). 기본값은 단락 시작 (기본값: paragraph start)<br>`endOffset` (선택) 숫자 — 끝 글자 위치. 기본값은 단락 끝 (기본값: paragraph end) | 단락 내 offset 범위에 바인딩된 범위 객체<br>[`WordRange`](#word-wordrange) |
288
+ | `getComments` | 이 단락 범위와 겹치는 댓글 목록을 반환한다. | — | 댓글 목록<br>[`WordComment`](#word-wordcomment) 목록 |
289
+ | `getChangeTrackings` | 이 단락과 겹치는 변경 추적 항목 목록을 반환한다. | — | 변경 추적 목록<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
290
+ | `acceptChangeTrackings` | 이 단락과 겹치는 모든 변경 추적 항목을 수락한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
291
+ | `rejectChangeTrackings` | 이 단락과 겹치는 모든 변경 추적 항목을 거부한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
292
+ | `getNotes` | 이 단락 안의 각주/미주 목록을 반환한다. | — | 각주·미주 목록<br>[`WordNote`](#word-wordnote) 목록 |
293
+ | `getFootnotes` | 이 단락 안의 각주 목록을 반환한다. | — | 각주 목록<br>[`WordNote`](#word-wordnote) 목록 |
294
+ | `getEndnotes` | 이 단락 안의 미주 목록을 반환한다. | — | 미주 목록<br>[`WordNote`](#word-wordnote) 목록 |
295
+ | `getPreviousSibling` | 바로 앞에 있는 단락을 반환한다. - 앞 요소가 표 등 단락이 아니거나 존재하지 않으면 null을 반환한다. 구역 경계는 넘지 않는다. | — | 이전 단락. 없거나 앞 요소가 단락이 아니면 null<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
296
+ | `getNextSibling` | 바로 뒤에 있는 단락을 반환한다. - 뒤 요소가 표 등 단락이 아니거나 존재하지 않으면 null을 반환한다. 구역 경계는 넘지 않는다. | — | 다음 단락. 없거나 뒤 요소가 단락이 아니면 null<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
297
+ | `getParentBody` | 이 단락이 속한 영역(본문/머리글/바닥글 등)을 반환한다. | — | 이 단락이 속한 영역<br>[`WordBody`](#word-wordbody) |
298
+ | `getParentTable` | 이 단락이 속한 가장 가까운 표를 반환한다. - 표 밖의 단락은 null을 반환한다. 중첩 표에서는 안쪽 표를 반환한다. | — | 상위 표 객체, 표 밖이면 null<br>[`WordTable`](#word-wordtable) (없을 수 있음) |
299
+ | `getParentTableCell` | 이 단락이 속한 가장 가까운 표 셀을 반환한다. - 셀 밖의 단락은 null을 반환한다. 중첩 표에서는 안쪽 셀을 반환한다. | — | 상위 셀 객체, 셀 밖이면 null<br>[`WordTableCell`](#word-wordtablecell) (없을 수 있음) |
300
+ | `setList` | 이 단락에 지정한 목록 서식을 적용한다. - 기존 목록에 적용하면 같은 목록의 같은 단계 항목도 함께 바뀐다. - 다단계 목록을 적용하면 목록 전체에 반영한다. - 목록 단계는 적용 후 getList()로 얻은 목록의 setLevel()로 변경한다.<br><br><b>예제</b><pre><code>para.setList(ListType.BULLET_CIRCLE); // circle bullet ●<br>para.setList(ListType.NUMBER_CIRCLED); // circled number ①<br>para.setList(ListType.MULTILEVEL_NESTED_NUMBER); // multilevel 1 / 1.1 / 1.1.1</code></pre> | `listType` [`ListType`](#word-listtype) — 적용할 목록 종류. 기본 제공 글머리 기호·번호·다단계 목록 중 선택한다. | — |
301
+ | `getList` | 이 단락의 목록을 반환한다. - 목록 단계 변경과 번호 다시 매기기에 사용한다.<br><br><b>예제</b><pre><code>const list = para.getList();<br>if (list) {<br> list.setLevel(IndentType.INDENT); // one level deeper<br> list.restartNumbering(); // restart numbering from this paragraph<br>}</code></pre> | — | 목록 핸들, 목록이 아닌 단락이면 null<br>[`WordList`](#word-wordlist) (없을 수 있음) |
302
+ | `clearList` | 이 단락의 목록을 해제한다. - 여러 단락을 한 번에 해제하려면 WordRange 의 clearList 를 쓴다. | — | — |
303
+ | `delete` | 단락을 삭제한다. - 뒤에 다른 단락이 없으면 단락을 유지하고 글자만 삭제한다. | — | — |
304
+
305
+ <a id="word-wordrange"></a>
306
+ ### Range — 텍스트 범위 (`WordRange`)
307
+
308
+ 문서의 지정한 범위 안에서 내용을 조회하고 편집한다. - 글자·단락 서식 설정, 콘텐츠 삽입, 검색, 목록 편집과 삭제를 제공한다. - 문서 좌표, 선택 영역 또는 단락·각주 등의 getRange()로 얻은 범위를 같은 방식으로 다룬다. - 선택 영역이나 각주 표시 위치로 얻은 범위는 호출 시점의 위치를 사용한다.
309
+
310
+ | 기능 | 설명 | 입력 | 결과 |
311
+ |---|---|---|---|
312
+ | `getLocation` | 이 범위의 시작/끝 위치를 단락 좌표로 반환한다. - 선택·커서·각주 마커처럼 좌표 없이 만든 범위도 현재 위치를 계산해 돌려준다. 반환 형태가 `getRange` 인자와 같아, 그대로 넘기면 같은 범위를 다시 만든다.<br><br><b>예제</b><pre><code>range.getLocation(); // get the start/end paragraphs and character positions<br>doc.getSelection().getLocation(); // get the coordinates of the current selection</code></pre> | — | 시작/끝 단락 ID·글자 offset·영역 ID<br>`{ startParaId: string; startOffset: number; endParaId: string; endOffset: number; storyId: string }` |
313
+ | `getText` | 이 범위에 포함된 텍스트를 반환한다. - 단락 경계는 "\n"으로 구분한다. 한 단락 안에서는 반환 텍스트의 글자 위치에 getLocation().startOffset을 더해 단락의 글자 위치를 구한다. - 여러 단락에 걸친 범위에서는 이 계산을 사용할 수 없다. - 탭은 "\t", 줄·페이지·단 나누기는 "\n", 각주·도형 등의 개체는 "" 한 글자로 표현한다.<br><br><b>예제</b><pre><code>range.getText(); // get the text of this range<br>doc.getSelection().getText(); // get the selected text</code></pre> | — | 범위 텍스트(빈 범위/커서면 "")<br>문자열 |
314
+ | `isCollapsed` | 이 범위가 시작과 끝이 같은 빈 범위인지 확인한다. - 커서만 있는 범위는 true, 선택한 글자나 검색 결과를 포함하는 범위는 false를 반환한다.<br><br><b>예제</b><pre><code>doc.getRange({ startParaId: id, startOffset: 3, endOffset: 3 }).isCollapsed(); // empty range: true<br>doc.getRange({ startParaId: id, startOffset: 0, endOffset: 5 }).isCollapsed(); // character range: false</code></pre> | — | 빈 범위이면 true<br>참/거짓 |
315
+ | `getStructure` | 이 범위가 걸친 단락/표 구조를 반환한다. - 범위 시작 단락부터 끝 단락까지(사이의 표 포함)를 문서 순서로 담는다. | — | 범위가 걸친 단락·표 항목 목록<br>`{ paragraphs: { index: number; type: string; id: string; storyId: string; text?: string; rows?: number; columns?: number }[] }` |
316
+ | `getContentHtml` | 이 범위에 걸친 단락 내용을 서식이 포함된 HTML로 반환한다. - 시작 단락부터 끝 단락까지 문서 순서로 포함하며, 표 안의 단락도 <p> 요소로 표현한다. | — | 범위 HTML·단락 수<br>`{ html: string; paragraphCount: number }` |
317
+ | `search` | 이 범위 안에서 텍스트 또는 특수 문자(페이지 나누기/단 나누기/줄바꿈/탭/기호)를 찾아, 편집할 수 있는 범위를 반환한다.<br><br><b>예제</b><pre><code>range.search("hello"); // plain text search within this range<br>range.search("Hello", { caseSensitive: true }); // case-sensitive matching<br>range.search("cat", { wholeWord: true }); // only the standalone word "cat" (excludes cat in catalog)<br>range.search({ character: SpecialCharacter.TAB }); // find tab characters<br>const hits = range.search("draft"); // only matches fully contained in this range<br>hits.forEach((hit) =&gt; hit.setTextFormat({ bold: true })); // returned ranges are directly editable</code></pre> | `query` `string \| { character: SpecialCharacter }` — 문자열이면 텍스트 검색, `{ character }` 객체이면 특수 문자 검색<br>`options` (선택) `{ caseSensitive?: boolean; wholeWord?: boolean }` — 텍스트 검색 옵션(특수 문자 검색은 무시)<br> · `caseSensitive` 대소문자 구분 (기본값: false)<br> · `wholeWord` 단어 단위 검색 (매치 앞뒤가 공백·문장부호·문서 경계일 때만 채택) (기본값: false) | 이 범위 안에서 매칭된 범위 목록 (없으면 빈 배열)<br>[`WordRange`](#word-wordrange) 목록 |
318
+ | `setTextFormat` | 범위에 글자 서식을 적용한다.<br><br><b>예제</b><pre><code>range.setTextFormat({ bold: true }); // bold<br>range.setTextFormat({ size: 12, color: "#FF0000" }); // set size and color together<br>range.setTextFormat({ bold: null }); // remove the bold property (restore inheritance)</code></pre> | `options` [`TextFormat`](#word-textformat) — 적용할 글자 서식 (지정한 필드만 변경. 값 대신 null 을 주면 그 속성을 제거해 스타일 상속으로 되돌린다) | — |
319
+ | `clearFormat` | 범위의 글자 서식과 단락 서식을 초기화한다. - 단락 서식은 단락 기호가 범위에 포함된 단락만 초기화한다. | — | — |
320
+ | `setStyle` | 이 범위에 스타일을 적용한다. - 기존 직접 서식은 초기화한다. 단락 스타일은 범위에 걸친 단락들에, 글자 스타일은 범위 텍스트에 적용한다.<br><br><b>예제</b><pre><code>range.setStyle(Style.HEADING_1); // apply the Heading 1 style<br>range.setStyle(null); // remove the character style (the paragraph style stays)</code></pre> | `style` `Style \| string \| null` — 내장 스타일은 Style enum(값=키), 커스텀 문서 스타일은 getStyles() 의 style 값. null 이면 글자 스타일만 제거, 단락 스타일은 유지. | — |
321
+ | `delete` | 범위의 텍스트를 삭제한다. | — | — |
322
+ | `insertHyperlink` | 이 범위에 하이퍼링크를 건다. - displayText 를 주면 그 텍스트가 범위 텍스트를 대체하며 링크를 갖는다. 없으면 범위의 기존 텍스트에 그대로 링크를 입힌다. - 빈 범위는 링크를 입힐 텍스트가 없으므로 displayText 가 필수다. - 링크 종류는 url 을 보고 자동으로 정해진다(웹 `http(s)://`·이메일 `mailto:`·북마크 `#name`, 스킴 없으면 https://).<br><br><b>예제</b><pre><code>range.insertHyperlink("https://example.com"); // web link on the range text<br>doc.getSelection().insertHyperlink("mailto:a@b.com", { displayText: "Email" }); // insert as new text at the cursor<br>range.insertHyperlink("#bookmark1", { tooltip: "Go to" }); // bookmark link + tooltip</code></pre> | `url` 문자열 — 링크 목적지<br>`options` (선택) `{ tooltip?: string; displayText?: string }` — 하이퍼링크 옵션<br> · `tooltip` 마우스오버 툴팁 (기본값: url)<br> · `displayText` 범위 텍스트 대신 보여줄 텍스트(빈 범위면 필수) | 삽입된 하이퍼링크, 신규 id 식별 실패 시 null<br>[`WordHyperlink`](#word-wordhyperlink) (없을 수 있음) |
323
+ | `getHyperlink` | 이 범위에 걸린 하이퍼링크를 반환한다. - 시작 지점의 링크를 쓰고, 시작 지점에 링크가 없으면 끝 지점의 링크를 쓴다. 그래서 범위가 여러 링크를 걸치면 시작 링크가 나온다. - 두 끝 지점만 본다 — 어느 지점에도 닿지 않고 범위 안에만 들어 있는 링크는 찾지 않는다. | — | 하이퍼링크 객체, 두 지점 모두 링크가 없으면 null<br>[`WordHyperlink`](#word-wordhyperlink) (없을 수 있음) |
324
+ | `setParagraphFormat` | 이 범위에 걸친 단락들에 단락 서식을 적용한다. - 지정한 필드만 변경하며, null은 해당 속성을 제거해 스타일의 서식을 따르게 한다.<br><br><b>예제</b><pre><code>range.setParagraphFormat({ align: TextAlign.CENTER }); // center alignment<br>range.setParagraphFormat({ lineSpacing: 1.5, spaceAfter: 10 }); // line spacing and space after the paragraph</code></pre> | `options` [`ParagraphFormat`](#word-paragraphformat) — 적용할 단락 서식 | — |
325
+ | `getFormat` | 이 범위 시작 위치의 글자 서식과 단락 서식을 반환한다. - 범위 안의 서식이 서로 달라도 시작 위치의 직접 서식을 반환한다. | — | 시작 위치의 글자·단락 서식(없는 항목은 생략)<br>`{ textFormat?: TextFormat; paragraphFormat?: ParagraphFormat }` |
326
+ | `copyFormatTo` | 이 범위 시작 위치의 스타일과 서식(글자+단락)을 대상 범위에 복사해 적용한다. - 기준은 이 범위의 **시작 지점 한 곳**에서만 읽는다 — 범위가 여러 단락에 걸쳐도 첫 단락의 서식만 가져온다. - 대상 단락 서식도 같은 이유로 대상 범위의 **첫 단락**에만 걸린다. - **대상이 빈 단락이거나 커서면 단락 서식만 걸리고 글자 서식은 걸리지 않는다** — 서식을 입힐 글자가 없기 때문이며, 그 단락에 나중에 넣는 글자도 기준의 글자 서식을 따라가지 않는다.<br><br><b>예제</b><pre><code>range.copyFormatTo(targetRange); // copy the formatting at the start position to the target range</code></pre> | `targetRange` [`WordRange`](#word-wordrange) — 서식을 적용받을 범위 | — |
327
+ | `setParagraphBorder` | 이 범위에 걸친 단락들에 테두리를 설정한다. - 셀 테두리와 같은 Border 형식을 사용하며 location으로 적용할 면을 지정한다.<br><br><b>예제</b><pre><code>range.setParagraphBorder({ location: BorderLocation.ALL, style: BorderStyle.SOLID, color: "#0000FF", width: 1 }); // all four sides of the paragraphs in the range + lines between them<br>range.setParagraphBorder({ location: BorderLocation.TOP, style: BorderStyle.DOTTED, color: "#888888", width: 1 }); // dotted line on the top only</code></pre> | `border` [`Border`](#word-border) — 테두리 값 (단락·셀·페이지 공용) | — |
328
+ | `setTabs` | 이 범위에 걸친 단락들의 탭 정지 위치를 설정한다. - 지정한 배열로 기존 설정을 교체하며, 빈 배열은 모든 탭 정지 위치를 제거한다.<br><br><b>예제</b><pre><code>range.setTabs([{ position: 96, alignment: TabAlignment.LEFT }]); // set tab stops on the paragraphs in the range<br>range.setTabs([]); // remove all tab stops</code></pre> | `tabs` [`TabStop`](#word-tabstop) 목록 — 탭 스톱 배열 | — |
329
+ | `setIndent` | 범위에 걸친 단락들의 들여쓰기/내어쓰기를 한 단계 조정한다. - 목록 단락이면 목록 단계가, 목록이 아니면 단락 좌여백이 움직인다. - 시작 단락이 목록 첫 항목이어도 그 항목의 단계만 움직인다.<br><br><b>예제</b><pre><code>range.setIndent(IndentType.INDENT); // indent the paragraphs in the range<br>range.setIndent(IndentType.OUTDENT); // outdent the paragraphs in the range</code></pre> | `type` [`IndentType`](#word-indenttype) — "indent"(들여쓰기)\|"outdent"(내어쓰기) | — |
330
+ | `setList` | 이 범위에 걸친 단락들에 목록 서식을 적용한다. - 빈 범위는 커서가 있는 단락에 적용한다. 여러 단락을 포함하면 해당 단락 전체에 적용한다. - 커서가 기존 목록 안에 있으면 같은 목록의 같은 단계 항목도 함께 바뀐다. 다단계 목록은 목록 전체에 반영한다.<br><br><b>예제</b><pre><code>doc.getSelection().setList(ListType.NUMBER_DECIMAL); // number the selected paragraphs</code></pre> | `listType` [`ListType`](#word-listtype) — 적용할 목록 종류. 기본 제공 글머리 기호·번호·다단계 목록 중 선택한다. | — |
331
+ | `clearList` | 범위에 걸친 단락들의 목록을 해제한다.<br><br><b>예제</b><pre><code>doc.getSelection().clearList(); // remove lists from the selected range</code></pre> | — | — |
332
+ | `getParagraph` | 이 범위의 시작 단락을 반환한다. - 반환된 단락을 통해 단락 전체의 내용과 서식을 편집한다. - 좌표 범위는 여기서 검사하지 않는다 — 없는 단락 ID 면 반환된 단락을 사용할 때 오류가 난다. | — | 시작 단락 객체<br>[`WordParagraph`](#word-wordparagraph) |
333
+ | `getParentSection` | 이 범위의 시작 위치가 속한 구역을 반환한다. - 머리글·바닥글 등 본문 밖에서 구역을 특정할 수 없으면 null을 반환한다. | — | 구역 객체, 본문 구역을 찾을 수 없으면 null<br>[`WordSection`](#word-wordsection) (없을 수 있음) |
334
+ | `getComments` | 이 범위와 겹치는 댓글 목록을 반환한다. | — | 댓글 목록<br>[`WordComment`](#word-wordcomment) 목록 |
335
+ | `getChangeTrackings` | 이 범위와 겹치는 변경 추적 항목 목록을 문서 순서로 반환한다. | — | 변경 추적 목록<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
336
+ | `acceptChangeTrackings` | 이 범위와 겹치는 모든 변경 추적 항목을 수락한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
337
+ | `rejectChangeTrackings` | 이 범위와 겹치는 모든 변경 추적 항목을 거부한다. | — | 처리 결과<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
338
+ | `getNotes` | 이 범위 안의 각주·미주 목록을 반환한다. | — | 각주·미주 목록<br>[`WordNote`](#word-wordnote) 목록 |
339
+ | `getFootnotes` | 이 범위 안의 각주 목록을 반환한다. | — | 각주 목록<br>[`WordNote`](#word-wordnote) 목록 |
340
+ | `getEndnotes` | 이 범위 안의 미주 목록을 반환한다. | — | 미주 목록<br>[`WordNote`](#word-wordnote) 목록 |
341
+ | `getShapes` | 이 범위 안의 도형·이미지·차트 목록을 반환한다. - 글자처럼 배치한 도형과 글 앞·뒤에 배치한 도형을 모두 포함한다. | — | 도형 목록(그림은 WordImage, 차트는 WordChart, 없으면 빈 배열)<br>`(WordShape \| WordImage \| WordChart)[]` |
342
+ | `getBookmarks` | 범위 안에 마커가 놓인 책갈피 목록을 반환한다. | — | 책갈피 목록(없으면 빈 배열)<br>[`WordBookmark`](#word-wordbookmark) 목록 |
343
+ | `getHyperlinks` | 이 범위와 겹치는 텍스트 하이퍼링크 목록을 반환한다. | — | 하이퍼링크 목록(없으면 빈 배열)<br>[`WordHyperlink`](#word-wordhyperlink) 목록 |
344
+ | `insertText` | 이 범위에 텍스트를 넣는다. - replace 미지정: 범위의 한쪽 끝 지점에 삽입한다(구간이어도 원래 텍스트는 남는다). position 으로 어느 끝인지 정한다. - replace: true: 범위 텍스트를 새 텍스트로 교체한다(한 지점이면 그 자리에 삽입, position 무시). 텍스트만 다루며 서식은 그대로 둔다. 서식 변경은 반환된 범위에 따로 적용한다.<br><br><b>예제</b><pre><code>range.insertText("prepended"); // insert at the range start<br>range.insertText("appended", { position: InsertAt.AFTER }); // insert at the range end<br>range.insertText("new content", { replace: true }); // replace the range content</code></pre> | `text` 문자열 — 넣을 텍스트<br>`options` (선택) `{ position?: InsertAt; replace?: boolean }` — 삽입/교체 옵션<br> · `position` 범위 기준 "before"(시작 지점, 매치 앞) / "after"(끝 지점, 매치 뒤). replace:true 면 무시. (기본값: InsertAt.BEFORE)<br> · `replace` true 면 범위 텍스트를 새 텍스트로 교체(position 무시) | 삽입되거나 교체된 새 텍스트 범위(반환 범위에 setTextFormat 등을 바로 적용할 수 있다)<br>[`WordRange`](#word-wordrange) |
345
+ | `select` | 이 범위를 화면 선택 영역으로 지정한다. - 문서 내용은 변경하지 않는다.<br><br><b>예제</b><pre><code>range.select(); // select the whole range<br>range.select(SelectionMode.END); // place the cursor at the range end<br>doc.getSelection().select(SelectionMode.START); // collapse the current selection to a cursor at its start</code></pre> | `mode` (선택) [`SelectionMode`](#word-selectionmode) — "select"(범위 전체) / "start"(시작 지점에 커서) / "end"(끝 지점에 커서) (기본값: SelectionMode.SELECT) | — |
346
+ | `insertParagraph` | 이 범위의 기준 단락 위·아래에 새 단락을 삽입한다. - 새 단락은 기준 단락의 정렬·여백·들여쓰기 등 직접 단락 서식을 상속한다. - 상속한 직접 서식을 초기화하려면 반환된 단락의 clearFormat()을 호출한다.<br><br><b>예제</b><pre><code>range.insertParagraph("new paragraph"); // add below the range paragraph<br>range.insertParagraph("above", { position: InsertAt.BEFORE }); // add above the range paragraph</code></pre> | `text` 문자열 — 새 단락 텍스트<br>`options` (선택) `{ position?: InsertAt }` — 삽입 옵션<br> · `position` 범위 단락 기준 "before"(위)/"after"(아래) (기본값: InsertAt.AFTER) | 새로 생성된 단락 객체<br>[`WordParagraph`](#word-wordparagraph) |
347
+ | `insertTable` | 범위의 단락 기준으로 표를 삽입한다. - 표 셀 안에는 삽입할 수 없다(중첩 표 미지원 — 삽입 지점이 셀 안이면 오류 발생).<br><br><b>예제</b><pre><code>range.insertTable(3, 4); // 3x4 table below the range paragraph<br>range.insertTable(2, 2, { position: InsertAt.BEFORE }); // insert above the range paragraph<br>range.insertTable(2, 2, { values: [["a", "b"], ["c", "d"]] }); // fill cells on creation</code></pre> | `rows` 숫자 — 행 수<br>`columns` 숫자 — 열 수<br>`options` (선택) `{ position?: InsertAt; values?: string[][] }` — 삽입 옵션<br> · `position` 범위 단락 기준 "before"(위)/"after"(아래) (기본값: InsertAt.AFTER)<br> · `values` 생성 직후 채울 셀 값(2차원 배열, 표 크기 초과 시 발행 전 오류 발생) | 삽입된 표 객체<br>[`WordTable`](#word-wordtable) |
348
+ | `insertShape` | 이 범위의 단락에 지정한 모양의 도형을 삽입한다. - 반환된 도형으로 서식과 배치를 설정한다.<br><br><b>예제</b><pre><code>range.insertShape(ShapePreset.RECT); // insert a rectangle<br>range.insertShape(ShapePreset.ELLIPSE, { width: 200, height: 100 }); // ellipse with a specified size</code></pre> | `preset` [`ShapePreset`](#common-shapepreset) — 도형의 기본 모양 (예: "rect", "ellipse", "roundRect")<br>`options` (선택) [`Size`](#word-size) — 크기(pt, 생략한 축은 75) | 삽입된 도형<br>[`WordShape`](#word-wordshape) |
349
+ | `insertTextbox` | 범위의 단락에 텍스트박스를 삽입한다.<br><br><b>예제</b><pre><code>range.insertTextbox({ text: "Notice" }); // insert a text box<br>range.insertTextbox({ width: 200, height: 100, text: "Description" }); // specify size and content</code></pre> | `options` (선택) `Size & { text?: String }` — 텍스트박스 생성 옵션 (크기 생략한 축은 100, text 는 초기 내용) | 생성 결과 (shape: 도형 객체 / storyId: 텍스트박스 영역 ID / paragraphId: 첫 단락 ID)<br>`{ shape: WordShape; storyId: string; paragraphId: string }` |
350
+ | `insertImage` | 이 범위 시작 위치에 이미지를 글자처럼 배치해 삽입한다. - 이미지 출처와 관계없이 비동기로 처리한다.<br><br><b>예제</b><pre><code>await range.insertImage({ url: "https://example.com/image.png" }); // insert an external image<br>await range.insertImage({ src: imagePath, width: 200, height: 150 }); // insert an uploaded image (size required)</code></pre> | `options` `{ src?: string; url?: string; base64?: string; width?: number; height?: number }` — 이미지 삽입 옵션 (출처 src/url/base64 중 정확히 하나 필수)<br> · `src` 이미 업로드된 이미지 경로<br> · `url` 이미지 URL (선업로드 후 삽입)<br> · `base64` base64 데이터 (선업로드 후 삽입)<br> · `width` 너비(pt). url/base64 는 생략 시 원본 크기, src 는 원본 크기를 알 수 없어 필수 (기본값: original size)<br> · `height` 높이(pt). url/base64 는 생략 시 원본 크기, src 는 원본 크기를 알 수 없어 필수 (기본값: original size) | 삽입된 이미지<br>[`WordImage`](#word-wordimage) |
351
+ | `insertWebVideo` | 이 범위 시작 위치에 웹 동영상을 글자처럼 배치해 삽입한다. - YouTube와 3DS 3DEXPERIENCE 주소를 지원하며 비동기로 처리한다. - 미리보기 이미지를 가져올 수 없으면 대체 이미지를 사용한다.<br><br><b>예제</b><pre><code>await range.insertWebVideo(videoUrl); // insert a video from a supported URL<br>await range.insertWebVideo(videoUrl, { width: 320, height: 180 }); // specify the size</code></pre> | `url` 문자열 — 웹 동영상 URL (YouTube / 3DS 3DEXPERIENCE)<br>`options` (선택) [`Size`](#word-size) — 크기(pt, 기본은 썸네일 원본 크기) (기본값: thumbnail original size) | 삽입된 웹 동영상 이미지 객체<br>[`WordImage`](#word-wordimage) |
352
+ | `insertLineBreak` | 이 범위 시작 위치에 줄 나누기를 삽입한다. - Shift+Enter처럼 단락을 유지하면서 줄만 바꾼다.<br><br><b>예제</b><pre><code>range.insertLineBreak(); // line break at the range start</code></pre> | — | — |
353
+ | `insertTab` | 이 범위 시작 위치에 탭 문자를 삽입한다. - 탭 정지 위치는 setTabs()로 별도 설정한다.<br><br><b>예제</b><pre><code>range.insertTab(); // insert a tab at the range start</code></pre> | — | — |
354
+ | `insertSymbol` | 이 범위 시작 위치에 기호를 삽입한다. - font 미지정: 해당 유니코드 문자를 일반 텍스트로 삽입한다. - font 지정: 그 글꼴의 기호 글리프로 삽입한다.<br><br><b>예제</b><pre><code>range.insertSymbol("2605"); // insert the star symbol ★<br>range.insertSymbol("F0FC", { font: "Wingdings" }); // check mark symbol in the specified font</code></pre> | `charCode` `string \| number` — 유니코드 코드포인트(16진 문자열 "2605" \| "0x2605" \| 숫자 0x2605)<br>`options` (선택) `{ font?: string }` — font 지정 시 그 글꼴의 기호로 삽입 | — |
355
+ | `insertSectionBreak` | 이 범위 위치에 구역 나누기를 삽입해 새 구역을 만든다. - 구역 나누기는 본문에만 삽입할 수 있다(머리글/바닥글/텍스트박스에는 불가).<br><br><b>예제</b><pre><code>doc.getSelection().insertSectionBreak(SectionBreakType.NEXT_PAGE); // next-page section break at the selection<br>doc.getBody().getRange(RangePosition.END).insertSectionBreak(SectionBreakType.CONTINUOUS); // continuous section break at the end of the document</code></pre> | `type` [`SectionBreakType`](#word-sectionbreaktype) — 새 구역의 시작 유형 (continuous: 이어서 / nextPage: 다음 페이지부터 / evenPage: 짝수 페이지부터 / oddPage: 홀수 페이지부터) | — |
356
+ | `insertPageBreak` | 이 범위 위치에 페이지 나누기를 삽입한다. - 뒤 내용은 다음 페이지에서 시작한다. 본문에만 삽입할 수 있다.<br><br><b>예제</b><pre><code>doc.getSelection().insertPageBreak(); // page break at the selection<br>doc.getRange({ startParaId: id, startOffset: 5, endOffset: 5 }).insertPageBreak(); // break at the specified character position</code></pre> | — | — |
357
+ | `insertColumnBreak` | 이 범위 위치에 단 나누기를 삽입한다. - 뒤 내용은 다음 단에서 시작하며, 구역이 1단이면 다음 페이지에서 시작한다. 본문에만 삽입할 수 있다.<br><br><b>예제</b><pre><code>doc.getSelection().insertColumnBreak(); // column break at the selection<br>doc.getRange({ startParaId: id, startOffset: 5, endOffset: 5 }).insertColumnBreak(); // break at the specified character position</code></pre> | — | — |
358
+ | `insertBookmark` | 이 범위 시작 위치에 책갈피를 삽입한다. - 같은 이름의 책갈피가 있으면 교체한다. 이름은 숫자·특수문자·공백으로 시작할 수 없다.<br><br><b>예제</b><pre><code>range.insertBookmark("intro"); // bookmark at the range start<br>doc.getSelection().insertBookmark("here").goTo(); // insert and move there immediately</code></pre> | `name` 문자열 — 책갈피 이름 | 삽입된 책갈피<br>[`WordBookmark`](#word-wordbookmark) |
359
+ | `insertComment` | 이 범위에 댓글을 삽입한다.<br><br><b>예제</b><pre><code>range.insertComment("Please check"); // add a comment on the range<br>range.insertComment("Review note", { authorName: "Reviewer", initials: "RV" }); // specify the author</code></pre> | `text` 문자열 — 댓글 본문<br>`options` (선택) `{ authorName?: string; initials?: string }` — 작성자 메타데이터 | 삽입된 댓글<br>[`WordComment`](#word-wordcomment) |
360
+ | `insertFootnote` | 이 범위 끝에 각주를 삽입한다. - 표시는 본문에 넣고, 내용은 해당 페이지 하단의 각주 영역에 넣는다.<br><br><b>예제</b><pre><code>range.insertFootnote("Source: report"); // insert a footnote at the range end<br>para.getRange(5, 5).insertFootnote("Additional note"); // insert a footnote at the specified character position</code></pre> | `text` (선택) 문자열 — 각주 내용 초기 텍스트(기본은 빈 각주) (기본값: empty footnote) | 생성된 각주 객체<br>[`WordNote`](#word-wordnote) |
361
+ | `insertEndnote` | 이 범위 끝에 미주를 삽입한다. - 표시는 본문에 넣고, 내용은 문서 끝의 미주 영역에 넣는다.<br><br><b>예제</b><pre><code>range.insertEndnote("Reference"); // insert an endnote at the range end<br>doc.getSelection().insertEndnote("Further details"); // insert an endnote at the end of the selection</code></pre> | `text` (선택) 문자열 — 미주 내용 초기 텍스트(기본은 빈 미주) (기본값: empty endnote) | 생성된 미주 객체<br>[`WordNote`](#word-wordnote) |
362
+
363
+ <a id="word-wordsection"></a>
364
+ ### Section — 구역 (`WordSection`)
365
+
366
+ 문서 구역 하나의 페이지 설정과 머리글·바닥글을 조회하고 편집한다. - 용지 크기·여백·단 구성·페이지 번호 형식·구역 나누기를 설정한다. - getBody()·getHeader()·getFooter()로 콘텐츠 영역에 접근한다. - 구역은 문서 순서에 따라 0부터 시작하는 인덱스로 식별한다.
367
+
368
+ | 기능 | 설명 | 입력 | 결과 |
369
+ |---|---|---|---|
370
+ | `getIndex` | 이 구역의 인덱스를 반환한다. | — | 0부터 시작하는 구역 인덱스<br>숫자 |
371
+ | `getBody` | 구역 본문을 반환한다. - 본문은 모든 구역이 공유하므로, 어느 구역에서 호출해도 같은 본문을 반환한다. | — | 본문 영역<br>[`WordBody`](#word-wordbody) |
372
+ | `getHeader` | 이 구역의 머리글 영역을 반환한다. - 아직 없는 영역은 첫 콘텐츠 삽입 시 생성한다.<br><br><b>예제</b><pre><code>section.getHeader(); // default header<br>section.getHeader(HeaderFooterVariant.FIRST); // first-page header<br>section.getHeader(HeaderFooterVariant.EVEN); // even-page header</code></pre> | `type` (선택) `HeaderFooterType \| HeaderFooterVariant` — 종류: HeaderFooterType(primary/firstPage/evenPages) 또는 HeaderFooterVariant(default/first/even) (기본값: HeaderFooterType.PRIMARY) | 해당 종류 머리글 영역<br>[`WordBody`](#word-wordbody) |
373
+ | `getFooter` | 이 구역의 바닥글 영역을 반환한다. - 아직 없는 영역은 첫 콘텐츠 삽입 시 생성한다.<br><br><b>예제</b><pre><code>section.getFooter(); // default footer<br>section.getFooter(HeaderFooterVariant.FIRST); // first-page footer</code></pre> | `type` (선택) `HeaderFooterType \| HeaderFooterVariant` — 종류: HeaderFooterType(primary/firstPage/evenPages) 또는 HeaderFooterVariant(default/first/even) (기본값: HeaderFooterType.PRIMARY) | 해당 종류 바닥글 영역<br>[`WordBody`](#word-wordbody) |
374
+ | `getNext` | 문서 순서상 다음 구역을 반환한다. | — | 다음 구역. 마지막 구역이면 null<br>[`WordSection`](#word-wordsection) (없을 수 있음) |
375
+ | `getPrevious` | 문서 순서상 이전 구역을 반환한다. | — | 이전 구역. 첫 구역이면 null<br>[`WordSection`](#word-wordsection) (없을 수 있음) |
376
+ | `getPageSetup` | 이 구역의 페이지 설정을 반환한다. - 용지 크기와 여백은 pt 단위로 반환한다. | — | 이 구역의 페이지 설정<br>[`PageSetupInfo`](#word-pagesetupinfo) |
377
+ | `getColumns` | 이 구역의 단(다단) 레이아웃을 반환한다. - count·equalWidth·space·separator 는 항상 포함되고, 단 너비가 서로 다를 때만 widths 가 추가된다. - 단이 하나면 항상 균등으로 보고하므로 { count: 1, equalWidth: true, space, separator } 형태이며 widths 는 없다. - 반환값은 setColumns()에 그대로 전달할 수 있다. | — | 단 레이아웃(setColumns 입력과 같은 형태)<br>[`ColumnLayout`](#word-columnlayout) |
378
+ | `setPageSize` | 이 구역의 용지 크기와 방향을 설정한다. - 용지 프리셋 또는 pt 단위의 너비·높이를 지정한다. 지정하지 않은 크기는 유지한다. - 방향을 지정하면 너비·높이를 해당 방향에 맞춘다. 프리셋만 변경하면 현재 방향을 유지한다.<br><br><b>예제</b><pre><code>section.setPageSize(PaperSize.A4); // paper preset (keeps current orientation)<br>section.setPageSize(PaperSize.A4, PageOrientation.LANDSCAPE); // preset + landscape<br>section.setPageSize({ width: 595.3, height: 841.9 }); // explicit dimensions (pt — A4)<br>section.setPageSize({ width: 900 }); // change width only (keeps height)<br>section.setPageSize(null, PageOrientation.PORTRAIT); // change orientation only (keeps size)</code></pre> | `size` `Size \| PaperSize \| null` — 용지 치수(pt, 생략한 축은 현재값 유지) 또는 용지 프리셋 이름(A3/A4/A5/Letter/Legal/Executive). null 이면 크기 유지(방향만 변경)<br>`orientation` (선택) [`PageOrientation`](#word-pageorientation) — 방향(portrait/landscape) | — |
379
+ | `setPageMargin` | 이 구역의 페이지 여백을 설정한다. - 지정한 방향의 여백만 변경하며 단위는 pt이다.<br><br><b>예제</b><pre><code>section.setPageMargin({ top: 72, bottom: 72 }); // top/bottom only (pt; other sides kept)<br>section.setPageMargin({ left: 120, right: 120, header: 48, footer: 48 }); // left/right + header/footer margins</code></pre> | `margins` [`PageMargins`](#word-pagemargins) — 여백(pt) | — |
380
+ | `setTitlePage` | 이 구역의 첫 페이지에 별도의 머리글·바닥글을 사용하도록 설정한다. - 현재값과 같으면 변경하지 않는다. 기능을 켠 뒤 첫 페이지 내용은 별도로 입력한다. - 설정값은 getPageSetup().titlePage로 확인한다.<br><br><b>예제</b><pre><code>section.setTitlePage(true); // separate first-page header/footer<br>section.setTitlePage(false); // remove the distinction</code></pre> | `enabled` 참/거짓 — 켜기(true)/끄기(false) | — |
381
+ | `setPageNumbering` | 이 구역의 페이지 번호 설정을 변경한다. - 지정한 필드만 변경하며, null은 설정 전체를 제거한다. 현재값과 같으면 변경하지 않는다. - 설정값은 getPageSetup().pageNumber로 확인한다.<br><br><b>예제</b><pre><code>section.setPageNumbering({ start: 1 }); // start the section's page numbers at 1<br>section.setPageNumbering({ formatType: NumberFormat.UPPER_ROMAN }); // roman numerals<br>section.setPageNumbering(null); // remove page numbering settings</code></pre> | `options` [`PageNumbering`](#word-pagenumbering) (없을 수 있음) — 페이지 번호 설정 또는 null(제거) | — |
382
+ | `setBreakType` | 이 구역의 나누기 유형(이어서/다음 페이지부터 등)을 변경한다. 현재값과 같으면 아무것도 바꾸지 않는다. - getPageSetup().breakType 로 읽는 값과 같다.<br><br><b>예제</b><pre><code>section.setBreakType(SectionBreakType.CONTINUOUS); // continue from the previous section<br>section.setBreakType(SectionBreakType.NEXT_PAGE); // start on the next page</code></pre> | `type` [`SectionBreakType`](#word-sectionbreaktype) — 나누기 유형(continuous/nextPage/evenPage/oddPage) | — |
383
+ | `setColumns` | 이 구역의 단(다단) 레이아웃을 변경한다. - 지정한 필드만 변경하며 나머지는 현재값을 유지한다. 현재값과 같으면 변경하지 않는다. 단위는 pt. - 각 단 너비를 다르게 하려면 widths 를 지정하고, 지정하지 않으면 모든 단이 같은 너비다. count 가 1이면 equalWidth·widths 는 무시된다. - 설정값은 getColumns()로 확인하며, 그 반환값을 그대로 전달할 수 있다.<br><br><b>예제</b><pre><code>section.setColumns({ count: 2 }); // two equal columns<br>section.setColumns({ count: 3, separator: true }); // three equal columns + separator line<br>section.setColumns({ count: 1 }); // remove columns (single column)<br>section.setColumns({ count: 2, widths: [{ width: 300 }, { width: 200 }] }); // individual widths (unequal)<br>section.setColumns(section.getColumns()); // write back the read value (no change)</code></pre> | `layout` [`ColumnLayout`](#word-columnlayout) — 단 레이아웃 | — |
384
+ | `deleteBreak` | 이 구역의 나누기를 제거하고 다음 구역과 합친다. - 마지막 구역에는 제거할 나누기가 없다. | — | — |
385
+
386
+ <a id="word-wordshape"></a>
387
+ ### Shape — 도형 (`WordShape`)
388
+
389
+ 도형 또는 텍스트박스의 내용과 서식을 조회하고 편집한다. - 크기·위치·배치, 채우기·선, 하이퍼링크, 텍스트와 안쪽 여백을 설정하거나 도형을 삭제한다. - WordDocument.getShape() 또는 getShapes()로 얻는다.
390
+
391
+ | 기능 | 설명 | 입력 | 결과 |
392
+ |---|---|---|---|
393
+ | `getRange` | 도형이 놓인 자리 범위를 반환한다. - 글자 한 칸을 차지하는 자리라 시작=끝이다.<br><br><b>예제</b><pre><code>word.getShape(id).getRange().getLocation(); // { startParaId, startOffset, ... }</code></pre> | — | 도형 자리 범위(도형이 없으면 사용 시점에 오류)<br>[`WordRange`](#word-wordrange) |
394
+ | `getBody` | 도형 내부의 텍스트 영역을 반환한다. | — | 텍스트 영역 컨테이너, 텍스트박스가 아니면 null<br>[`WordBody`](#word-wordbody) (없을 수 있음) |
395
+ | `getFill` | 도형의 현재 채우기 설정을 반환한다. - 반환값은 setFill()에 그대로 전달할 수 있다. - 테마색 채우기와 방사형 그라데이션 채우기는 type 만 반환하므로, 그 값을 그대로 setFill()에 전달하면 오류가 발생한다. | — | 채우기 정보(setFill 입력과 동형), fill 정보가 없으면 null<br>[`ShapeFill`](#word-shapefill) (없을 수 있음) |
396
+ | `getLine` | 도형의 현재 선 설정을 반환한다. - 반환값은 setLine()에 그대로 전달할 수 있다. | — | 선 정보(setLine 입력과 동형), line 정보가 없으면 null<br>[`ShapeLine`](#word-shapeline) (없을 수 있음) |
397
+ | `getHyperlink` | 도형에 연결된 하이퍼링크 정보를 반환한다. - 도형 하나에는 하나의 하이퍼링크를 연결할 수 있다.<br><br><b>예제</b><pre><code>const link = shape.getHyperlink();<br>if (link) { shape.updateHyperlink({ url: "https://new.com" }); } // update if present</code></pre> | — | 링크 정보, 없으면 null. 북마크면 url="#이름"·anchor="이름"<br>`{ url: string; tooltip: string \| null; linkType: HyperlinkType; anchor?: string } \| null` |
398
+ | `resize` | 도형의 크기를 변경한다. - 너비 또는 높이를 하나 이상 지정한다. 지정하지 않은 방향의 크기는 유지한다.<br><br><b>예제</b><pre><code>shape.resize({ width: 200, height: 100 }); // change width and height together<br>shape.resize({ width: 200 }); // change width only (height kept)</code></pre> | `options` [`Size`](#word-size) — 변경할 크기(pt). 각 생략 가능·최소 하나, 생략 축은 현재값 유지 | — |
399
+ | `setWrap` | 도형의 배치 방식을 변경한다. - 글자처럼 배치하거나 글 앞·뒤에 배치하도록 전환한다.<br><br><b>예제</b><pre><code>shape.setWrap(ShapeWrap.INLINE); // inline with text<br>shape.setWrap(ShapeWrap.INFRONT); // in front of text<br>shape.setWrap(ShapeWrap.BEHIND); // behind text</code></pre> | `wrap` [`ShapeWrap`](#word-shapewrap) — "inline"(글자처럼)\|"infront"(글 앞)\|"behind"(글 뒤) | — |
400
+ | `setZOrder` | 글 앞·뒤에 배치한 도형의 앞뒤 순서를 변경한다. - 이미 맨 앞이나 맨 뒤에 있는 도형에 같은 위치를 지정하면 변경하지 않는다.<br><br><b>예제</b><pre><code>shape.setZOrder(ShapeZOrder.FRONT); // bring to front<br>shape.setZOrder(ShapeZOrder.BACKWARD); // send backward one step</code></pre> | `order` [`ShapeZOrder`](#common-shapezorder) — "front"(맨 앞)\|"back"(맨 뒤)\|"forward"(한 단계 앞)\|"backward"(한 단계 뒤) | — |
401
+ | `move` | 글 앞·뒤에 배치한 도형의 위치를 변경한다. - x·y는 relativeFromH·relativeFromV 기준의 pt 좌표이며, 지정하지 않은 필드는 유지한다. - 기준점을 변경하면 좌표의 의미도 바뀌므로 기준점은 반드시 해당 좌표와 함께 지정해야 한다. - anchorParagraphId를 지정하면 도형을 해당 단락으로 옮긴다. 지정하지 않으면 현재 단락 안에서 위치만 변경한다.<br><br><b>예제</b><pre><code>shape.move({ x: 100, y: 50 }); // move coordinates only, keeping the current reference points<br>shape.move({ x: 0, relativeFromH: PositionRelativeFromH.PAGE }); // move while changing the horizontal reference to the page<br>shape.move({ anchorParagraphId: "p1", x: 30, y: 30 }); // re-anchor to another paragraph</code></pre> | `options` `{ x?: number; y?: number; relativeFromH?: PositionRelativeFromH; relativeFromV?: PositionRelativeFromV; anchorParagraphId?: string }` — 이동 옵션(x/y 는 pt). 생략 필드는 현재값 유지 | — |
402
+ | `setFill` | 도형 채우기를 설정한다. - blipFill 의 image 는 { src }(서버에 올라가 있는 파일 이름) / { url }(바깥 이미지 주소) / { base64 } 중 하나를 준다. url·base64 는 서버에 먼저 올린 다음 채우므로, 무엇을 주든 결과를 기다려야 한다 — 항상 await 로 호출한다. - 입력은 getFill() 반환과 같은 형태(ShapeFill) — 읽은 값을 그대로 다시 적용할 수 있다.<br><br><b>예제</b><pre><code>await shape.setFill({ type: FillType.SOLID, color: "#FF0000" }); // solid color<br>await shape.setFill({ type: FillType.NONE }); // remove fill<br>await shape.setFill({ type: FillType.GRADIENT, stops: [{ position: 0, color: "#FFFFFF" }, { position: 100, color: "#000000" }], angle: 90 }); // gradient<br>await shape.setFill({ type: FillType.IMAGE, image: { url: "https://example.com/a.png" } }); // external image (uploaded first)</code></pre> | `fill` [`ShapeFill`](#word-shapefill) — 채우기 정보 (종류별 유효 필드는 type 이 결정) | 반환값 없음<br>— |
403
+ | `setLine` | 도형 선을 설정한다. - 생략 = 변경 없음, null(color/dash/compound) = 제거. width 의 null/비숫자는 거부한다(제거 의미 없음).<br><br><b>예제</b><pre><code>shape.setLine({ color: "#000000", width: 2 }); // black 2pt line<br>shape.setLine({ dash: LineDash.DASH }); // change dash style only<br>shape.setLine({ color: null }); // remove line</code></pre> | `options` [`ShapeLine`](#word-shapeline) — 선 옵션. 생략=변경없음, color/dash/compound 의 null=제거 | — |
404
+ | `insertHyperlink` | 도형에 하이퍼링크를 설정한다. - 기존 링크가 있으면 교체한다. 웹 주소·이메일·책갈피는 URL 형식으로 구분하며, 프로토콜 없는 웹 주소에는 https://를 붙인다.<br><br><b>예제</b><pre><code>shape.insertHyperlink("https://example.com"); // web link<br>shape.insertHyperlink("mailto:a@b.com", { tooltip: "Send mail" }); // email + tooltip<br>shape.insertHyperlink("#bookmark1"); // bookmark within the document</code></pre> | `url` 문자열 — 링크 목적지<br>`options` (선택) `{ tooltip?: string }` — 추가 옵션<br> · `tooltip` 마우스오버 툴팁 (기본값: url) | — |
405
+ | `updateHyperlink` | 도형에 연결된 하이퍼링크의 주소나 설명을 수정한다. - 기존 링크가 없으면 오류가 발생한다. 지정하지 않은 필드는 유지한다.<br><br><b>예제</b><pre><code>shape.updateHyperlink({ url: "https://new.com" }); // change link target only<br>shape.updateHyperlink({ tooltip: "Description" }); // change tooltip only</code></pre> | `options` `{ url?: string; tooltip?: string }` — 수정할 항목 (url/tooltip 중 최소 하나)<br> · `url` 새 URL (웹 `http(s)://` · 이메일 `mailto:` · 북마크 `#name`), 기본 현재값 (기본값: current value)<br> · `tooltip` 새 툴팁, 기본 현재값 (기본값: current value) | — |
406
+ | `removeHyperlink` | 도형의 하이퍼링크를 제거한다. - 도형 자체는 유지한다. getHyperlink()로 링크 유무를 확인할 수 있다.<br><br><b>예제</b><pre><code>if (shape.getHyperlink()) { shape.removeHyperlink(); } // remove only if present</code></pre> | — | — |
407
+ | `setText` | 도형의 텍스트 내용을 교체한다. - 일반 도형에는 텍스트 영역을 새로 만든다. 이미지 등 텍스트를 담을 수 없는 도형에는 오류가 발생한다. - 빈 문자열은 내용을 비운다.<br><br><b>예제</b><pre><code>shape.setText("Notice text"); // set or replace text<br>shape.setText(""); // clear content</code></pre> | `text` 문자열 — 채울 텍스트 ("" 이면 비우기) | — |
408
+ | `setTextVerticalAlign` | 도형 텍스트의 세로 정렬을 설정한다. - 텍스트 영역이 있는 도형에만 적용한다. 영역이 없으면 setText()로 텍스트를 먼저 추가한다.<br><br><b>예제</b><pre><code>shape.setTextVerticalAlign(TextVerticalAlign.MIDDLE); // vertically centered</code></pre> | `align` [`TextVerticalAlign`](#word-textverticalalign) — "top"(위)\|"middle"(가운데)\|"bottom"(아래) | — |
409
+ | `setTextMargin` | 도형 텍스트 영역의 안쪽 여백을 설정한다. - 텍스트 영역이 있는 도형에 네 방향의 여백을 모두 지정한다.<br><br><b>예제</b><pre><code>shape.setTextMargin({ left: 6, top: 6, right: 6, bottom: 6 }); // 6pt margin on all four sides</code></pre> | `options` `{ left: number; top: number; right: number; bottom: number }` — 네 방향 여백(pt, 각 0 이상) | — |
410
+ | `delete` | 도형을 삭제한다. - 글자처럼 배치한 도형과 글 앞·뒤에 배치한 도형 모두 삭제할 수 있다. | — | — |
411
+
412
+ <a id="word-wordstyle"></a>
413
+ ### Style — 스타일 (`WordStyle`)
414
+
415
+ 스타일에 정의된 정보와 서식을 조회하고 수정한다. - WordDocument.getStyle() 또는 getStyles()로 얻는다. 유효하지 않은 스타일은 조회 시 null을 반환한다. - 스타일을 문서에 적용하려면 단락 또는 범위의 setStyle()을 사용한다.
416
+
417
+ | 기능 | 설명 | 입력 | 결과 |
418
+ |---|---|---|---|
419
+ | `getStyle` | 이 스타일에 직접 정의된 정보와 서식을 반환한다. - basedOn으로 연결된 상위 스타일의 서식은 포함하지 않는다. - textFormat과 paragraphFormat은 각각 글자·단락 서식 설정에 재사용할 수 있다. 글자 스타일에는 paragraphFormat이 없다. | — | 없으면 null<br>`(StyleInfo & { textFormat?: TextFormat, paragraphFormat?: ParagraphFormat }) \| null` |
420
+ | `getResolvedStyle` | 상위 스타일에서 상속한 서식을 포함해 최종 스타일 정보를 반환한다. - getStyle()과 같은 형식으로 반환하며, basedOn에 따른 서식 상속을 반영한다. | — | 없으면 null<br>`(StyleInfo & { textFormat?: TextFormat, paragraphFormat?: ParagraphFormat }) \| null` |
421
+ | `update` | 스타일에 정의된 서식을 부분 변경한다. - 지정한 필드만 변경하고 나머지는 유지한다. null은 해당 속성을 제거해 상위 스타일의 서식을 따르게 한다. - 단락 스타일에는 글자·단락 서식을 모두 지정할 수 있고, 글자 스타일에는 글자 서식만 지정할 수 있다.<br><br><b>예제</b><pre><code>style.update({ textFormat: { bold: true, color: "#FF0000" } }); // change text formatting only<br>style.update({ paragraphFormat: { align: TextAlign.CENTER } }); // change paragraph formatting only<br>style.update({ textFormat: { size: null } }); // remove property (revert to inherited)</code></pre> | `changes` `{ textFormat?: TextFormat; paragraphFormat?: ParagraphFormat }` — 변경할 서식(부분, 최소 하나) | — |
422
+
423
+ <a id="word-wordtable"></a>
424
+ ### Table — 표 (`WordTable`)
425
+
426
+ 표의 구조와 셀 내용·서식을 조회하고 편집한다. - 행·열 삽입과 삭제, 셀 병합과 분할, 크기·정렬·테두리·여백 설정을 제공한다. - getRow()와 getCell()로 행 또는 셀에 접근하며, 셀 범위를 지정해 여러 셀을 함께 편집한다.
427
+
428
+ | 기능 | 설명 | 입력 | 결과 |
429
+ |---|---|---|---|
430
+ | `getId` | 표 ID를 반환한다. | — | 표 ID<br>문자열 |
431
+ | `getRowCount` | 표의 행 개수를 반환한다. | — | 표의 행 개수<br>숫자 |
432
+ | `getColumnCount` | 병합된 셀이 차지하는 열 수를 포함해 표의 전체 열 개수를 반환한다. | — | 병합을 고려한 표의 전체 열 개수<br>숫자 |
433
+ | `getRow` | 지정한 위치의 행을 반환한다. | `rowIndex` 숫자 — 행 인덱스(0부터 시작하는) | 해당 인덱스의 행<br>[`WordTableRow`](#word-wordtablerow) |
434
+ | `getCell` | 지정한 위치의 셀을 반환한다. | `rowIndex` 숫자 — 행 인덱스(0부터 시작하는)<br>`columnIndex` 숫자 — 열 인덱스(0부터 시작하는) | 해당 행·열 위치의 셀<br>[`WordTableCell`](#word-wordtablecell) |
435
+ | `setValues` | 여러 셀의 내용을 2차원 배열의 텍스트로 교체한다. - values[r][c]를 r행 c열에 넣는다. 배열에 포함되지 않은 셀과 값이 null·undefined인 셀은 유지한다. - 배열이 표 크기를 초과하면 오류가 발생한다.<br><br><b>예제</b><pre><code>table.setValues([["Name", "Score"], ["John", "95"]]); // fill 2x2<br>table.setValues([[null, "Changed"]]); // update only the second cell of the first row (null is skipped)</code></pre> | `values` `string[][]` — 행별 값 배열(행마다 열 길이가 달라도 된다) | — |
436
+ | `delete` | 표를 삭제한다. | — | — |
437
+ | `setAlignment` | 페이지 안에서 표의 가로 위치를 설정한다. - 셀 내용의 가로 정렬은 셀 단락의 setParagraphFormat()으로, 세로 정렬은 setCellVerticalAlignment()로 설정한다.<br><br><b>예제</b><pre><code>table.setAlignment(TableAlign.CENTER); // center the table on the page</code></pre> | `align` [`TableAlign`](#word-tablealign) — 가로 위치 "left" \| "center" \| "right" | — |
438
+ | `setColumnWidths` | 표의 모든 열 너비를 설정한다. - 배열 길이는 표의 전체 열 개수와 같아야 한다. null인 열은 현재 너비를 유지한다. - 최소 너비보다 작은 값은 최소 너비로 보정한다.<br><br><b>예제</b><pre><code>table.setColumnWidths([120, 200, 80]); // set each of 3 columns in pt<br>table.setColumnWidths([100, null, null]); // change only the first column, keep the rest</code></pre> | `widths` `(number \| null)[]` — 열 너비(pt) 배열. null 슬롯은 현재 값 유지 | — |
439
+ | `setRowHeights` | 표의 행 높이를 행별로 설정한다. - 배열 길이는 표의 행 개수와 같아야 한다. null인 행은 현재 높이를 유지한다.<br><br><b>예제</b><pre><code>table.setRowHeights([30, 30, 60]); // set height per row<br>table.setRowHeights([null, 40, null]); // change only the second row</code></pre> | `heights` `(number \| null)[]` — 행 높이(pt) 배열. null 슬롯은 현재 값 유지 | — |
440
+ | `distributeColumns` | 대상 열들의 너비를 동일하게 맞춘다. - 대상 열의 전체 너비를 유지하면서 균등하게 나누며, 다른 열은 변경하지 않는다.<br><br><b>예제</b><pre><code>table.distributeColumns(); // distribute all column widths evenly<br>table.distributeColumns({ col: 0, colSpan: 2 }); // distribute only the first two columns evenly</code></pre> | `range` (선택) [`CellRange`](#word-cellrange) — 대상 열 범위(기본 표 전체). 열 구간(col/colSpan)만 사용한다 (기본값: whole table) | — |
441
+ | `setRowHeight` | 대상 행들의 높이를 지정한 값으로 동일하게 맞춘다.<br><br><b>예제</b><pre><code>table.setRowHeight(30); // set all rows of the table to 30pt<br>table.setRowHeight(45, { row: 0, rowSpan: 2 }); // set only the first two rows to 45pt</code></pre> | `height` 숫자 — 행 높이(pt, 양수)<br>`range` (선택) [`CellRange`](#word-cellrange) — 대상 행 범위(기본 표 전체). 행 구간(row/rowSpan)만 사용한다 (기본값: whole table) | — |
442
+ | `insertRow` | 기준 행의 앞/뒤에 새 행을 삽입한다.<br><br><b>예제</b><pre><code>const row = table.insertRow(0); // add below the first row<br>table.insertRow(0, InsertAt.BEFORE).getCell(0).setText("Header"); // add at the very top and fill it right away</code></pre> | `rowIndex` 숫자 — 기준 행 인덱스(0부터 시작하는)<br>`position` (선택) [`InsertAt`](#word-insertat) — 삽입 위치 "before"(기준 행 위) \| "after"(기준 행 아래) (기본값: InsertAt.AFTER) | 새로 만든 행<br>[`WordTableRow`](#word-wordtablerow) |
443
+ | `deleteRow` | 행을 삭제한다. | `rowIndex` 숫자 — 삭제할 행 인덱스(0부터 시작하는) | — |
444
+ | `insertColumn` | 기준 열의 왼쪽 또는 오른쪽에 새 열을 삽입한다. - 새 열의 셀은 getCell()에 행·열 인덱스를 전달해 접근한다.<br><br><b>예제</b><pre><code>table.insertColumn(0); // add to the right of the first column<br>table.getCell(0, 1).setText("Header"); // fill the first cell of the new column</code></pre> | `columnIndex` 숫자 — 기준 열 인덱스(0부터 시작하는)<br>`position` (선택) [`InsertAt`](#word-insertat) — 삽입 위치 "before"(기준 열 왼쪽) \| "after"(기준 열 오른쪽) (기본값: InsertAt.AFTER) | — |
445
+ | `deleteColumn` | 열을 삭제한다. | `columnIndex` 숫자 — 삭제할 열 인덱스(0부터 시작하는) | — |
446
+ | `mergeCells` | 셀 범위를 병합한다.<br><br><b>예제</b><pre><code>table.mergeCells({ row: 0, col: 0, colSpan: 2 }); // merge two columns of the first row horizontally<br>table.mergeCells({ row: 1, col: 1, rowSpan: 2, colSpan: 2 }); // merge a 2×2 rectangular range</code></pre> | `range` [`CellRange`](#word-cellrange) — 대상 셀 범위(앵커 + 개수, rowSpan·colSpan 중 하나 이상 2 이상) | — |
447
+ | `unmergeCells` | 지정한 범위 안의 병합된 셀을 분할한다.<br><br><b>예제</b><pre><code>table.unmergeCells({ row: 0, col: 0 }); // split the specified merged cell</code></pre> | `range` [`CellRange`](#word-cellrange) — 대상 셀 범위(단일 셀이면 개수 생략) | — |
448
+ | `setCellBackgroundColor` | 셀 범위의 배경색을 설정한다.<br><br><b>예제</b><pre><code>table.setCellBackgroundColor({ row: 0, col: 0 }, "#FFEB3B"); // single cell<br>table.setCellBackgroundColor({ row: 0, col: 0, colSpan: 3 }, null); // remove background of the first 3 columns</code></pre> | `range` [`CellRange`](#word-cellrange) — 대상 셀 범위(앵커 + 개수)<br>`color` 문자열 (없을 수 있음) — 배경색 (16진수 "#RRGGBB", null 또는 "" 이면 제거) | — |
449
+ | `setCellVerticalAlignment` | 셀 범위의 세로 정렬을 설정한다.<br><br><b>예제</b><pre><code>table.setCellVerticalAlignment({ row: 0, col: 0, colSpan: 2 }, CellVerticalAlign.CENTER); // vertically center the first two cells</code></pre> | `range` [`CellRange`](#word-cellrange) — 대상 셀 범위(앵커 + 개수)<br>`align` [`CellVerticalAlign`](#word-cellverticalalign) — 세로 정렬 "top" \| "center" \| "bottom" | — |
450
+ | `setCellPadding` | 지정한 셀 범위의 안쪽 여백을 설정한다.<br><br><b>예제</b><pre><code>table.setCellPadding({ row: 0, col: 0 }, { top: 4, bottom: 4 }); // top and bottom only<br>table.setCellPadding({ row: 0, col: 0, rowSpan: 2 }, { left: 8, right: 8 }); // left and right only, two rows</code></pre> | `range` [`CellRange`](#word-cellrange) — 대상 셀 범위(앵커 + 개수)<br>`padding` [`Padding`](#word-padding) — 4방향 여백(pt, 지정한 변만 변경) | — |
451
+ | `setCellBorder` | 셀 범위의 테두리를 설정한다.<br><br><b>예제</b><pre><code>table.setCellBorder({ row: 0, col: 0 }, { location: BorderLocation.ALL, style: BorderStyle.SOLID, color: "#000000", width: 1 }); // 1pt solid line on all four sides of the cell</code></pre> | `range` [`CellRange`](#word-cellrange) — 대상 셀 범위(앵커 + 개수)<br>`border` [`Border`](#word-border) — 테두리 값(단락/셀/페이지 공용 — 필드 정의는 WordRange.setParagraphBorder 의 Border typedef 참조) | — |
452
+
453
+ <a id="word-wordtablecell"></a>
454
+ ### TableCell — 표 셀 (`WordTableCell`)
455
+
456
+ 표의 셀 하나에 내용을 넣고 서식을 설정한다. - 배경색·세로 정렬·안쪽 여백·테두리를 설정한다. - setText()로 첫 단락의 텍스트를 교체하고, getParagraph()·getParagraphs()로 텍스트를 조회하거나 세부 편집한다.
457
+
458
+ | 기능 | 설명 | 입력 | 결과 |
459
+ |---|---|---|---|
460
+ | `getTable` | 이 셀이 속한 표를 반환한다. | — | 이 셀이 속한 표<br>[`WordTable`](#word-wordtable) |
461
+ | `getRow` | 행 인덱스를 반환한다. | — | 0부터 시작하는 행 인덱스<br>숫자 |
462
+ | `getColumn` | 열 인덱스를 반환한다. | — | 0부터 시작하는 열 인덱스<br>숫자 |
463
+ | `getParagraphs` | 셀 안의 모든 단락을 순서대로 반환한다. | — | 셀 내부 단락 배열 (빈 셀이면 빈 배열)<br>[`WordParagraph`](#word-wordparagraph) 목록 |
464
+ | `getParagraph` | 셀 안에서 지정한 인덱스의 단락을 반환한다. - 반환된 단락으로 텍스트를 조회하고 내용·서식을 편집한다. | `index` (선택) 숫자 — 0부터 시작하는 단락 인덱스 (기본값: 0) | 해당 단락, 없으면 null<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
465
+ | `setText` | 셀 첫 단락의 텍스트를 지정한 텍스트로 교체한다. - 첫 단락만 바뀌고, 셀의 나머지 단락은 그대로 남는다.<br><br><b>예제</b><pre><code>cell.setText("New content"); // replace the text of the first paragraph<br>cell.setText(""); // clear the text of the first paragraph</code></pre> | `text` 문자열 — 설정할 텍스트 | — |
466
+ | `setBackgroundColor` | 셀 배경색을 설정한다.<br><br><b>예제</b><pre><code>cell.setBackgroundColor("#FFEB3B"); // yellow background<br>cell.setBackgroundColor(null); // remove background</code></pre> | `color` 문자열 (없을 수 있음) — "#RRGGBB" 16진수 색상, null/"" 이면 배경 제거 | — |
467
+ | `setVerticalAlignment` | 셀 세로 정렬을 설정한다.<br><br><b>예제</b><pre><code>cell.setVerticalAlignment(CellVerticalAlign.CENTER); // vertically center</code></pre> | `align` [`CellVerticalAlign`](#word-cellverticalalign) — "top"(위) \| "center"(가운데) \| "bottom"(아래) | — |
468
+ | `setPadding` | 셀의 안쪽 여백을 설정한다. - 지정한 방향의 여백만 변경한다.<br><br><b>예제</b><pre><code>cell.setPadding({ left: 8, right: 8 }); // set only left/right padding to 8pt</code></pre> | `padding` [`Padding`](#word-padding) — 4방향 여백 | — |
469
+ | `setBorder` | 셀 테두리를 설정한다.<br><br><b>예제</b><pre><code>cell.setBorder({ location: BorderLocation.BOTTOM, style: BorderStyle.SOLID, color: "#000000", width: 1 }); // solid bottom border</code></pre> | `border` [`Border`](#word-border) — 테두리 값 | — |
470
+
471
+ <a id="word-wordtablerow"></a>
472
+ ### TableRow — 표 행 (`WordTableRow`)
473
+
474
+ 표의 행 하나를 조회하고 인접한 행을 삽입하거나 삭제한다. - getCell()·getCells()로 행 안의 셀에 접근한다. - getIndex()로 행 위치를 확인하고 getTable()로 이 행이 속한 표를 얻는다.
475
+
476
+ | 기능 | 설명 | 입력 | 결과 |
477
+ |---|---|---|---|
478
+ | `getTable` | 이 행이 속한 표를 반환한다. | — | 이 행이 속한 표<br>[`WordTable`](#word-wordtable) |
479
+ | `getIndex` | 행 인덱스를 반환한다. | — | 0부터 시작하는 행 인덱스<br>숫자 |
480
+ | `getCells` | 이 행의 셀 목록을 반환한다. - 열 순서로 반환하며 병합된 셀도 포함한다. | — | 열 순서의 셀 목록<br>[`WordTableCell`](#word-wordtablecell) 목록 |
481
+ | `getCell` | 이 행에서 지정한 열의 셀을 반환한다. | `columnIndex` 숫자 — 0부터 시작하는 열 인덱스 | 해당 열의 셀<br>[`WordTableCell`](#word-wordtablecell) |
482
+ | `delete` | 이 행을 삭제한다. | — | — |
483
+ | `insertSibling` | 이 행의 위 또는 아래에 새 행을 삽입한다.<br><br><b>예제</b><pre><code>row.insertSibling(); // insert below the current row<br>row.insertSibling(InsertAt.BEFORE); // insert above the current row</code></pre> | `position` (선택) [`InsertAt`](#word-insertat) — 삽입 위치: "before"(위) \| "after"(아래) (기본값: InsertAt.AFTER) | 새로 만든 행<br>[`WordTableRow`](#word-wordtablerow) |
484
+
485
+ ### 부록 — 입출력 데이터 형식 (Word)
486
+
487
+ <a id="word-rangedata"></a>
488
+ #### `RangeData`
489
+
490
+ | 항목 | 형식 | 설명 |
491
+ |---|---|---|
492
+ | `startParaId` (선택) | 문자열 | start paragraph ID |
493
+ | `startOffset` (선택) | 숫자 | start offset (default: start of paragraph) |
494
+ | `endParaId` (선택) | 문자열 | end paragraph ID (default: startParaId) |
495
+ | `endOffset` (선택) | 숫자 | end offset (default: end of paragraph) |
496
+
497
+ <a id="word-pagesetupinfo"></a>
498
+ #### `PageSetupInfo`
499
+
500
+ | 항목 | 형식 | 설명 |
501
+ |---|---|---|
502
+ | `pageSize` | [`Size`](#word-size) (없을 수 있음) | paper dimensions (pt; null if unset) |
503
+ | `orientation` | [`PageOrientation`](#word-pageorientation) (없을 수 있음) | orientation (null if unset) |
504
+ | `paperSize` | [`PaperSize`](#word-papersize) (없을 수 있음) | name of the matched paper preset (null if no match) |
505
+ | `margins` | [`PageMargins`](#word-pagemargins) | margins (pt) |
506
+ | `titlePage` | 참/거짓 | whether "different first page" is enabled |
507
+ | `breakType` | 문자열 | section break type (nextPage/continuous, etc.; nextColumn for column-break documents) |
508
+ | `pageNumber` | [`PageNumbering`](#word-pagenumbering) (없을 수 있음) | page numbering settings of the section (null if unset) |
509
+
510
+ <a id="word-pagemargins"></a>
511
+ #### `PageMargins`
512
+
513
+ | 항목 | 형식 | 설명 |
514
+ |---|---|---|
515
+ | `top` (선택) | 숫자 | top margin (pt) |
516
+ | `bottom` (선택) | 숫자 | bottom margin (pt) |
517
+ | `left` (선택) | 숫자 | left margin (pt) |
518
+ | `right` (선택) | 숫자 | right margin (pt) |
519
+ | `header` (선택) | 숫자 | header area margin (pt) |
520
+ | `footer` (선택) | 숫자 | footer area margin (pt) |
521
+
522
+ <a id="word-pagenumbering"></a>
523
+ #### `PageNumbering`
524
+
525
+ | 항목 | 형식 | 설명 |
526
+ |---|---|---|
527
+ | `start` (선택) | 숫자 | starting number for the first page of this section (integer ≥ 0) |
528
+ | `formatType` (선택) | [`NumberFormat`](#word-numberformat) | page number display format (decimal, roman numerals, etc.) |
529
+
530
+ <a id="word-columnlayout"></a>
531
+ #### `ColumnLayout`
532
+
533
+ | 항목 | 형식 | 설명 |
534
+ |---|---|---|
535
+ | `count` | 숫자 | number of columns (1~12; 1 removes columns) |
536
+ | `equalWidth` (선택) | 참/거짓 | whether all columns have the same width (default: false if widths is given, otherwise current value) |
537
+ | `space` (선택) | 숫자 | spacing between columns (pt; used when a column does not specify its own spacing) (default: current value (initially 36)) |
538
+ | `separator` (선택) | 참/거짓 | whether to show a separator line between columns (default: current value (initially false)) |
539
+ | `widths` (선택) | [`ColumnWidth`](#word-columnwidth) 목록 | width of each column (pt; the count must equal count, and specifying it makes the columns unequal. Included on read only when unequal) (default: current value) |
540
+
541
+ <a id="word-columnwidth"></a>
542
+ #### `ColumnWidth`
543
+
544
+ | 항목 | 형식 | 설명 |
545
+ |---|---|---|
546
+ | `width` | 숫자 | column width (pt) |
547
+ | `space` (선택) | 숫자 | spacing after this column (pt) (default: parent space) |
548
+
549
+ <a id="word-textformat"></a>
550
+ #### `TextFormat`
551
+
552
+ | 항목 | 형식 | 설명 |
553
+ |---|---|---|
554
+ | `bold` (선택) | `boolean \| null` | bold (null removes the property) |
555
+ | `italic` (선택) | `boolean \| null` | italic (null removes the property) |
556
+ | `underline` (선택) | `boolean \| null` | underline (null removes the property) |
557
+ | `size` (선택) | 숫자 (없을 수 있음) | font size (pt, null removes the property) |
558
+ | `color` (선택) | 문자열 (없을 수 있음) | text color (hex, e.g. "#FF0000", null removes the property) |
559
+ | `font` (선택) | 문자열 (없을 수 있음) | font name (null removes the property) |
560
+ | `strikeThrough` (선택) | `boolean \| null` | strikethrough (null removes the property) |
561
+ | `highlightColor` (선택) | 문자열 (없을 수 있음) | highlight color (hex, e.g. "#FFFF00"; null/"transparent" removes it) |
562
+ | `superscript` (선택) | `boolean \| null` | superscript (mutually exclusive with subscript; takes precedence if both are true, null removes it) |
563
+ | `subscript` (선택) | `boolean \| null` | subscript (mutually exclusive with superscript, null removes it) |
564
+ | `spacing` (선택) | 숫자 (없을 수 있음) | character spacing (pt, negative tightens; range -12~400, null removes the property) |
565
+
566
+ <a id="word-paragraphformat"></a>
567
+ #### `ParagraphFormat`
568
+
569
+ | 항목 | 형식 | 설명 |
570
+ |---|---|---|
571
+ | `align` (선택) | [`TextAlign`](#word-textalign) (없을 수 있음) | alignment ("left"\|"center"\|"right"\|"justify", null removes it) |
572
+ | `lineSpacing` (선택) | `number \| string \| null` | line spacing — number = multiple (e.g. 1.5), "Npx" = the same multiple fixed (e.g. "1.5px"; N is a line-height multiple, not pixels), null = remove |
573
+ | `leftIndent` (선택) | 숫자 (없을 수 있음) | left indent (pt, null removes it) |
574
+ | `rightIndent` (선택) | 숫자 (없을 수 있음) | right indent (pt, null removes it) |
575
+ | `firstLineIndent` (선택) | 숫자 (없을 수 있음) | first-line indent (pt, negative for a hanging indent, null removes it) |
576
+ | `spaceBefore` (선택) | 숫자 (없을 수 있음) | space before the paragraph (pt, null removes it) |
577
+ | `spaceAfter` (선택) | 숫자 (없을 수 있음) | space after the paragraph (pt, null removes it) |
578
+ | `backgroundColor` (선택) | 문자열 (없을 수 있음) | paragraph background color (shading fill, hex "#RRGGBB", null removes it) |
579
+ | `outlineLevel` (선택) | [`OutlineLevel`](#word-outlinelevel) (없을 수 있음) | outline level ("level1"~"level9"; "body" or null means body text) |
580
+
581
+ <a id="word-border"></a>
582
+ #### `Border`
583
+
584
+ | 항목 | 형식 | 설명 |
585
+ |---|---|---|
586
+ | `location` | [`BorderLocation`](#word-borderlocation) | target side (for paragraph borders, top/bottom/left/right/all and between (horizontal line between paragraphs) are valid) |
587
+ | `style` | [`BorderStyle`](#word-borderstyle) | line style (solid/dashed/dotted/double/none/hidden) |
588
+ | `color` | 문자열 | line color (hex "#RRGGBB") |
589
+ | `width` | 숫자 | line width (pt) |
590
+
591
+ <a id="word-tabstop"></a>
592
+ #### `TabStop`
593
+
594
+ | 항목 | 형식 | 설명 |
595
+ |---|---|---|
596
+ | `position` | 숫자 | tab stop position (pt) |
597
+ | `alignment` (선택) | [`TabAlignment`](#word-tabalignment) | alignment ("left"\|"center"\|"right"\|"decimal", default "left") |
598
+ | `leader` (선택) | [`TabLeader`](#word-tableader) | leader fill ("none"\|"dot"\|"hyphen"\|"underscore"\|"middleDot", default "none") |
599
+
600
+ <a id="word-cellrange"></a>
601
+ #### `CellRange`
602
+
603
+ | 항목 | 형식 | 설명 |
604
+ |---|---|---|
605
+ | `row` | 숫자 | anchor row (0-based, relative to the table) |
606
+ | `col` | 숫자 | anchor column (0-based, relative to the table) |
607
+ | `rowSpan` (선택) | 숫자 | number of rows (default: 1) |
608
+ | `colSpan` (선택) | 숫자 | number of columns (default: 1) |
609
+
610
+ <a id="word-padding"></a>
611
+ #### `Padding`
612
+
613
+ | 항목 | 형식 | 설명 |
614
+ |---|---|---|
615
+ | `left` (선택) | 숫자 | left padding (pt) |
616
+ | `right` (선택) | 숫자 | right padding (pt) |
617
+ | `top` (선택) | 숫자 | top padding (pt) |
618
+ | `bottom` (선택) | 숫자 | bottom padding (pt) |
619
+
620
+ <a id="word-shapeinfo"></a>
621
+ #### `ShapeInfo`
622
+
623
+ | 항목 | 형식 | 설명 |
624
+ |---|---|---|
625
+ | `shapeId` | 문자열 | 도형 ID (영구 GUID) |
626
+ | `shapeType` | [`ShapeType`](#word-shapetype) | 도형 종류 ("sp"=도형/텍스트박스, "pic"=이미지) |
627
+ | `storyId` | 문자열 | 도형이 속한 영역 ID (본문 "0") |
628
+ | `width` | 숫자 | 너비(pt) |
629
+ | `height` | 숫자 | 높이(pt) |
630
+ | `wrap` | [`ShapeWrap`](#word-shapewrap) | 배치 모드 (inline/infront/behind) |
631
+ | `zIndex` | 숫자 | 앞뒤 순서 (floating 전용 의미) |
632
+ | `anchor` | `{ paragraphId: string; offset?: number }` | 소속 위치 (offset 은 inline 전용 단락 내 글자 위치) |
633
+ | `x` (선택) | 숫자 | floating 전용 가로 위치(pt, relativeFromH 기준 — move 에 그대로 재사용 가능) |
634
+ | `y` (선택) | 숫자 | floating 전용 세로 위치(pt, relativeFromV 기준) |
635
+ | `relativeFromH` (선택) | [`PositionRelativeFromH`](#word-positionrelativefromh) | floating 전용 가로 기준점 |
636
+ | `relativeFromV` (선택) | [`PositionRelativeFromV`](#word-positionrelativefromv) | floating 전용 세로 기준점 |
637
+ | `fill` | [`ShapeFill`](#word-shapefill) (없을 수 있음) | 채우기 readback (setFill 입력과 대칭) |
638
+ | `line` | [`ShapeLine`](#word-shapeline) (없을 수 있음) | 선 readback (setLine 입력과 대칭) |
639
+ | `hyperlink` | `{ url: string; tooltip: string; linkType: string; anchor?: string } \| null` | 링크 readback |
640
+ | `isTextbox` (선택) | 참/거짓 | 텍스트 영역 보유 여부(텍스트박스) |
641
+ | `textboxStoryId` (선택) | 문자열 | 텍스트박스 내부 텍스트 영역 ID |
642
+ | `altText` (선택) | 문자열 | 대체 텍스트 |
643
+
644
+ <a id="word-size"></a>
645
+ #### `Size`
646
+
647
+ | 항목 | 형식 | 설명 |
648
+ |---|---|---|
649
+ | `width` (선택) | 숫자 | width (positive) |
650
+ | `height` (선택) | 숫자 | height (positive) |
651
+
652
+ <a id="word-shapefill"></a>
653
+ #### `ShapeFill`
654
+
655
+ | 항목 | 형식 | 설명 |
656
+ |---|---|---|
657
+ | `type` | [`FillType`](#word-filltype) | fill kind (noFill/solidFill/blipFill/gradFill) |
658
+ | `color` (선택) | 문자열 (없을 수 있음) | solidFill color "#RRGGBB" (null/"" removes the fill) |
659
+ | `image` (선택) | `{ src?: string; url?: string; base64?: string }` | blipFill image source (exactly one of src, url, base64) |
660
+ | `stops` (선택) | `{ position: number; color: string }[]` | gradFill color stops (≥2, position 0~100) |
661
+ | `angle` (선택) | 숫자 | gradFill angle (degrees) (default: 0 (left→right)) |
662
+
663
+ <a id="word-shapeline"></a>
664
+ #### `ShapeLine`
665
+
666
+ | 항목 | 형식 | 설명 |
667
+ |---|---|---|
668
+ | `color` (선택) | 문자열 (없을 수 있음) | line color "#RRGGBB" (null or "" removes it) |
669
+ | `width` (선택) | 숫자 | line width (pt) |
670
+ | `dash` (선택) | [`LineDash`](#common-linedash) (없을 수 있음) | dash style (null removes it) |
671
+ | `compound` (선택) | [`LineCompound`](#word-linecompound) (없을 수 있음) | compound line style (null removes it) |
672
+
673
+ <a id="word-styleinfo"></a>
674
+ #### `StyleInfo`
675
+
676
+ | 항목 | 형식 | 설명 |
677
+ |---|---|---|
678
+ | `style` | 문자열 | style key |
679
+ | `name` | 문자열 | display name |
680
+ | `type` | `"paragraph" \| "character"` | style type |
681
+ | `basedOn` (선택) | 문자열 | key of the parent style it inherits from (if any) |
682
+ | `next` (선택) | 문자열 | key of the style for the next paragraph (if any) |
683
+
684
+ ### 부록 — 상수 목록 (Word)
685
+
686
+ <a id="word-insertat"></a>
687
+ #### `InsertAt`
688
+
689
+ 삽입 위치 — 기준 객체(receiver)를 기준으로 어디에 넣을지. insert 계열의 옵션 `position` 값.
690
+ 밖(형제): before/after, 안(콘텐츠 끝단): start/end.
691
+ start/end 의 기준은 기준 객체 종류로 갈린다 — 단락이면 그 단락 콘텐츠의 맨앞/맨끝,
692
+ 본문(body)이면 본문 콘텐츠의 맨앞/맨끝(= 첫 단락 앞 / 마지막 단락 뒤).
693
+
694
+ | 상수 | 설명 |
695
+ |---|---|
696
+ | `BEFORE` | 기준 요소 앞(형제) |
697
+ | `AFTER` | 기준 요소 뒤(형제) |
698
+ | `START` | 기준 요소 콘텐츠 맨 앞 |
699
+ | `END` | 기준 요소 콘텐츠 맨 끝 |
700
+
701
+ <a id="word-rangeposition"></a>
702
+ #### `RangePosition`
703
+
704
+ 범위 조회 위치 — 기준 객체(receiver)의 어느 부분 범위를 반환할지. getRange(RangePosition) 값.
705
+
706
+ | 상수 | 설명 |
707
+ |---|---|
708
+ | `WHOLE` | 전체(단락 기호 포함) |
709
+ | `START` | 시작 지점(collapsed) |
710
+ | `END` | 끝 지점(단락 기호 앞, collapsed) |
711
+ | `AFTER` | 단락 기호 다음 지점(collapsed) |
712
+ | `CONTENT` | 단락 기호 제외한 내용 범위 |
713
+ | `BEFORE` | 시작 앞 지점(collapsed) |
714
+
715
+ <a id="word-selectionmode"></a>
716
+ #### `SelectionMode`
717
+
718
+ 선택 영역 기준 위치 — 현재 선택/커서를 어느 지점으로 잡을지.
719
+ - select: 선택 영역 전체, start/end: 선택(커서)의 시작/끝 지점(collapsed).
720
+
721
+ | 상수 | 설명 |
722
+ |---|---|
723
+ | `SELECT` | 현재 선택 영역 전체 |
724
+ | `START` | 선택/커서 시작 지점(collapsed) |
725
+ | `END` | 선택/커서 끝 지점(collapsed) |
726
+
727
+ <a id="word-viewcontexttype"></a>
728
+ #### `ViewContextType`
729
+
730
+ RangeBuilder.fromView() 인자 타입.
731
+ View 환경에서 어떤 정보를 ModelRange로 변환할지 결정한다.
732
+
733
+ | 상수 | 설명 |
734
+ |---|---|
735
+ | `CURSOR` | 현재 커서 (selection.getModelRange(false)) |
736
+ | `SELECTION` | 현재 선택 영역 (selection.getModelRange(true)) |
737
+
738
+ <a id="word-structurefilter"></a>
739
+ #### `StructureFilter`
740
+
741
+ 문서 구조 조회 타입 필터 — getStructure({ type }) / get_document_structure 의 type 값.
742
+
743
+ | 상수 | 설명 |
744
+ |---|---|
745
+ | `TABLE` | 표 |
746
+ | `LIST` | 목록 단락 |
747
+
748
+ <a id="word-rangekind"></a>
749
+ #### `RangeKind`
750
+
751
+ WordRange 가 "무엇을 가리키는지" 적어 두는 방식(종류).
752
+
753
+ OFFSET 만 좌표를 직접 들고 있고, 나머지는 대상의 id·이름만 들고 있다가 **쓸 때 위치를 찾는다**
754
+ — 그래서 선택 영역이 바뀌거나 편집으로 표시가 밀려도 항상 지금 위치를 가리킨다.
755
+
756
+ | 상수 | 설명 |
757
+ |---|---|
758
+ | `OFFSET` | 단락 ID + 글자 위치를 직접 지정(좌표를 들고 있음 — 이후 편집으로 어긋날 수 있다) |
759
+ | `RANGE_POSITION` | 영역의 어느 부분인지로 지정(맨앞/맨끝/전체 등 — RangePosition) |
760
+ | `VIEW` | 화면의 선택 영역/커서(쓸 때마다 현재 선택을 다시 읽는다) |
761
+ | `COMMENT` | 그 댓글이 달린 본문 구간 |
762
+ | `NOTE` | 각주/미주 표시가 놓인 자리 |
763
+ | `BOOKMARK` | 책갈피 표시가 놓인 자리(글자 한 칸) |
764
+ | `SHAPE` | 도형·이미지가 놓인 자리(글자 한 칸 — floating 이면 앵커 자리) |
765
+ | `HYPERLINK` | 하이퍼링크의 표시 텍스트 구간(앞뒤 마커는 제외 — 링크를 유지한 채 글자만 다룬다) |
766
+ | `CHANGE_TRACKING` | 변경 추적 항목이 차지하는 구간 |
767
+
768
+ <a id="word-specialcharacter"></a>
769
+ #### `SpecialCharacter`
770
+
771
+ WordBody.search()/WordRange.search() 로 찾을 수 있는 특수 문자(눈에 보이지 않는 비-텍스트 런) 종류.
772
+ Word 찾기/바꾸기의 "특수 문자"에 대응 — 텍스트 검색(search)이 문자로 매칭하지 못하는 요소를 종류로 지목해 위치(Range)를 얻는다.
773
+ 값은 코어 모델 런 타입(DefineTypes.element)의 키와 동일하다.
774
+
775
+ | 상수 | 설명 |
776
+ |---|---|
777
+ | `PAGE_BREAK` | 페이지 나누기 |
778
+ | `COLUMN_BREAK` | 단 나누기 |
779
+ | `SOFT_BREAK` | 줄바꿈(Shift+Enter) |
780
+ | `TAB` | 탭 |
781
+ | `SYMBOL` | 기호 |
782
+
783
+ <a id="word-zoommode"></a>
784
+ #### `ZoomMode`
785
+
786
+ 보기 배율/맞춤 모드.
787
+ WordDocument.setZoom() 에서 사용한다. 코어에 정의된 배율 프리셋(50~200%)과 맞춤·단계 모드.
788
+
789
+ | 상수 | 설명 |
790
+ |---|---|
791
+ | `SCALE_50` | 50% |
792
+ | `SCALE_66` | 66% |
793
+ | `SCALE_75` | 75% |
794
+ | `SCALE_100` | 100% (원래 배율) |
795
+ | `SCALE_125` | 125% |
796
+ | `SCALE_150` | 150% |
797
+ | `SCALE_200` | 200% |
798
+ | `FIT_WIDTH` | 폭 맞춤 |
799
+ | `FIT_WINDOW` | 쪽 맞춤 |
800
+ | `ZOOM_IN` | 한 단계 확대 |
801
+ | `ZOOM_OUT` | 한 단계 축소 |
802
+
803
+ <a id="word-headerfootertype"></a>
804
+ #### `HeaderFooterType`
805
+
806
+ 머리글/바닥글 종류.
807
+ - PRIMARY: 기본(홀수/모든 페이지) — 별도 "odd" 는 없고 PRIMARY 가 그 역할
808
+
809
+ | 상수 | 설명 |
810
+ |---|---|
811
+ | `PRIMARY` | 기본 머리글/바닥글 (OOXML default) |
812
+ | `FIRST_PAGE` | 첫 페이지 (OOXML first) |
813
+ | `EVEN_PAGES` | 짝수 페이지 (OOXML even) |
814
+
815
+ <a id="word-headerfootervariant"></a>
816
+ #### `HeaderFooterVariant`
817
+
818
+ 머리글/바닥글 종류의 OOXML/모델 어휘 (WordSection.getHeader/getFooter type 으로도 허용).
819
+ - HeaderFooterType(primary/firstPage/evenPages)과 1:1 동의어 — 둘 중 어느 어휘로도 호출 가능.
820
+
821
+ | 상수 | 설명 |
822
+ |---|---|
823
+ | `DEFAULT` | 기본(= HeaderFooterType.PRIMARY) |
824
+ | `FIRST` | 첫 페이지(= HeaderFooterType.FIRST_PAGE) |
825
+ | `EVEN` | 짝수 페이지(= HeaderFooterType.EVEN_PAGES) |
826
+
827
+ <a id="word-sectionbreaktype"></a>
828
+ #### `SectionBreakType`
829
+
830
+ 구역(section) 나누기 유형 (WordSection.setBreakType type — getPageSetup().breakType 과 대칭).
831
+ setBreakType 으로 지정한 값은 getPageSetup().breakType 으로 그대로 다시 읽힌다.
832
+ - "단 나누기"(nextColumn)는 구역 나누기 유형이 아니라 본문 inline 나누기다 — WordRange.insertColumnBreak / SpecialCharacter.COLUMN_BREAK 로 다룬다.
833
+
834
+ | 상수 | 설명 |
835
+ |---|---|
836
+ | `CONTINUOUS` | 이어서 (이어나누기) |
837
+ | `NEXT_PAGE` | 다음 페이지부터 |
838
+ | `EVEN_PAGE` | 짝수 페이지부터 |
839
+ | `ODD_PAGE` | 홀수 페이지부터 |
840
+
841
+ <a id="word-notetype"></a>
842
+ #### `NoteType`
843
+
844
+ 각주/미주 종류.
845
+ 값은 코어 DefineTypes.noteTypes / DefineActions.type.footnote·endnote 와 동일해 매핑 없이 그대로 쓰인다.
846
+
847
+ | 상수 | 설명 |
848
+ |---|---|
849
+ | `FOOTNOTE` | 각주 (페이지 하단) |
850
+ | `ENDNOTE` | 미주 (문서 끝) |
851
+
852
+ <a id="word-hyperlinktype"></a>
853
+ #### `HyperlinkType`
854
+
855
+ 하이퍼링크 종류 (WordHyperlink.getLinkType()).
856
+ 종류는 별도 입력축이 아니라 url 에서 정해진다: "#이름"→BOOKMARK, "mailto:"→MAILTO, 그 외→LINK.
857
+
858
+ | 상수 | 설명 |
859
+ |---|---|
860
+ | `LINK` | 웹 주소 (http/https) |
861
+ | `MAILTO` | 이메일 |
862
+ | `BOOKMARK` | 문서 내부 북마크 |
863
+
864
+ <a id="word-changetrackingtype"></a>
865
+ #### `ChangeTrackingType`
866
+
867
+ 변경 추적 항목(change tracking) 공개 유형 (WordChangeTracking.getInfo().type).
868
+ 코어 revisionType(ins/del/change)을 정규화한 공개 값 — 변환 맵은 소비자(extractors)가 보유한다.
869
+
870
+ | 상수 | 설명 |
871
+ |---|---|
872
+ | `ADDED` | 삽입 (코어 ins) |
873
+ | `DELETED` | 삭제 (코어 del) |
874
+ | `FORMATTED` | 서식 변경 (코어 change) |
875
+
876
+ <a id="word-shapewrap"></a>
877
+ #### `ShapeWrap`
878
+
879
+ 도형 wrap(텍스트 배치) 종류.
880
+ 워드 모델이 지원하는 3가지 ([defineTypes.js] shapeWrapType) 만 노출.
881
+
882
+ | 상수 | 설명 |
883
+ |---|---|
884
+ | `INLINE` | 텍스트 흐름 안에 글자처럼 박힘 (paragraphId + offset 으로 위치) |
885
+ | `INFRONT` | 텍스트 위에 떠있음 |
886
+ | `BEHIND` | 텍스트 뒤에 깔림 |
887
+
888
+ <a id="word-positionrelativefromh"></a>
889
+ #### `PositionRelativeFromH`
890
+
891
+ floating 도형 가로 위치 기준 (OOXML wp:positionH @relativeFrom).
892
+
893
+ | 상수 | 설명 |
894
+ |---|---|
895
+ | `PAGE` | — |
896
+ | `MARGIN` | — |
897
+ | `COLUMN` | — |
898
+
899
+ <a id="word-positionrelativefromv"></a>
900
+ #### `PositionRelativeFromV`
901
+
902
+ floating 도형 세로 위치 기준 (OOXML wp:positionV @relativeFrom).
903
+
904
+ | 상수 | 설명 |
905
+ |---|---|
906
+ | `PAGE` | — |
907
+ | `MARGIN` | — |
908
+ | `PARAGRAPH` | — |
909
+
910
+ <a id="word-shapetype"></a>
911
+ #### `ShapeType`
912
+
913
+ 도형 종류.
914
+
915
+ | 상수 | 설명 |
916
+ |---|---|
917
+ | `SHAPE` | preset geometry 도형 |
918
+ | `PICTURE` | 이미지 |
919
+
920
+ <a id="word-filltype"></a>
921
+ #### `FillType`
922
+
923
+ 도형 채우기 종류 (setFill type).
924
+
925
+ | 상수 | 설명 |
926
+ |---|---|
927
+ | `NONE` | — |
928
+ | `SOLID` | — |
929
+ | `GRADIENT` | — |
930
+ | `IMAGE` | — |
931
+
932
+ <a id="word-textverticalalign"></a>
933
+ #### `TextVerticalAlign`
934
+
935
+ 텍스트박스 세로 정렬 (setTextVerticalAlign align — bodyPr anchor).
936
+ 가로 텍스트(flow=horz) 기준. 모델 anchor 값과 1:1.
937
+
938
+ | 상수 | 설명 |
939
+ |---|---|
940
+ | `TOP` | — |
941
+ | `MIDDLE` | — |
942
+ | `BOTTOM` | — |
943
+
944
+ <a id="word-linecompound"></a>
945
+ #### `LineCompound`
946
+
947
+ 선 겹선(compound) 스타일 (setShapeLine compound — OOXML a:ln @cmpd).
948
+
949
+ | 상수 | 설명 |
950
+ |---|---|
951
+ | `SINGLE` | — |
952
+ | `DOUBLE` | — |
953
+ | `THICK_THIN` | — |
954
+ | `THIN_THICK` | — |
955
+ | `TRIPLE` | — |
956
+
957
+ <a id="word-textalign"></a>
958
+ #### `TextAlign`
959
+
960
+ 텍스트/단락 정렬.
961
+
962
+ | 상수 | 설명 |
963
+ |---|---|
964
+ | `LEFT` | — |
965
+ | `CENTER` | — |
966
+ | `RIGHT` | — |
967
+ | `JUSTIFY` | — |
968
+
969
+ <a id="word-tablealign"></a>
970
+ #### `TableAlign`
971
+
972
+ 표 상자의 페이지 내 가로 위치.
973
+
974
+ | 상수 | 설명 |
975
+ |---|---|
976
+ | `LEFT` | — |
977
+ | `CENTER` | — |
978
+ | `RIGHT` | — |
979
+
980
+ <a id="word-cellverticalalign"></a>
981
+ #### `CellVerticalAlign`
982
+
983
+ 표 셀 세로 정렬.
984
+
985
+ | 상수 | 설명 |
986
+ |---|---|
987
+ | `TOP` | — |
988
+ | `CENTER` | — |
989
+ | `BOTTOM` | — |
990
+
991
+ <a id="word-outlinelevel"></a>
992
+ #### `OutlineLevel`
993
+
994
+ 개요 수준(outline level) — 단락의 개요/목차 상 수준. "body"=본문(개요 수준 없음).
995
+
996
+ | 상수 | 설명 |
997
+ |---|---|
998
+ | `LEVEL_1` | — |
999
+ | `LEVEL_2` | — |
1000
+ | `LEVEL_3` | — |
1001
+ | `LEVEL_4` | — |
1002
+ | `LEVEL_5` | — |
1003
+ | `LEVEL_6` | — |
1004
+ | `LEVEL_7` | — |
1005
+ | `LEVEL_8` | — |
1006
+ | `LEVEL_9` | — |
1007
+ | `BODY` | — |
1008
+
1009
+ <a id="word-style"></a>
1010
+ #### `Style`
1011
+
1012
+ 문서 기본 제공(내장) 스타일 키. setStyle(style) 에 그대로 넘긴다(값 = getStyles() 의 style 키).
1013
+ 내장 스타일은 문서 로드 시 항상 존재하므로 이 enum 값은 어느 문서에서든 유효하다.
1014
+ 커스텀 문서 스타일은 이 enum 없이 getStyles() 로 얻은 style 값(String)을 직접 넘긴다.
1015
+
1016
+ | 상수 | 설명 |
1017
+ |---|---|
1018
+ | `NORMAL` | 본문(기본 단락 스타일) |
1019
+ | `TITLE` | — |
1020
+ | `SUBTITLE` | — |
1021
+ | `HEADING_1` | — |
1022
+ | `HEADING_2` | — |
1023
+ | `HEADING_3` | — |
1024
+ | `QUOTE` | — |
1025
+ | `STRONG` | ↓ 글자 스타일 |
1026
+ | `EMPHASIS` | — |
1027
+ | `SUBTLE_EMPHASIS` | — |
1028
+ | `INTENSE_EMPHASIS` | — |
1029
+
1030
+ <a id="word-indenttype"></a>
1031
+ #### `IndentType`
1032
+
1033
+ 들여쓰기 상대 조정.
1034
+
1035
+ | 상수 | 설명 |
1036
+ |---|---|
1037
+ | `INDENT` | — |
1038
+ | `OUTDENT` | — |
1039
+
1040
+ <a id="word-listtype"></a>
1041
+ #### `ListType`
1042
+
1043
+ 문서 기본 제공 목록 서식.
1044
+
1045
+ | 상수 | 설명 |
1046
+ |---|---|
1047
+ | `BULLET_CIRCLE` | ● |
1048
+ | `BULLET_SQUARE` | ■ |
1049
+ | `BULLET_DIAMOND` | ◆ |
1050
+ | `BULLET_CHECK` | ✓ |
1051
+ | `BULLET_ARROW` | ➢ |
1052
+ | `BULLET_STAR` | ✧ |
1053
+ | `NUMBER_DECIMAL` | 1. |
1054
+ | `NUMBER_UPPER_LETTER` | A. |
1055
+ | `NUMBER_UPPER_ROMAN` | I. |
1056
+ | `NUMBER_CIRCLED` | ① |
1057
+ | `NUMBER_LOWER_LETTER` | a. |
1058
+ | `NUMBER_LOWER_ROMAN` | i. |
1059
+ | `MULTILEVEL_NUMBER_LETTER_ROMAN` | 1. / A. / i. |
1060
+ | `MULTILEVEL_NUMBER_LETTER_LETTER` | 1. / A. / a. |
1061
+ | `MULTILEVEL_ROMAN_LETTER_ROMAN` | I. / A. / i. |
1062
+ | `MULTILEVEL_NESTED_NUMBER` | 1 / 1.1 / 1.1.1 |
1063
+ | `MULTILEVEL_NESTED_NUMBER_DOT` | 1. / 1.1. / 1.1.1. |
1064
+ | `MULTILEVEL_NESTED_FULL_WIDTH` | 1 / 1-1 / 1-1-1 |
1065
+
1066
+ <a id="word-pagenumberarea"></a>
1067
+ #### `PageNumberArea`
1068
+
1069
+ 페이지 번호 대상 영역 (setPageNumber area).
1070
+
1071
+ | 상수 | 설명 |
1072
+ |---|---|
1073
+ | `HEADER` | 머리글 |
1074
+ | `FOOTER` | 바닥글 |
1075
+
1076
+ <a id="word-pagenumberalign"></a>
1077
+ #### `PageNumberAlign`
1078
+
1079
+ 페이지 번호 정렬 (setPageNumber align).
1080
+
1081
+ | 상수 | 설명 |
1082
+ |---|---|
1083
+ | `LEFT` | 왼쪽 정렬 |
1084
+ | `CENTER` | 가운데 정렬 |
1085
+ | `RIGHT` | 오른쪽 정렬 |
1086
+
1087
+ <a id="word-borderstyle"></a>
1088
+ #### `BorderStyle`
1089
+
1090
+ 테두리 선 스타일 (셀·단락 테두리 공용).
1091
+
1092
+ | 상수 | 설명 |
1093
+ |---|---|
1094
+ | `SOLID` | — |
1095
+ | `DASHED` | — |
1096
+ | `DOTTED` | — |
1097
+ | `DOUBLE` | — |
1098
+ | `NONE` | — |
1099
+ | `HIDDEN` | — |
1100
+
1101
+ <a id="word-borderlocation"></a>
1102
+ #### `BorderLocation`
1103
+
1104
+ 테두리 적용 위치(면/영역) (셀·단락 테두리 공용).
1105
+ - 단락 테두리: top/bottom/left/right/all/between 유효 (between=단락 사이 가로선, 단락 전용).
1106
+ - 표 셀 테두리: top/bottom/left/right/all/outer/inner/betweenRows/betweenColumns 유효.
1107
+
1108
+ | 상수 | 설명 |
1109
+ |---|---|
1110
+ | `TOP` | — |
1111
+ | `RIGHT` | — |
1112
+ | `BOTTOM` | — |
1113
+ | `LEFT` | — |
1114
+ | `ALL` | — |
1115
+ | `OUTER` | — |
1116
+ | `INNER` | — |
1117
+ | `BETWEEN_ROWS` | — |
1118
+ | `BETWEEN_COLUMNS` | — |
1119
+ | `BETWEEN` | — |
1120
+
1121
+ <a id="word-tabalignment"></a>
1122
+ #### `TabAlignment`
1123
+
1124
+ 탭 스톱 정렬 (값은 코어 tab val 과 동일).
1125
+
1126
+ | 상수 | 설명 |
1127
+ |---|---|
1128
+ | `LEFT` | — |
1129
+ | `CENTER` | — |
1130
+ | `RIGHT` | — |
1131
+ | `DECIMAL` | — |
1132
+
1133
+ <a id="word-tableader"></a>
1134
+ #### `TabLeader`
1135
+
1136
+ 탭 스톱 리더(빈 공간 채움 문자) (값은 코어 tab leader 와 동일).
1137
+
1138
+ | 상수 | 설명 |
1139
+ |---|---|
1140
+ | `NONE` | — |
1141
+ | `DOT` | — |
1142
+ | `HYPHEN` | — |
1143
+ | `UNDERSCORE` | — |
1144
+ | `MIDDLE_DOT` | — |
1145
+
1146
+ <a id="word-pageorientation"></a>
1147
+ #### `PageOrientation`
1148
+
1149
+ 페이지 방향 (setPageSize orientation).
1150
+
1151
+ | 상수 | 설명 |
1152
+ |---|---|
1153
+ | `PORTRAIT` | 세로 |
1154
+ | `LANDSCAPE` | 가로 |
1155
+
1156
+ <a id="word-papersize"></a>
1157
+ #### `PaperSize`
1158
+
1159
+ 용지 크기 프리셋 (setPageSize 프리셋 이름).
1160
+
1161
+ | 상수 | 설명 |
1162
+ |---|---|
1163
+ | `A3` | — |
1164
+ | `A4` | — |
1165
+ | `A5` | — |
1166
+ | `LETTER` | — |
1167
+ | `LEGAL` | — |
1168
+ | `EXECUTIVE` | — |
1169
+
1170
+ <a id="word-numberformat"></a>
1171
+ #### `NumberFormat`
1172
+
1173
+ 페이지 번호 형식 (setPageNumbering formatType / getPageSetup().pageNumber.formatType).
1174
+
1175
+ | 상수 | 설명 |
1176
+ |---|---|
1177
+ | `DECIMAL` | 1, 2, 3 |
1178
+ | `DECIMAL_CIRCLE` | ①, ②, ③ |
1179
+ | `DECIMAL_PAREN` | (1), (2), (3) |
1180
+ | `DECIMAL_FULLSTOP` | 1., 2., 3. |
1181
+ | `DECIMAL_ZERO` | 01, 02, 03 |
1182
+ | `DECIMAL_FULL_WIDTH` | 1, 2, 3 (전각) |
1183
+ | `DECIMAL_HALF_WIDTH` | 1, 2, 3 (반각) |
1184
+ | `NUMBER_DASH` | -1-, -2-, -3- |
1185
+ | `CARDINAL_TEXT` | One, Two, Three |
1186
+ | `ORDINAL` | 1st, 2nd, 3rd |
1187
+ | `ORDINAL_TEXT` | First, Second, Third |
1188
+ | `CHICAGO` | *, †, ‡, § |
1189
+ | `HEX` | 1, 2, ..., 9, A, B |
1190
+ | `LOWER_LETTER` | a, b, c |
1191
+ | `UPPER_LETTER` | A, B, C |
1192
+ | `LOWER_ROMAN` | i, ii, iii |
1193
+ | `UPPER_ROMAN` | I, II, III |
1194
+ | `HANGUL_CHOSUNG` | ㄱ, ㄴ, ㄷ |
1195
+ | `HANGUL_GANADA` | 가, 나, 다 |
1196
+ | `KOREAN_COUNT` | 일, 이, 삼 |
1197
+ | `KOREAN_LEGAL` | 하나, 둘, 셋 |
1198
+ | `KOREAN_DIGITAL` | 一, 二, 三 |
1199
+ | `KOREAN_DIGITAL2` | 壹, 貳, 參 |
1200
+ | `CHINESE_COUNT` | 一, 二, 三 |
1201
+ | `CHINESE_COUNTING_THOUSAND` | 一, 二, 三 (천 단위) |
1202
+ | `CHINESE_LEGAL` | 壹, 贰, 叁 |
1203
+ | `CHINESE_DIGITAL` | 一, 二, 三 (자릿수 나열) |
1204
+ | `CHINESE_ZERO_TAIWANESE_DIGITAL` | 〇, 一, 二 |
1205
+ | `TAIWANESE_COUNT` | 一, 二, 三 |
1206
+ | `TAIWANESE_COUNTING_THOUSAND` | 一, 二, 三 (천 단위) |
1207
+ | `TAIWANESE_DIGITAL` | 一, 二, 三 (자릿수 나열) |
1208
+ | `IDEOGRAPH_DIGITAL` | 一, 二, 三 |
1209
+ | `IDEOGRAPH_CIRCLE` | ㊀, ㊁, ㊂ |
1210
+ | `IDEOGRAPH_LEGAL` | 壹, 貳, 參 |
1211
+ | `IDEOGRAPH_TRADITIONAL` | 갑, 을, 병 (십간) |
1212
+ | `IDEOGRAPH_ZODIAC` | 자, 축, 인 (십이지) |
1213
+ | `IDEOGRAPH_ZODIAC_TRADITIONAL` | 갑자, 을축, 병인 (육십갑자) |
1214
+ | `JAPANESE_COUNT` | 一, 二, 三 |
1215
+ | `JAPANESE_DIGITAL` | 一, 二, 三 (만 단위) |
1216
+ | `JAPANESE_LEGAL` | 壱, 弐, 参 |
1217
+ | `JAPANESE_AIUEO` | ア, イ, ウ (반각) |
1218
+ | `JAPANESE_AIUEO_FULL_WIDTH` | ア, イ, ウ (전각) |
1219
+ | `JAPANESE_IROHA` | イ, ロ, ハ (반각) |
1220
+ | `JAPANESE_IROHA_FULL_WIDTH` | イ, ロ, ハ (전각) |
1221
+ | `NONE` | 번호 표시 안 함 |
1222
+
1223
+ <a id="mod-cell"></a>
1224
+ ## Spreadsheet
1225
+
1226
+ Spreadsheet 문서를 다루는 기능입니다. 시트·셀 값 편집, 서식 적용, 차트·표·자동 필터 관리 등을 외부 서비스에서 호출할 수 있습니다.
1227
+
1228
+ <a id="cell-workbook"></a>
1229
+ ### Workbook — 통합 문서 (`Workbook`)
1230
+
1231
+ 통합 문서 전체를 다루는 최상위 객체이자 셀 API 의 진입점이다.
1232
+ 시트·표·정의된 이름처럼 문서에 속한 요소를 조회하고 관리한다.
1233
+
1234
+ | 기능 | 설명 | 입력 | 결과 |
1235
+ |---|---|---|---|
1236
+ | `getSheetList` | 문서의 시트 구성을 배열로 반환한다. 배열 인덱스가 곧 시트 인덱스(0-based)이며 숨긴 시트도 포함한다.<br>각 시트의 상세 속성은 Worksheet 에서 조회한다. | — | [`SheetSummary`](#cell-sheetsummary) 목록 |
1237
+ | `getWorksheet` | 시트 핸들을 반환한다. 시트 이름으로 지정할 때는 대소문자를 구분한다.<br>sheet 를 생략하면 활성 시트를 대상으로 한다. | `sheet` (선택) `number \| string` — 시트 인덱스(0-based, getSheetList() 결과의 배열 인덱스) 또는 시트 이름 | [`Worksheet`](#cell-worksheet) |
1238
+ | `getObjectById` | ID 로 객체 핸들을 반환한다. 문서의 모든 시트를 대상으로 하며, 현재는 차트 객체만 지원한다.<br>차트가 아닌 객체는 null 을 반환한다. | `oid` 문자열 — 객체를 식별하는 고유 ID | [`Chart`](#cell-chart) |
1239
+ | `getTable` | 이름으로 표 핸들을 반환한다. 이름은 대소문자를 구분하지 않으며, 핸들에는 실제 저장된 표 이름이 담긴다. | `name` 문자열 — 표 이름. 문서 전체에서 유일하다 | [`Table`](#cell-table) |
1240
+ | `getDefinedName` | 전달한 name 을 이름으로 하는 정의된 이름을 반환한다. 이름은 대소문자를 구분하지 않는다.<br>sheet 를 생략하면 문서 전체에서 쓰는 이름만 찾는다. | `name` 문자열 — 찾을 이름<br>`sheet` (선택) `number \| string` — 특정 시트에서만 쓰는 이름이면 그 시트 | [`Name`](#cell-name) |
1241
+ | `addDefinedName` | 정의된 이름을 만든다. formula 는 `=` 로 시작해도 되고 아니어도 된다.<br>수식에서 시트를 지정하지 않은 참조는 활성 시트 기준으로 해석한다.<br>sheet 를 생략하면 문서 전체에서 쓰는 이름으로 만든다.<br>같은 이름의 정의된 이름이나 표가 이미 있으면 만들어지지 않고 오류가 발생한다. | `name` 문자열 — 만들 이름<br>`formula` 문자열 — 이름이 가리킬 수식 또는 참조<br>`sheet` (선택) `number \| string` — 특정 시트에서만 쓸 이름이면 그 시트 | [`Name`](#cell-name) |
1242
+ | `getDefinedNameList` | 정의된 이름 목록을 반환한다. 내장 이름, 숨긴 이름, 수식이 없는 이름은 제외한다.<br>sheet 를 생략하면 문서 전체에서 쓰는 이름을 반환한다. formula 는 `=` 으로 시작한다. | `sheet` (선택) `number \| string` — 특정 시트에서만 쓰는 이름이면 그 시트 | [`NameInfo`](#cell-nameinfo) 목록 |
1243
+ | `addSheet` | 새 시트를 시트 목록 맨 뒤에 추가하고, 추가한 시트를 활성 시트로 만든다. | `name` 문자열 — 새 시트 이름 | [`SheetRef`](#cell-sheetref) |
1244
+ | `removeSheet` | 시트를 삭제한다. 활성 시트를 삭제하면 인접한 시트가 활성 시트가 된다.<br>남은 시트가 하나뿐이거나 숨기지 않은 시트가 하나뿐이면 삭제할 수 없다. | `sheet` `number \| string` — 삭제할 시트 | — |
1245
+ | `copySheet` | 시트를 복사해 원본 바로 뒤에 넣고, 복사본을 활성 시트로 만든다. | `sheet` `number \| string` — 복사할 시트 | [`SheetRef`](#cell-sheetref) |
1246
+ | `moveSheet` | 시트 위치를 이동한다. | `from` `number \| string` — 옮길 시트<br>`to` 숫자 — 옮겨 놓을 자리의 시트 인덱스(0-based) | — |
1247
+ | `setActiveSheet` | 활성 시트를 변경한다. 숨긴 시트는 활성화할 수 없다. | `sheet` `number \| string` — 활성화할 시트 | — |
1248
+ | `getDocumentProperties` | 문서 속성을 반환한다. 문서에 없는 속성은 undefined 값을 가진다. | — | [`DocumentProperties`](#cell-documentproperties) |
1249
+
1250
+ <a id="cell-worksheet"></a>
1251
+ ### Worksheet — 워크시트 (`Worksheet`)
1252
+
1253
+ 시트 하나를 다루는 핸들이다.
1254
+ 시트 자체의 속성과 그 시트에 속한 범위·차트·표·필터·규칙을 조회하고 관리한다.
1255
+
1256
+ | 기능 | 설명 | 입력 | 결과 |
1257
+ |---|---|---|---|
1258
+ | `getName` | 시트 이름을 반환한다. | — | 문자열 |
1259
+ | `isHidden` | 시트가 숨겨져 있는지 반환한다. | — | 참/거짓 |
1260
+ | `getTabColor` | 시트 탭 색을 "#RRGGBB" 형태로 반환한다. 색을 지정하지 않은 시트는 빈 문자열이다. | — | 문자열 |
1261
+ | `getSelection` | 이 시트의 선택 영역을 가리키는 Range 핸들을 반환한다.<br>선택 영역은 시트마다 따로 보관되므로 활성 시트가 아닌 시트에서도 조회할 수 있다. | — | [`Range`](#cell-range) |
1262
+ | `getUsedRange` | 값이나 셀 서식이 있는 셀을 모두 감싸는 사각 범위를 반환한다.<br>차트·도형과 행 높이·열 너비는 이 범위에 반영하지 않는다. | — | 값도 셀 서식도 없는 시트에서는 null 이다<br>[`Range`](#cell-range) |
1263
+ | `getMergeCellList` | 이 시트의 병합 셀 목록을 반환한다. 특정 범위와 겹치는 병합만 필요하면 Range.getMergeCellList() 를 쓴다. | — | 병합된 영역을 A1 표기로 담은 배열<br>문자열 목록 |
1264
+ | `getHyperlinkList` | 이 시트의 하이퍼링크 목록을 반환한다. | — | [`HyperlinkInfo`](#cell-hyperlinkinfo) 목록 |
1265
+ | `getFreezePanes` | 틀 고정 상태를 반환한다. | — | [`FreezePanes`](#cell-freezepanes) |
1266
+ | `isGridlinesVisible` | 눈금선을 표시하는지 반환한다. | — | 참/거짓 |
1267
+ | `getZoom` | 화면 확대 배율을 반환한다. | — | 1 이 100% 인 배율. 퍼센트로 환산하지 않는다<br>숫자 |
1268
+ | `getSheetInfo` | 시트 속성을 한 번에 반환한다. 각 항목은 같은 이름의 개별 조회 메서드와 같은 값이다. | — | [`SheetInfo`](#cell-sheetinfo) |
1269
+ | `setName` | 시트 이름을 변경한다. | `name` 문자열 — 새 시트 이름 | — |
1270
+ | `setHidden` | 시트를 숨기거나 다시 표시한다.<br>숨기지 않은 시트가 이 시트 하나뿐이면 동작하지 않는다.<br>활성 시트를 숨기면 인접한 숨기지 않은 시트가 활성 시트가 된다. | `hidden` 참/거짓 — true 면 숨기고 false 면 다시 표시한다 | — |
1271
+ | `setTabColor` | 시트 탭 색을 설정한다. 빈 문자열이나 null 을 넘기거나 생략하면 지정된 탭 색을 지운다. | `color` (선택) 문자열 (없을 수 있음) — 탭 색. "#RRGGBB" 외에 3·4·8 자리 hex, "#" 을 생략한 hex, "red" 같은 색 이름도 받는다 | — |
1272
+ | `setSelection` | 선택 영역을 설정한다. 대상 시트가 활성 시트가 아니면 먼저 활성 시트로 만들며, 숨긴 시트는 활성화할 수 없어 오류가 발생한다.<br>선택한 영역이 보이도록 화면을 스크롤하려면 goto() 를 쓴다. | `range` `string \| RangeCoords` — 선택할 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10") | [`SelectionInfo`](#cell-selectioninfo) |
1273
+ | `goto` | 지정한 영역을 선택하고 그 영역이 보이도록 화면을 스크롤한다.<br>대상 시트가 활성 시트가 아니면 먼저 활성 시트로 만들고, 숨긴 시트를 지정하면 숨기지 않은 다른 시트로 대체해 이동한다. | `range` `string \| RangeCoords` — 이동할 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10") | 숨긴 시트를 지정했다면 대체해 이동한 시트의 이름이 담긴다<br>[`SelectionInfo`](#cell-selectioninfo) |
1274
+ | `setFreezePanes` | 틀 고정을 설정한다. 0 이하이거나 null 을 넘기면 그 방향의 고정을 해제한다. | `rows` (선택) 숫자 (없을 수 있음) — 고정할 상단 행 수 (기본값: 0)<br>`cols` (선택) 숫자 (없을 수 있음) — 고정할 좌측 열 수 (기본값: 0) | — |
1275
+ | `setGridlinesVisible` | 눈금선 표시 여부를 설정한다. | `visible` 참/거짓 — true 면 눈금선을 표시하고 false 면 감춘다 | — |
1276
+ | `setZoom` | 화면 확대 배율을 설정한다. 허용 범위를 벗어난 값은 경계값으로 맞추지 않고 오류가 발생한다. | `zoomFactor` 숫자 — 1 이 100% 인 배율. 0.5 이상 1.5 이하여야 한다 | — |
1277
+ | `getRange` | 이 시트의 영역을 가리키는 Range 핸들을 반환한다.<br>핸들은 행이나 열을 삽입·삭제해도 처음 지정한 좌표를 유지한다. | `range` `string \| RangeCoords` — 대상 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10", 행 전체는 "5:5", 열 전체는 "A:C") | [`Range`](#cell-range) |
1278
+ | `addChart` | 이 시트에 차트를 추가하고 그 차트의 핸들을 반환한다. 제목은 데이터에서 뽑아 자동으로 붙는다.<br>시리즈로 쓸 행이나 열은 100 개까지 지원한다.<br>데이터 범위는 이 시트의 것만 받는다. | `chartType` [`ChartType`](#common-charttype) — 차트 종류. 지원하지 않는 종류는 오류가 발생한다<br>`dataRange` `string \| RangeCoords` — 차트가 사용할 데이터 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")<br>`opts` (선택) [`AddChartOptions`](#cell-addchartoptions) — 추가 옵션 | [`Chart`](#cell-chart) |
1279
+ | `getChart` | ID 로 차트 핸들을 반환한다. 이 시트에 있는 차트만 대상으로 한다. | `oid` 문자열 — 차트를 식별하는 고유 ID. getChartList() 결과의 oid 다 | [`Chart`](#cell-chart) |
1280
+ | `getChartList` | 이 시트의 차트 정보 목록을 반환한다. 핸들이 필요하면 항목의 oid 로 getChart() 를 호출한다. | — | [`ChartInfo`](#cell-chartinfo) 목록 |
1281
+ | `addTable` | 이 시트에 표를 만들고 그 표의 핸들을 반환한다. 표 이름은 자동으로 정해진다.<br>머리글을 쓰지 않거나 범위가 한 행뿐이면 맨 위에 빈 머리글 행이 들어가, 아래 내용이 한 행씩 밀리고 표는 범위보다 한 행 넓어진다.<br>공동 편집 중이거나, 범위가 행 전체·열 전체이거나 시트의 마지막 행을 포함하면 만들 수 없다. | `dataRange` `string \| RangeCoords` — 표로 만들 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")<br>`hasHeaders` (선택) 참/거짓 — 범위의 첫 행을 머리글로 쓸지 여부 (기본값: true) | [`Table`](#cell-table) |
1282
+ | `getTableList` | 이 시트의 표 요약 목록을 반환한다. 핸들이 필요하면 요약의 name 으로 Workbook.getTable() 을 호출한다. | — | [`TableInfo`](#cell-tableinfo) 목록 |
1283
+ | `getFilter` | 이 시트의 자동 필터 핸들을 반환한다. 자동 필터가 설정돼 있지 않아도 핸들은 돌려주므로, 설정 여부는 핸들의 getInfo() 가 주는 enabled 로 확인하고 설정은 create() 로 한다. | — | [`Filter`](#cell-filter) |
1284
+ | `getConditionalFormatList` | 이 시트의 조건부 서식 규칙 목록을 반환한다.<br>각 항목의 rule 은 규칙을 다시 추가할 때 그대로 넘길 수 있다. 적용 영역과 우선순위는 규칙 밖이라 따로 준다.<br>rule.style 의 글꼴 크기·이름, 그라데이션, 숫자 서식은 현재 조회만 지원한다.<br>파일에서 읽어 프리셋에 없는 모양이 된 dataBar 는 colors·gradient·cfvo 로 나오며, 이 셋은 현재 조회만 지원한다. | — | [`ConditionalFormatInfo`](#cell-conditionalformatinfo) 목록 |
1285
+ | `getDataValidationList` | 이 시트의 데이터 유효성 규칙 목록을 반환한다. | — | [`DataValidationRule`](#cell-datavalidationrule) 목록 |
1286
+ | `getCommentList` | 이 시트의 셀 메모 목록을 반환한다. | — | [`CommentInfo`](#cell-commentinfo) 목록 |
1287
+ | `updateConditionalFormatRules` | 조건부 서식 규칙을 한 번에 편집한다. 규칙 삭제·적용 영역 변경·우선순위 이동을 한 묶음으로 처리해 하나라도 적용할 수 없으면 아무것도 바뀌지 않는다.<br>편집 하나만 적용할 때는 동작별 메서드를 쓴다.<br>규칙의 조건 자체는 바꿀 수 없어, 조건을 바꾸려면 규칙을 지우고 다시 추가한다. | `descriptor` [`ConditionalFormatUpdate`](#cell-conditionalformatupdate) — 적용할 편집 내용 | — |
1288
+ | `deleteConditionalFormatRules` | 조건부 서식 규칙을 삭제한다. | `priorities` 숫자 목록 — 삭제할 규칙 priority 목록. 빈 목록은 받지 않는다 | — |
1289
+ | `setConditionalFormatRuleRanges` | 조건부 서식 규칙 하나의 적용영역을 교체한다.<br>두 인자는 ConditionalFormatRangeSet 의 필드와 같은 계약이다. | `priority` 숫자 — 대상 규칙 priority<br>`ranges` `string \| RangeCoords[]` — 새 적용 영역 | — |
1290
+ | `moveConditionalFormatRule` | 조건부 서식 규칙 하나를 다른 우선순위 자리로 옮긴다. 사이 규칙은 한 칸씩 shift 된다(Excel/Sheets 동일). | `priority` 숫자 — 옮길 규칙 priority<br>`to` 숫자 — 옮겨 갈 자리. 지금 그 자리에 있는 규칙의 priority 를 넘긴다 | — |
1291
+
1292
+ <a id="cell-chart"></a>
1293
+ ### Chart — 차트 (`Chart`)
1294
+
1295
+ 워크시트에 놓인 차트 하나를 가리키는 핸들이다.
1296
+ 차트의 종류와 스타일, 제목·축 제목·범례·데이터레이블·눈금선, 데이터 소스 범위와 놓인 자리를 다룬다.
1297
+
1298
+ | 기능 | 설명 | 입력 | 결과 |
1299
+ |---|---|---|---|
1300
+ | `getType` | 차트 종류를 반환한다. ChartType 에 없는 종류는 "unknown" 을 반환한다. | — | 문자열 |
1301
+ | `isEditable` | 이 차트를 편집할 수 있는지 반환한다. 외부 데이터를 소스로 하는 차트는 조회만 되고 편집은 되지 않는다. | — | 참/거짓 |
1302
+ | `getTitle` | 차트 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열을 반환한다. | — | 문자열 |
1303
+ | `getAxisTitle` | 지정한 축의 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열이고, 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null 을 반환한다. | `axis` [`ChartAxis`](#common-chartaxis) — 제목을 읽을 축(가로축 또는 세로축) | 문자열 (없을 수 있음) |
1304
+ | `getLegendPosition` | 범례 위치를 반환한다. 범례를 숨긴 차트는 "none" 이고, 위치를 알아낼 수 없는 차트는 "right" 로 보고한다. | — | [`ChartLegendPosition`](#common-chartlegendposition) |
1305
+ | `getDataLabelPosition` | 데이터레이블 위치를 반환한다. 데이터레이블을 표시하지 않는 차트는 "none" 을 반환한다. | — | [`ChartDataLabelPosition`](#common-chartdatalabelposition) |
1306
+ | `getGridLine` | 지정한 축의 눈금선 종류를 반환한다. 눈금선을 꺼 둔 축은 "none" 이고, 그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 null 을 반환한다. | `axis` [`ChartAxis`](#common-chartaxis) — 눈금선을 읽을 축(가로축 또는 세로축) | [`ChartGridLineType`](#common-chartgridlinetype) (없을 수 있음) |
1307
+ | `setType` | 차트 종류를 바꾼다. 지금 종류와 같은 값을 넘기면 아무것도 바뀌지 않는다. | `chartType` [`ChartType`](#common-charttype) — 바꿀 차트 종류(enum 문자열, 예: "clustered_column") | — |
1308
+ | `setStyle` | 차트의 프리셋 스타일을 바꾼다. 번호에 대응하는 실제 색은 문서 테마를 따른다. | `style` 숫자 — 스타일 번호(1~12 정수). 세 개씩 색 그룹이 나뉘고(1~3, 4~6, 7~9, 10~12), 한 그룹 안의 세 번호는 배경만 다르다(반투명 배경, 흰색 배경, 색상 배경과 계열 테두리 순) | — |
1309
+ | `setTitle` | 차트 제목을 설정한다. | `title` 문자열 — 차트에 표시할 제목 | — |
1310
+ | `setAxisTitle` | 지정한 축의 제목을 설정한다. 축 제목은 원형 계열·도넛·방사형을 뺀 차트 종류에서 지원한다. | `axis` [`ChartAxis`](#common-chartaxis) — 제목을 설정할 축(가로축 또는 세로축)<br>`title` 문자열 — 축에 표시할 제목 | — |
1311
+ | `setLegendPosition` | 범례 위치를 설정한다. "none" 을 넘기면 범례를 숨긴다. | `position` [`ChartLegendPosition`](#common-chartlegendposition) — 범례를 놓을 자리 | — |
1312
+ | `setDataLabelPosition` | 데이터레이블 위치를 설정한다. "none" 을 넘기면 데이터레이블을 숨긴다.<br>쓸 수 있는 위치는 차트 종류마다 다르며, "none" 은 모든 종류에서 쓸 수 있다. | `position` [`ChartDataLabelPosition`](#common-chartdatalabelposition) — 데이터레이블을 놓을 자리 | — |
1313
+ | `setGridLine` | 지정한 축의 눈금선을 설정한다. "none" 을 넘기면 그 축의 눈금선을 숨긴다.<br>그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 "none" 을 포함해 어떤 값을 넘겨도 오류가 발생한다. | `axis` [`ChartAxis`](#common-chartaxis) — 눈금선을 설정할 축(가로축 또는 세로축)<br>`gridType` [`ChartGridLineType`](#common-chartgridlinetype) — 표시할 눈금선 종류 | — |
1314
+ | `getId` | 이 차트를 식별하는 고유 ID 를 반환한다. | — | 문자열 |
1315
+ | `getDataRange` | 차트가 데이터로 삼는 셀 범위를 시트 이름을 앞에 붙인 A1 표기 문자열로 반환한다("Sheet1!A1:C5").<br>참조가 여러 시트에 걸쳐 있거나 하나의 사각 영역으로 합쳐지지 않으면 null 을 반환한다. | — | 문자열 (없을 수 있음) |
1316
+ | `getChartInfo` | 차트의 서식 상태에 이 차트의 식별자와 데이터 범위를 더해 반환한다.<br>서식 값은 공통 표면이 주는 것과 같고, oid 와 range 만 셀이 더한다. | — | [`ChartInfo`](#cell-chartinfo) |
1317
+ | `delete` | 차트를 삭제한다. | — | [`CommandResult`](#cell-commandresult) |
1318
+ | `setDataRange` | 차트의 데이터 소스 범위를 바꾼다. 행과 열은 각각 100 개까지 지원한다.<br>시트를 지정하지 않으면 차트가 놓인 시트의 영역으로 처리한다.<br>seriesBy 를 생략하면 지금의 시리즈 방향을 유지한다. | `dataRange` `string \| SheetRangeCoords \| RangeCoords` — 새 데이터 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10", 다른 시트는 "Sheet2!A1:C5")<br>`seriesBy` (선택) `"auto" \| "rows" \| "columns"` — 시리즈 방향. rows 는 행 하나가, columns 는 열 하나가 시리즈가 되고, auto 는 새 범위의 모양에 맞춰 정한다. 분산형과 거품형 차트는 rows·columns 를 받지 않는다 | — |
1319
+ | `switchRowColumn` | 데이터의 행과 열을 맞바꿔 시리즈 방향을 전환한다. 호출할 때마다 방향이 번갈아 바뀐다.<br>분산형과 거품형 차트는 전환할 수 없고, 데이터 범위가 없거나 행이나 열이 100개를 넘는 차트도 전환할 수 없다. | — | — |
1320
+ | `setPosition` | 차트의 왼쪽 위 모서리를 지정한 셀로 옮긴다. 크기는 그대로 둔다.<br>startCell 에 여러 셀로 이루어진 범위를 넘기면 그 범위의 왼쪽 위 셀만 쓰고 나머지는 무시한다. | `startCell` `string \| RangeCoords` — 옮겨 놓을 셀. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10") | — |
1321
+
1322
+ <a id="cell-filter"></a>
1323
+ ### Filter — 자동 필터 (`Filter`)
1324
+
1325
+ 시트 또는 표의 자동 필터를 가리키는 핸들이다.
1326
+ 필터 영역과 열별 필터 조건, 필터 영역의 정렬 상태를 다룬다.
1327
+
1328
+ | 기능 | 설명 | 입력 | 결과 |
1329
+ |---|---|---|---|
1330
+ | `create` | 자동 필터를 만든다.<br>시트 필터는 range 로 지정한 영역에 만들며, range 를 생략하면 현재 선택 영역을 둘러싼 데이터 영역으로 넓혀 잡는다.<br>표 필터는 range 를 무시하고 요약 행을 뺀 표 영역에 만든다.<br>대상에 이미 필터가 있으면 만들 수 없고, range 를 생략했는데 선택 영역이 빈 셀 하나뿐이어도 만들 수 없다. | `range` (선택) `string \| RangeCoords` — 필터를 만들 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10") | — |
1331
+ | `applyFilter` | 지정한 열에 필터 조건을 적용한다. criteria 가 null 이면 그 열의 조건을 해제한다.<br>머리글 셀이 병합된 열을 지정하면 병합 영역의 첫 열에 적용된다.<br>시트 필터는 미리 create() 로 만들어 두어야 하지만, 표는 필터가 없을 때 조건을 적용하면 필터가 함께 만들어진다. | `colId` 숫자 — 대상 열. 필터 영역 첫 열부터 센 0-based 오프셋이며(0 = 첫 열), getInfo() 의 columns[].colId 와 같은 좌표계다<br>`criteria` `Record<string, unknown> \| null` — 적용할 조건. filterType 에 따라 값 목록·사용자 지정·상위 하위·동적 필터 중 한 스키마를 쓰며, 종류와 연산자 어휘는 FilterType·FilterOperator·FilterDynamicType 상수로 지정한다. null 이면 조건을 해제한다 | — |
1332
+ | `clearFilter` | 필터 조건을 해제한다. colId 를 지정하면 그 열만, 생략하면 조건이 걸린 모든 열을 해제한다.<br>필터 버튼은 그대로 남는다.<br>해제할 조건이 없거나 표에 아직 필터가 없으면 아무것도 바꾸지 않는다. | `colId` (선택) 숫자 — 해제할 열. 필터 영역 첫 열부터 센 0-based 오프셋이며(0 = 첫 열), 생략하면 모든 열을 해제한다 | — |
1333
+ | `sort` | 필터 영역을 지정한 열 기준으로 정렬하고, 정렬 상태를 필터에 남긴다.<br>머리글 셀이 병합된 열을 지정하면 병합 영역의 첫 열을 기준으로 정렬한다.<br>표는 필터가 없으면 정렬하면서 함께 만들지만, 시트는 자동으로 만들지 않아 create() 로 먼저 만들어야 한다. | `colId` 숫자 — 정렬 기준 열. 필터 영역 첫 열부터 센 0-based 오프셋이며(0 = 첫 열), getInfo() 의 sort.colId 와 같은 좌표계다<br>`order` [`SortOrder`](#cell-sortorder) — 정렬 방향. SortOrder 의 오름차순·내림차순 두 값만 받는다 | 이어서 호출할 수 있도록 이 핸들을 그대로 반환한다<br>[`Filter`](#cell-filter) |
1334
+ | `remove` | 자동 필터를 없앤다. 필터 영역과 열 조건이 함께 사라진다. | — | — |
1335
+ | `getInfo` | 필터 영역과 열별 조건, 필터로 숨겨진 행 수, 정렬 상태를 반환한다.<br>필터가 아직 없으면 enabled 만 false 로 담고 나머지 필드는 넣지 않는다. | — | [`FilterInfo`](#cell-filterinfo) |
1336
+
1337
+ <a id="cell-name"></a>
1338
+ ### Name — 이름 정의 (`Name`)
1339
+
1340
+ 통합 문서에 정의된 이름 하나를 다루는 핸들이다.
1341
+ 이름이 가리키는 수식과 그 이름의 사용 범위를 다룬다.
1342
+
1343
+ | 기능 | 설명 | 입력 | 결과 |
1344
+ |---|---|---|---|
1345
+ | `getName` | 지정된 이름을 반환한다. | — | 문자열 |
1346
+ | `getSheetName` | 이 이름의 사용 범위인 시트 이름을 반환한다. | — | 특정 시트에서만 쓰는 이름이면 그 시트 이름, 문서 전체에서 쓰는 이름이면 null<br>문자열 (없을 수 있음) |
1347
+ | `getFormula` | 이 이름이 가리키는 수식을 `=` 로 시작하는 형태로 반환한다.<br>수식의 상대 참조는 활성 시트의 활성 셀을 기준으로 풀어 쓰므로, 같은 이름이라도 활성 셀이 달라지면 반환값이 달라질 수 있다. | — | 문자열 |
1348
+ | `getRanges` | 이 이름이 실제로 가리키는 영역을 반환한다. 영역이 여럿이면 콤마로 이어 붙이고, 각 영역에는 시트 이름을 항상 붙인다.<br>행이나 열이 삽입·삭제되어 참조가 밀려도 지금 가리키는 위치를 돌려준다. | — | 상수나 오류를 가리키는 이름, 지원하지 않는 함수를 쓴 이름이면 빈 문자열<br>문자열 |
1349
+ | `setName` | 정의된 이름의 이름을 바꾼다. 이 핸들도 새 이름을 가리키므로 바꾼 뒤에도 계속 쓸 수 있다.<br>같은 범위에 같은 이름이 이미 있거나 같은 이름의 표가 있으면 바꿀 수 없다. 이때 대소문자는 구분하지 않지만, 대소문자만 바꾸는 변경은 중복으로 보지 않는다. | `newName` 문자열 — 새 이름. 공백이나 허용되지 않는 문자를 쓸 수 없고, 예약된 이름이나 셀 참조로 읽히는 이름, 최대 길이를 넘는 이름도 받지 않는다 | — |
1350
+ | `setFormula` | 정의된 이름이 가리킬 수식을 바꾼다.<br>수식에 시트를 적지 않은 참조는 이름의 사용 범위와 무관하게 활성 시트 기준으로 해석한다. | `formula` 문자열 — 새 수식 또는 참조. `=` 로 시작해도 되고 아니어도 된다 | — |
1351
+ | `update` | 정의된 이름의 이름과 수식을 한 번에 바꾼다.<br>바꿀 항목을 하나도 주지 않으면 오류가 난다. | `fields` [`NameUpdate`](#cell-nameupdate) — 바꿀 항목 | — |
1352
+ | `delete` | 정의된 이름을 삭제한다. 삭제한 뒤에는 이 핸들로 수식을 조회하거나 내용을 바꿀 수 없다. | — | — |
1353
+ | `getInfo` | 이름과 사용 범위 시트, 수식을 한 번에 반환한다.<br>name 은 getName(), formula 는 getFormula() 와 같은 규칙을 따른다. | — | [`NameInfo`](#cell-nameinfo) |
1354
+
1355
+ <a id="cell-range"></a>
1356
+ ### Range — 셀 범위 (`Range`)
1357
+
1358
+ 시트 안의 한 영역(셀 하나, 여러 셀, 행 전체, 열 전체)을 다루는 핸들이다.
1359
+ 영역에 담긴 값·수식과 셀 서식, 그리고 영역에 걸린 병합·메모·하이퍼링크·규칙을 다룬다.
1360
+
1361
+ | 기능 | 설명 | 입력 | 결과 |
1362
+ |---|---|---|---|
1363
+ | `getAddress` | 이 범위의 A1 주소를 반환한다("B2:C5", 단일 셀이면 "E10").<br>시트 이름을 붙이면 공백이나 특수문자가 든 이름은 따옴표로 감싼다. 이 형태는 getRange() 가 받지 않는다. | `includeSheetName` (선택) 참/거짓 — true 면 시트 이름을 붙이고, false 면 주소만 반환한다 (기본값: false) | 문자열 |
1364
+ | `getCoordinates` | 이 범위의 0-based 좌표를 반환한다. A1 주소가 필요하면 getAddress() 를 쓴다.<br>시트가 삭제됐으면 SHEET_NOT_FOUND 를 throw 한다. | — | [`SheetRangeCoords`](#cell-sheetrangecoords) |
1365
+ | `isSingleCell` | 범위가 셀 하나인지 반환한다. 여러 행이나 여러 열에 걸친 범위는 false 다. | — | 참/거짓 |
1366
+ | `getValue` | 범위 좌상단 셀의 원시값인 문자열·숫자·불리언 중 하나의 타입 값이 반환되며, 수식 셀은 계산 결과값을 반환한다. | — | 빈 셀은 undefined 다<br>`string \| number \| boolean \| undefined` |
1367
+ | `getValues` | 범위 전체의 값을 행 우선 2차원 배열로 반환한다. 바깥 배열이 행, 안쪽 배열이 열이며 배열 크기는 범위 크기와 같다.<br>각 값의 형태는 getValue 와 같다. | — | 빈 셀 자리는 undefined 로 채운다<br>`(string \| number \| boolean \| undefined)[][]` |
1368
+ | `getFormula` | 범위 좌상단 셀의 수식 문자열을 반환한다. 수식이 아닌 셀(상수·빈 셀)이면 undefined 다. | — | 문자열 (없을 수 있음) |
1369
+ | `getDisplayValue` | 범위 좌상단 셀의 화면 표시 문자열을 반환한다. 표시 형식이 적용된 결과라 저장된 값과 다를 수 있다. | — | 셀이 비어 있으면 빈 문자열<br>문자열 |
1370
+ | `getFormulas` | 범위 전체의 수식을 행 우선 2차원 배열로 반환한다. 배열 크기는 범위 크기와 같다. | — | 수식이 아닌 셀 자리는 null 이다<br>`(string \| null)[][]` |
1371
+ | `getDisplayValues` | 범위 전체의 화면 표시 문자열을 행 우선 2차원 배열로 반환한다. 배열 크기는 범위 크기와 같다. | — | 빈 셀 자리는 빈 문자열이다<br>`string[][]` |
1372
+ | `getCellContent` | 범위 좌상단 셀의 값·표시 문자열·수식을 한 번에 반환한다. 각 항목은 getValue·getDisplayValue·getFormula 와 같다. | — | [`CellContent`](#cell-cellcontent) |
1373
+ | `getCellContents` | 범위 전체의 값·표시 문자열·수식을 행 우선 2차원 배열로 반환한다. 배열 크기는 범위 크기와 같다. | — | `CellContent[][]` |
1374
+ | `getRowHeight` | 범위 첫 행의 높이(px)를 반환한다. | — | 숫자 |
1375
+ | `getColumnWidth` | 범위 첫 열의 너비(px)를 반환한다. | — | 숫자 |
1376
+ | `setRowHeight` | 범위에 걸친 행의 높이를 지정한다. 숨긴 행에 높이를 지정하면 숨김도 함께 풀린다.<br>0 이하를 주면 높이를 바꾸지 않고 행을 숨긴다.<br>지정한 행은 높이가 고정되어 내용이 바뀌어도 자동으로 맞춰지지 않는다. | `height` 숫자 — 행 높이(px) | — |
1377
+ | `setColumnWidth` | 범위에 걸친 열의 너비를 지정한다. 숨긴 열에 너비를 지정하면 숨김도 함께 풀린다.<br>0 이하를 주면 너비를 바꾸지 않고 열을 숨긴다.<br>지정한 열은 너비가 고정되어 내용이 바뀌어도 자동으로 넓어지지 않는다. | `width` 숫자 — 열 너비(px) | — |
1378
+ | `autofitRows` | 범위에 걸친 행의 높이를 각 행의 내용에 맞춰 조정한다. 조정한 행은 이후 내용이 바뀔 때도 높이가 자동으로 맞춰진다. | — | — |
1379
+ | `autofitColumns` | 범위에 걸친 열의 너비를 각 열의 내용에 맞춰 조정한다. 조정한 열은 이후 값을 넣거나 글꼴 크기·들여쓰기를 바꿀 때 숫자 셀의 내용에 맞춰 너비가 넓어질 수 있다. | — | — |
1380
+ | `insertRow` | 범위의 첫 행 자리에 행을 삽입한다. 앞 행의 서식을 따라간다. 시트의 첫 행 자리에 삽입하면 서식 없는 행이 들어간다. | `count` (선택) 숫자 (없을 수 있음) — 삽입할 행 수. 1 이상이 아니면 범위의 행 수만큼 삽입한다 | — |
1381
+ | `deleteRow` | 범위에 걸친 행을 삭제한다. 범위가 표의 데이터 영역을 통째로 덮으면 표가 사라지지 않도록 데이터 행 하나를 남긴다. | — | — |
1382
+ | `insertColumn` | 범위의 첫 열 자리에 열을 삽입한다. 앞 열의 서식을 따라간다. 시트의 첫 열 자리에 삽입하면 서식 없는 열이 들어간다. | `count` (선택) 숫자 (없을 수 있음) — 삽입할 열 수. 1 이상이 아니면 범위의 열 수만큼 삽입한다 | — |
1383
+ | `deleteColumn` | 범위에 걸친 열을 삭제한다.<br>시트의 모든 열이나 숨기지 않은 마지막 열까지 없어질 때, 틀 고정 오른쪽 영역이 통째로 없어질 때는 삭제할 수 없다. | — | — |
1384
+ | `setRowVisible` | 범위에 걸친 행을 표시하거나 숨긴다. visible 이 null 이거나 undefined 면 아무것도 하지 않는다. | `visible` 참/거짓 — true 면 표시, false 면 숨김 | — |
1385
+ | `setColumnVisible` | 범위에 걸친 열을 표시하거나 숨긴다. visible 이 null 이거나 undefined 면 아무것도 하지 않는다. | `visible` 참/거짓 — true 면 표시, false 면 숨김 | — |
1386
+ | `isRowVisible` | 범위 첫 행이 표시 상태인지 반환한다. | — | 참/거짓 (없을 수 있음) |
1387
+ | `isColumnVisible` | 범위 첫 열이 표시 상태인지 반환한다. | — | 참/거짓 (없을 수 있음) |
1388
+ | `setValue` | 범위의 모든 셀에 같은 값을 넣는다. 값은 문자열로 바꾼 뒤 해석하므로 "=" 로 시작하면 수식이 되고, "{=...}" 형태이면 범위 전체를 한 덩어리로 묶는 배열 수식이 된다.<br>범위가 기존 배열 수식 영역 안의 셀 하나이면 그 영역 전체를 다시 입력한다.<br>배열 수식은 병합 셀이나 표 영역에 넣을 수 없다.<br>null 은 빈 셀이 되고, 객체는 JSON 표기로 들어가며, Date 처럼 문자열 표기를 갖는 객체는 그 문자열이 들어간다.<br>배열은 원소를 각각 같은 규칙으로 바꿔 콤마로 이어 넣는다. | `value` `string \| number \| boolean \| null \| Date \| Record<string, unknown> \| any[]` — 넣을 값. 자기 자신을 품은 배열·객체처럼 문자열 표기를 얻을 수 없는 값은 넣을 수 없다 | — |
1389
+ | `setValues` | 범위의 셀마다 다른 값을 넣는다. 바깥 배열 인덱스가 범위 안의 행, 안쪽 배열 인덱스가 범위 안의 열에 대응하며 크기가 범위와 정확히 같아야 한다.<br>각 값의 해석은 setValue 와 같지만 배열 수식은 넣을 수 없다.<br>null 과 undefined 는 빈 셀이 된다.<br>전체 행·열 범위에는 쓸 수 없다. | `values` `(string \| number \| boolean \| null \| undefined \| Date \| Record<string, unknown> \| any[])[][]` — 범위 크기와 같은 행 우선 2차원 배열 | — |
1390
+ | `deleteValue` | 범위 안 모든 셀의 값과 수식을 지운다. 서식은 그대로 남는다. | — | — |
1391
+ | `setFontBold` | 범위에 굵게를 적용하거나 해제한다. | `isOn` 참/거짓 — true 면 적용, false 면 해제 | — |
1392
+ | `setFontItalic` | 범위에 기울임을 적용하거나 해제한다. | `isOn` 참/거짓 — true 면 적용, false 면 해제 | — |
1393
+ | `setFontUnderline` | 범위에 밑줄을 적용하거나 해제한다. | `isOn` 참/거짓 — true 면 적용, false 면 해제. false 면 isDouble 은 무시된다<br>`isDouble` (선택) 참/거짓 — true 면 이중 밑줄, false 면 실선 밑줄 (기본값: false) | — |
1394
+ | `setFontStrikethrough` | 범위에 취소선을 적용하거나 해제한다. | `isOn` 참/거짓 — true 면 적용, false 면 해제 | — |
1395
+ | `isFontBold` | 범위 좌상단 셀이 굵게인지 반환한다. | — | 굵게가 아니면 undefined 다<br>참/거짓 (없을 수 있음) |
1396
+ | `isFontItalic` | 범위 좌상단 셀이 기울임인지 반환한다. | — | 기울임이 아니면 undefined 다<br>참/거짓 (없을 수 있음) |
1397
+ | `getFontUnderline` | 범위 좌상단 셀의 밑줄 종류를 반환한다. | — | 밑줄이 없으면 undefined 다<br>`"single" \| "double" \| undefined` |
1398
+ | `isFontStrikethrough` | 범위 좌상단 셀에 취소선이 있는지 반환한다. | — | 취소선이 없으면 undefined 다<br>참/거짓 (없을 수 있음) |
1399
+ | `setFontName` | 범위의 글꼴을 바꾼다. | `name` 문자열 — 글꼴 이름 | — |
1400
+ | `setFontSize` | 범위의 글꼴 크기를 바꾼다. | `size` `number \| string` — 글꼴 크기(pt) | — |
1401
+ | `setFontColor` | 범위의 글꼴 색을 바꾼다. | `color` 문자열 — "#RRGGBB" 형식의 색 | — |
1402
+ | `getFontName` | 범위 좌상단 셀의 글꼴 이름을 반환한다. 글꼴을 따로 지정하지 않은 셀에는 문서 기본 글꼴 이름이 담긴다. | — | 문자열 (없을 수 있음) |
1403
+ | `getFontSize` | 범위 좌상단 셀의 글꼴 크기(pt)를 반환한다. 크기를 따로 지정하지 않은 셀에는 문서 기본 크기가 담긴다. | — | 숫자 (없을 수 있음) |
1404
+ | `getFontColor` | 범위 좌상단 셀의 글꼴 색을 반환한다. 색을 따로 지정하지 않은 셀에는 문서 기본 색이 담긴다. | — | "#RRGGBB" 형식의 색<br>문자열 (없을 수 있음) |
1405
+ | `getFont` | 범위 좌상단 셀의 글꼴 서식을 한 번에 반환한다. 각 항목은 같은 이름의 개별 조회 메서드와 같되, underline 만 밑줄이 없을 때 undefined 가 아니라 "none" 이다. | — | 셀에 서식 정보가 없으면 undefined 다<br>[`FontInfo`](#cell-fontinfo) (없을 수 있음) |
1406
+ | `setBackgroundColor` | 범위를 단색 바탕색으로 채운다. 색을 주지 않으면 채우기를 지운다. | `color` (선택) 문자열 (없을 수 있음) — "#RRGGBB" 형식의 색. null·undefined·빈 문자열이면 채우기를 지운다 | — |
1407
+ | `setHorizontalAlign` | 범위의 가로 정렬을 지정한다. 지정과 함께 범위의 들여쓰기가 0 으로 초기화된다.<br>HorizontalAlign 밖의 값도 검증 없이 저장되며, "centerContinuous" 와 "center-across" 는 가운데로, 그 밖의 값은 왼쪽으로 그려진다. | `value` [`HorizontalAlign`](#cell-horizontalalign) — 가로 정렬 | — |
1408
+ | `setVerticalAlign` | 범위의 세로 정렬을 지정한다. VerticalAlign 밖의 값도 검증 없이 저장되며, "distributed" 는 가운데로, 그 밖의 값은 아래로 그려진다. | `value` [`VerticalAlign`](#cell-verticalalign) — 세로 정렬 | — |
1409
+ | `setWrapText` | 범위에 텍스트 줄바꿈을 적용하거나 해제한다. | `isOn` 참/거짓 — true 면 적용, false 면 해제 | — |
1410
+ | `getBackgroundColor` | 범위 좌상단 셀의 바탕색을 반환한다. 채우기가 없을 때는 물론 그라디언트 채우기일 때도 색 하나로 표현할 수 없어 undefined 다. 채우기 종류까지 알아야 하면 getFill 을 쓴다. | — | "#RRGGBB" 형식의 색<br>문자열 (없을 수 있음) |
1411
+ | `getHorizontalAlign` | 범위 좌상단 셀의 가로 정렬을 반환한다. 명시 지정된 값만 반환하며, HorizontalAlign 밖의 값이 반환될 수 있다. | — | 지정이 없으면 undefined 다<br>문자열 (없을 수 있음) |
1412
+ | `getVerticalAlign` | 범위 좌상단 셀의 세로 정렬을 반환한다. 명시 지정된 값만 반환하며, VerticalAlign 밖의 값이 반환될 수 있다.<br>지정이 없는 셀은 아래쪽으로 그려진다. | — | 지정이 없으면 undefined 다<br>문자열 (없을 수 있음) |
1413
+ | `isWrapText` | 범위 좌상단 셀에 텍스트 줄바꿈이 적용되어 있는지 반환한다. | — | 줄바꿈이 적용되어 있지 않으면 undefined 다<br>참/거짓 (없을 수 있음) |
1414
+ | `getFill` | 범위 좌상단 셀의 채우기를 반환한다. 그라디언트 채우기는 종류만 담기고 색·방향 등 나머지는 담기지 않는다. | — | 채우기가 없으면 undefined 다<br>[`FillInfo`](#cell-fillinfo) (없을 수 있음) |
1415
+ | `getAlignment` | 범위 좌상단 셀의 정렬 서식을 한 번에 반환한다. 각 항목은 같은 이름의 개별 조회 메서드와 같다. | — | 셀에 서식 정보가 없으면 undefined 다<br>[`AlignmentInfo`](#cell-alignmentinfo) (없을 수 있음) |
1416
+ | `increaseIndent` | 범위의 들여쓰기 수준을 1 올린다. 범위의 가로 정렬이 왼쪽이나 오른쪽 하나로 통일되어 있지 않으면 먼저 범위 전체를 왼쪽 정렬로 바꾼 뒤 올린다. | — | — |
1417
+ | `decreaseIndent` | 범위의 들여쓰기 수준을 1 내린다. 0 보다 아래로는 내려가지 않는다. | — | — |
1418
+ | `getIndent` | 범위 좌상단 셀의 들여쓰기 수준을 반환한다. | — | 들여쓰기가 지정되어 있지 않으면 0 이다<br>숫자 |
1419
+ | `setBorder` | 범위에 테두리를 적용하거나 지운다. type 이 "none" 이면 범위의 테두리를 모두 지우고, 그 밖의 type 은 기존 테두리에 type 이 가리키는 테두리를 병합한다.<br>lineStyle 이 "none" 이면 type 이 가리키는 자리의 선만 지우며 color 는 무시된다.<br>그릴 내부 선이 없으면 "center"·"middle"·"cross" 는 아무것도 하지 않는다. | `type` [`BorderType`](#cell-bordertype) — 테두리를 그릴 자리<br>`lineStyle` (선택) [`BorderLineStyle`](#cell-borderlinestyle) (없을 수 있음) — 선 스타일 (기본값: "thin")<br>`color` (선택) 문자열 (없을 수 있음) — "#RRGGBB" 형식의 선 색 (기본값: "#000000") | — |
1420
+ | `getBorder` | 범위 좌상단 셀의 테두리를 네 변과 대각선으로 나눠 반환한다. 실제로 그려진 선만 담긴다. | — | 셀에 서식 정보가 없으면 undefined 다<br>[`BorderInfo`](#cell-borderinfo) (없을 수 있음) |
1421
+ | `clearFormat` | 범위의 셀 서식(글꼴·채우기·정렬·테두리·표시 형식)을 지우고 범위 안의 병합을 해제한다. 값과 수식은 남는다.<br>행 전체·열 전체 범위가 병합과 겹치면 오류가 난다. | — | — |
1422
+ | `clearAll` | 범위의 모든 내용을 지운다. 값·수식·서식·병합·하이퍼링크·메모·데이터 유효성·스파크라인·필터·표가 대상이다.<br>행 전체·열 전체 범위가 병합과 겹치면 오류가 난다. | — | — |
1423
+ | `merge` | 범위의 셀을 하나로 병합한다. 병합한 셀에는 좌상단 셀의 값만 남고 나머지 값은 사라진다.<br>범위가 셀 하나이거나 표와 겹치면 아무것도 하지 않는다.<br>병합이 범위 밖까지 걸쳐 있으면 오류가 난다. | — | — |
1424
+ | `unmerge` | 범위와 겹치는 병합을 모두 해제한다. | — | — |
1425
+ | `getMergeCellList` | 범위와 겹치는 병합 영역의 주소를 A1 문자열 배열로 반환한다. 일부만 겹치는 병합도 범위에 맞춰 잘라내지 않고 병합 영역 전체 주소를 준다. 시트 전체의 병합 목록은 Worksheet.getMergeCellList 로 조회한다. | — | 문자열 목록 |
1426
+ | `setNumberFormat` | 범위의 표시 형식을 형식 코드로 지정한다. 넘긴 코드는 사용자 정의 형식으로 저장된다. | `formatCode` 문자열 — 엑셀 호환 형식 코드 ("#,##0.00", "yyyy-mm-dd", "0.00%" 등) | — |
1427
+ | `getNumberFormat` | 범위 좌상단 셀의 표시 형식을 반환한다. 형식을 따로 지정하지 않은 셀에도 문서 기본 형식의 코드가 담긴다. | — | formatCode 는 setNumberFormat 에 그대로 넘길 수 있는 형식 코드다<br>`{ formatCode: string }` |
1428
+ | `addConditionalFormat` | 범위에 조건부 서식 규칙을 추가한다. 추가한 규칙이 기존 규칙보다 먼저 적용된다.<br>규칙 내용이 잘못되었다면 동작하지 않는다. | `rule` [`ConditionalFormatRule`](#cell-conditionalformatrule) — 추가할 규칙 | — |
1429
+ | `clearConditionalFormats` | 범위와 겹치는 조건부 서식 규칙을 지운다. 규칙이 범위 밖까지 걸쳐 있으면 겹치는 부분만 규칙의 적용 범위에서 빼고, 규칙 전체가 범위 안에 들면 규칙 자체를 지운다. | — | — |
1430
+ | `setDataValidation` | 범위에 데이터 유효성 검사 규칙을 적용한다. 셀 하나에는 규칙 하나만 걸리므로, 겹치는 기존 규칙은 겹치는 만큼 적용 범위에서 물러나고 이 규칙으로 바뀐다.<br>규칙 내용이 잘못되었다면 동작하지 않는다. | `rule` 객체 — 규칙 객체. type 은 DataValidationType, operator 는 DataValidationOperator, errorStyle 은 DataValidationErrorStyle 어휘를 쓰며, 타입에 따라 formula 와 안내·오류 메시지를 함께 담는다 | — |
1431
+ | `clearDataValidation` | 범위와 겹치는 데이터 유효성 검사 규칙을 지운다. 규칙이 범위 밖까지 걸쳐 있으면 겹치는 부분만 적용 범위에서 뺀다. | — | — |
1432
+ | `sort` | 범위를 지정한 열의 값 기준으로 정렬한다. 범위가 필터나 표 영역 안의 셀 하나이면 그 필터의 정렬로 처리되어 정렬 상태가 문서에 남는다. 머리글 행은 자동으로 가려낸다.<br>정렬할 값이 없거나 범위 안 병합의 크기가 제각각이면 정렬할 수 없다. | `key` 숫자 — 정렬 기준 열. 범위의 첫 열을 0 으로 세는 0-based 오프셋이며 범위 너비를 벗어날 수 없다<br>`order` [`SortOrder`](#cell-sortorder) — 정렬 방향. SortOrder 의 오름차순·내림차순 두 값만 받는다<br>`options` (선택) 객체 — 아직 지원하지 않는 예약 인자. 값이 담긴 객체를 주면 정렬하지 않는다 | — |
1433
+ | `setComment` | 범위 좌상단 셀에 메모를 넣는다. 메모가 이미 있으면 본문만 바꾸고 표시 상태와 위치는 그대로 둔다. | `text` 문자열 — 메모 본문. 서식 없는 텍스트이며 줄바꿈은 "\n" 이다 | — |
1434
+ | `deleteComment` | 범위 안의 메모를 모두 지운다. | — | — |
1435
+ | `setCommentVisible` | 범위 좌상단 셀 메모의 표시 상태를 바꾼다. 메모가 없다면 동작하지 않는다. | `visible` 참/거짓 — true 면 항상 표시, false 면 마우스를 올렸을 때만 표시 | — |
1436
+ | `getHyperlinkList` | 범위와 겹치는 하이퍼링크 목록을 반환한다. 일부만 겹치는 링크도 포함한다. | — | [`HyperlinkInfo`](#cell-hyperlinkinfo) 목록 |
1437
+ | `setHyperlink` | 범위에 하이퍼링크를 넣는다. 링크와 링크 서식(파란색 밑줄)은 범위 전체에 들어가지만 표시 텍스트는 좌상단 셀에만 들어간다. | `options` [`HyperlinkOptions`](#cell-hyperlinkoptions) | — |
1438
+ | `removeHyperlink` | 범위와 포함 관계인 하이퍼링크를 지운다. 범위가 링크를 품거나 링크가 범위를 품는 경우이며, 일부만 겹치는 링크는 남는다.<br>셀 값은 그대로 두고 링크 서식(파란색 밑줄)만 함께 지우며, 지운 링크와 겹쳐 있던 다른 링크의 서식은 되살린다. | — | — |
1439
+
1440
+ <a id="cell-table"></a>
1441
+ ### Table — 표 (`Table`)
1442
+
1443
+ 워크시트에 놓인 표 하나를 다루는 핸들이다.
1444
+ 표의 영역과 표시 옵션, 표에 딸린 자동 필터를 다룬다.
1445
+ 문서를 공동 편집하는 중에는 표를 바꿀 수 없다.
1446
+
1447
+ | 기능 | 설명 | 입력 | 결과 |
1448
+ |---|---|---|---|
1449
+ | `getName` | 지정된 표 이름을 반환한다. | — | 문자열 |
1450
+ | `getRange` | 머리글 행과 요약 행을 포함한 표 전체 영역의 Range 핸들을 반환한다.<br>반환한 Range 는 호출 시점의 좌표를 담고 있어, 이후 표 영역이 바뀌어도 따라가지 않는다. | — | [`Range`](#cell-range) |
1451
+ | `getOptions` | 표의 표시 옵션을 한 번에 반환한다. | — | [`TableOptions`](#cell-tableoptions) |
1452
+ | `delete` | 표를 삭제한다. 표 정의와 표에 딸린 자동 필터를 없애고 표 영역의 셀 내용까지 지운다. | — | — |
1453
+ | `resize` | 표 영역을 새 범위로 변경한다.<br>새 영역은 머리글 행 위치를 그대로 두면서 현재 표 영역과 겹쳐야 하고 두 셀 이상이어야 하며, 전체 행이나 전체 열은 지정할 수 없다.<br>현재 영역과 같은 영역을 넘기면 아무것도 바꾸지 않는다. | `range` `string \| RangeCoords` — 새 표 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10") | — |
1454
+ | `setOptions` | 표의 표시 옵션을 변경한다. 지정한 옵션만 적용하고 나머지는 현재 값을 그대로 둔다.<br>머리글 행이나 요약 행을 켤 때 표 바로 바깥의 인접한 행이 비어 있지 않으면 시트에 행을 새로 삽입해 아래 내용을 밀어내고, 끌 때는 그 행의 셀 값을 지운다.<br>머리글 행을 켜면 표의 자동 필터가 함께 만들어지고, 끄면 제거된다.<br>표 스타일은 이 메서드로 바꿀 수 없다. | `options` [`TableOptionUpdate`](#cell-tableoptionupdate) — 바꿀 옵션 | — |
1455
+ | `setHeaderRow` | 머리글 행 표시 여부를 변경한다.<br>켤 때 표 바로 바깥의 인접한 행이 비어 있지 않으면 시트에 행을 새로 삽입해 아래 내용을 밀어내고, 끌 때는 그 행의 셀 값을 지운다.<br>머리글 행을 켜면 표의 자동 필터가 함께 만들어지고, 끄면 제거된다. | `isOn` 참/거짓 | — |
1456
+ | `setTotalsRow` | 요약 행 표시 여부를 변경한다.<br>켤 때 표 바로 바깥의 인접한 행이 비어 있지 않으면 시트에 행을 새로 삽입해 아래 내용을 밀어내고, 끌 때는 그 행의 셀 값을 지운다. | `isOn` 참/거짓 | — |
1457
+ | `setFirstColumn` | 첫 열 강조 여부를 변경한다. | `isOn` 참/거짓 | — |
1458
+ | `setLastColumn` | 마지막 열 강조 여부를 변경한다. | `isOn` 참/거짓 | — |
1459
+ | `setBandedRows` | 행 줄무늬 표시 여부를 변경한다. | `isOn` 참/거짓 | — |
1460
+ | `setBandedColumns` | 열 줄무늬 표시 여부를 변경한다. | `isOn` 참/거짓 | — |
1461
+ | `setName` | 표 이름을 변경한다. 표 이름을 참조하는 수식은 새 이름으로 함께 갱신된다.<br>이 핸들은 새 이름을 가리키므로 계속 쓸 수 있지만, 같은 표를 가리키던 다른 핸들과 이 표에서 미리 받아 둔 Filter 핸들은 더 이상 쓸 수 없다.<br>다른 표가 같은 이름을 쓰고 있으면 변경할 수 없으며, 이때 대소문자는 구분하지 않는다. | `name` 문자열 — 새 표 이름. 공백이나 허용되지 않는 문자를 쓸 수 없고, 셀 참조로 읽히는 이름이나 최대 길이를 넘는 이름도 받지 않는다 | — |
1462
+ | `getFilter` | 이 표의 자동 필터 핸들을 반환한다.<br>표의 필터링은 표 구조에 내재하므로 아직 필터가 만들어지지 않았어도 핸들을 반환하며, 필터가 있는지는 Filter 의 getInfo() 로 확인한다. | — | [`Filter`](#cell-filter) |
1463
+ | `getInfo` | 표의 이름·위치·영역과 표시 옵션을 한 번에 반환한다. | — | [`TableInfo`](#cell-tableinfo) |
1464
+
1465
+ ### 부록 — 입출력 데이터 형식 (Spreadsheet)
1466
+
1467
+ <a id="cell-rangecoords"></a>
1468
+ #### `RangeCoords`
1469
+
1470
+ | 항목 | 형식 | 설명 |
1471
+ |---|---|---|
1472
+ | `row1` | 숫자 | 영역이 시작하는 행(0-based) |
1473
+ | `col1` | 숫자 | 영역이 시작하는 열(0-based) |
1474
+ | `row2` (선택) | 숫자 | 영역이 끝나는 행(0-based). col2 와 함께 생략하면 row1·col1 이 가리키는 단일 셀이 된다 |
1475
+ | `col2` (선택) | 숫자 | 영역이 끝나는 열(0-based). row2 와 함께 생략하면 row1·col1 이 가리키는 단일 셀이 된다 |
1476
+
1477
+ <a id="cell-sheetrangecoords"></a>
1478
+ #### `SheetRangeCoords`
1479
+
1480
+ | 항목 | 형식 | 설명 |
1481
+ |---|---|---|
1482
+ | `sheetIndex` | 숫자 | — |
1483
+ | `row1` | 숫자 | — |
1484
+ | `col1` | 숫자 | — |
1485
+ | `row2` | 숫자 | — |
1486
+ | `col2` | 숫자 | — |
1487
+
1488
+ <a id="cell-commandresult"></a>
1489
+ #### `CommandResult`
1490
+
1491
+ | 항목 | 형식 | 설명 |
1492
+ |---|---|---|
1493
+ | `undoable` | 참/거짓 | 이번 실행을 되돌릴 수 있는지 여부 |
1494
+ | `undoBufferCleared` | 참/거짓 | 되돌리기 기록이 모두 지워졌는지 여부 |
1495
+
1496
+ <a id="cell-sheetsummary"></a>
1497
+ #### `SheetSummary`
1498
+
1499
+ | 항목 | 형식 | 설명 |
1500
+ |---|---|---|
1501
+ | `name` | 문자열 | — |
1502
+ | `active` | 참/거짓 | 활성 시트 여부 |
1503
+
1504
+ <a id="cell-sheetref"></a>
1505
+ #### `SheetRef`
1506
+
1507
+ | 항목 | 형식 | 설명 |
1508
+ |---|---|---|
1509
+ | `sheetIndex` | 숫자 | 0-based 시트 인덱스 |
1510
+ | `sheetName` | 문자열 | — |
1511
+
1512
+ <a id="cell-documentproperties"></a>
1513
+ #### `DocumentProperties`
1514
+
1515
+ | 항목 | 형식 | 설명 |
1516
+ |---|---|---|
1517
+ | `application` | 문자열 (없을 수 있음) | 문서를 만든 애플리케이션 이름 ("Cell" 등) |
1518
+ | `creator` | 문자열 (없을 수 있음) | 문서 작성자 |
1519
+ | `created` | `string \| number \| undefined` | 문서 생성 일시. 날짜 문자열이거나 epoch 밀리초다 |
1520
+ | `lastModified` | `string \| number \| undefined` | 마지막 저장 일시. created 와 같은 형식 |
1521
+ | `fileType` | 문자열 | 문서 포맷 ("xlsx", "ods", "xls") |
1522
+ | `locale` | 문자열 | 문서 로캘 ("ko_KR") |
1523
+
1524
+ <a id="cell-freezepanes"></a>
1525
+ #### `FreezePanes`
1526
+
1527
+ | 항목 | 형식 | 설명 |
1528
+ |---|---|---|
1529
+ | `rows` | 숫자 | 고정된 상단 행 수. 고정하지 않았으면 0 이다 |
1530
+ | `cols` | 숫자 | 고정된 좌측 열 수. 고정하지 않았으면 0 이다 |
1531
+
1532
+ <a id="cell-sheetinfo"></a>
1533
+ #### `SheetInfo`
1534
+
1535
+ | 항목 | 형식 | 설명 |
1536
+ |---|---|---|
1537
+ | `name` | 문자열 | 시트 이름 |
1538
+ | `hidden` | 참/거짓 | 숨김 여부 |
1539
+ | `tabColor` | 문자열 | 탭 색("#RRGGBB"). 색을 지정하지 않았으면 빈 문자열 |
1540
+ | `usedRange` | 문자열 (없을 수 있음) | 값이나 셀 서식이 있는 범위(A1 표기). 값도 셀 서식도 없는 시트에서는 null |
1541
+ | `selection` | 문자열 | 선택 영역(A1 표기) |
1542
+ | `freezePanes` | [`FreezePanes`](#cell-freezepanes) | 틀 고정 상태 |
1543
+ | `gridlinesVisible` | 참/거짓 | 눈금선 표시 여부 |
1544
+ | `zoom` | 숫자 | 화면 확대 배율(1 이 100%) |
1545
+
1546
+ <a id="cell-selectioninfo"></a>
1547
+ #### `SelectionInfo`
1548
+
1549
+ | 항목 | 형식 | 설명 |
1550
+ |---|---|---|
1551
+ | `sheet` | 문자열 | 시트 이름 |
1552
+ | `selection` | 문자열 | A1 표기 문자열 |
1553
+
1554
+ <a id="cell-addchartoptions"></a>
1555
+ #### `AddChartOptions`
1556
+
1557
+ | 항목 | 형식 | 설명 |
1558
+ |---|---|---|
1559
+ | `seriesBy` (선택) | `"auto" \| "rows" \| "columns"` | 시리즈 방향. rows 는 행 하나가 시리즈 하나, columns 는 열 하나가 시리즈 하나이며, 생략하면 데이터 모양에 따라 정한다. 분산형·거품형은 방향을 지정할 수 없다 |
1560
+
1561
+ <a id="cell-chartinfo"></a>
1562
+ #### `ChartInfo`
1563
+
1564
+ | 항목 | 형식 | 설명 |
1565
+ |---|---|---|
1566
+ | `oid` | 문자열 | 차트를 식별하는 고유 ID |
1567
+ | `type` | [`ChartType`](#common-charttype) | 차트 종류 |
1568
+ | `title` | 문자열 | 차트 제목 |
1569
+ | `legendPosition` | [`ChartLegendPosition`](#common-chartlegendposition) | 범례 위치 |
1570
+ | `dataLabelPosition` | [`ChartDataLabelPosition`](#common-chartdatalabelposition) | 데이터레이블 위치 |
1571
+ | `axisTitle` | `{ horizontal: string \| null; vertical: string \| null }` | 축별 축 제목. null 은 그 차트 종류에 해당 축의 제목이 아예 없다는 뜻이다 |
1572
+ | `gridLine` | `{ horizontal: ChartGridLineType \| null; vertical: ChartGridLineType \| null }` | 축별 눈금선. null 은 그 차트 종류에 해당 축의 눈금선이 아예 없다는 뜻이고, "none" 은 쓸 수는 있지만 꺼져 있다는 뜻이다 |
1573
+ | `range` | 문자열 (없을 수 있음) | 데이터 범위. 시트명을 포함한 A1 표기다("Sheet1!A1:C5"). 하나의 사각 범위로 묶이지 않으면 null |
1574
+
1575
+ <a id="cell-conditionalformatprioritymove"></a>
1576
+ #### `ConditionalFormatPriorityMove`
1577
+
1578
+ | 항목 | 형식 | 설명 |
1579
+ |---|---|---|
1580
+ | `priority` | 숫자 | 옮길 규칙의 현재 우선순위 |
1581
+ | `to` | 숫자 | 옮겨 놓을 우선순위 |
1582
+
1583
+ <a id="cell-conditionalformatrangeset"></a>
1584
+ #### `ConditionalFormatRangeSet`
1585
+
1586
+ | 항목 | 형식 | 설명 |
1587
+ |---|---|---|
1588
+ | `priority` | 숫자 | 대상 규칙의 현재 우선순위 |
1589
+ | `ranges` | `string \| RangeCoords[]` | 바꿀 적용 영역. 콤마로 이어 붙인 A1 표기 문자열("A1:B2,D4:E5")로도 지정할 수 있으며, 문자열 배열과 빈 배열은 받지 않는다 |
1590
+
1591
+ <a id="cell-conditionalformatupdate"></a>
1592
+ #### `ConditionalFormatUpdate`
1593
+
1594
+ | 항목 | 형식 | 설명 |
1595
+ |---|---|---|
1596
+ | `deletes` (선택) | 숫자 목록 | 삭제할 규칙의 우선순위 목록 |
1597
+ | `setRanges` (선택) | [`ConditionalFormatRangeSet`](#cell-conditionalformatrangeset) 목록 | 규칙별로 바꿀 적용 영역 |
1598
+ | `movePriority` (선택) | [`ConditionalFormatPriorityMove`](#cell-conditionalformatprioritymove) | 우선순위 이동. 한 번에 한 건만 지정할 수 있다 |
1599
+
1600
+ <a id="cell-conditionalformatfont"></a>
1601
+ #### `ConditionalFormatFont`
1602
+
1603
+ | 항목 | 형식 | 설명 |
1604
+ |---|---|---|
1605
+ | `bold` (선택) | 참/거짓 | 굵게 여부 |
1606
+ | `italic` (선택) | 참/거짓 | 기울임 여부 |
1607
+ | `strikethrough` (선택) | 참/거짓 | 취소선 여부 |
1608
+ | `underline` (선택) | `"single" \| "double" \| "singleAccounting" \| "doubleAccounting" \| "none"` | 밑줄 종류 |
1609
+ | `color` (선택) | 문자열 | 글꼴 색 "#RRGGBB" |
1610
+ | `size` (선택) | 숫자 | 글꼴 크기(pt). 현재는 조회만 지원한다 |
1611
+ | `name` (선택) | 문자열 | 글꼴 이름. 현재는 조회만 지원한다 |
1612
+
1613
+ <a id="cell-conditionalformatgradientstop"></a>
1614
+ #### `ConditionalFormatGradientStop`
1615
+
1616
+ | 항목 | 형식 | 설명 |
1617
+ |---|---|---|
1618
+ | `position` | 숫자 | 0~1 사이의 위치 |
1619
+ | `color` | 문자열 | 그 위치의 색 "#RRGGBB" |
1620
+
1621
+ <a id="cell-conditionalformatgradient"></a>
1622
+ #### `ConditionalFormatGradient`
1623
+
1624
+ | 항목 | 형식 | 설명 |
1625
+ |---|---|---|
1626
+ | `isLinear` (선택) | 참/거짓 | 선형이면 true, 방사형이면 false |
1627
+ | `degree` (선택) | 숫자 | 선형일 때의 각도 |
1628
+ | `left` (선택) | 숫자 | 방사형의 왼쪽 여백 비율 |
1629
+ | `right` (선택) | 숫자 | 방사형의 오른쪽 여백 비율 |
1630
+ | `top` (선택) | 숫자 | 방사형의 위쪽 여백 비율 |
1631
+ | `bottom` (선택) | 숫자 | 방사형의 아래쪽 여백 비율 |
1632
+ | `stops` (선택) | [`ConditionalFormatGradientStop`](#cell-conditionalformatgradientstop) 목록 | 색이 바뀌는 지점 목록 |
1633
+
1634
+ <a id="cell-conditionalformatfill"></a>
1635
+ #### `ConditionalFormatFill`
1636
+
1637
+ | 항목 | 형식 | 설명 |
1638
+ |---|---|---|
1639
+ | `backgroundColor` (선택) | 문자열 | 바탕색 "#RRGGBB". 이것만 주면 단색 채우기다 |
1640
+ | `patternType` (선택) | 문자열 | 무늬 종류("lightGrid", "darkVertical" 등). solid·none 은 무늬가 아니다 |
1641
+ | `patternColor` (선택) | 문자열 | 무늬색 "#RRGGBB". 무늬가 아닌 채우기에는 없다 |
1642
+ | `gradient` (선택) | [`ConditionalFormatGradient`](#cell-conditionalformatgradient) | 그라데이션 채우기. 현재는 조회만 지원한다 |
1643
+
1644
+ <a id="cell-conditionalformatborderline"></a>
1645
+ #### `ConditionalFormatBorderLine`
1646
+
1647
+ | 항목 | 형식 | 설명 |
1648
+ |---|---|---|
1649
+ | `style` (선택) | [`BorderLineStyle`](#cell-borderlinestyle) | 선 스타일. 색만 주면 가는 실선으로 그린다 |
1650
+ | `color` (선택) | 문자열 | 선 색 "#RRGGBB". 선 스타일만 주면 검정으로 그린다 |
1651
+
1652
+ <a id="cell-conditionalformatborder"></a>
1653
+ #### `ConditionalFormatBorder`
1654
+
1655
+ | 항목 | 형식 | 설명 |
1656
+ |---|---|---|
1657
+ | `style` (선택) | [`BorderLineStyle`](#cell-borderlinestyle) | 네 변에 함께 줄 선 스타일. 변별 지정이 있으면 그쪽이 이긴다 |
1658
+ | `color` (선택) | 문자열 | 네 변에 함께 줄 선 색 "#RRGGBB". 변별 지정이 있으면 그쪽이 이긴다 |
1659
+ | `top` (선택) | [`ConditionalFormatBorderLine`](#cell-conditionalformatborderline) | 위쪽 변. 조회는 네 변이 같아도 각 변을 따로 준다 |
1660
+ | `bottom` (선택) | [`ConditionalFormatBorderLine`](#cell-conditionalformatborderline) | 아래쪽 변 |
1661
+ | `left` (선택) | [`ConditionalFormatBorderLine`](#cell-conditionalformatborderline) | 왼쪽 변 |
1662
+ | `right` (선택) | [`ConditionalFormatBorderLine`](#cell-conditionalformatborderline) | 오른쪽 변 |
1663
+
1664
+ <a id="cell-conditionalformatstyle"></a>
1665
+ #### `ConditionalFormatStyle`
1666
+
1667
+ | 항목 | 형식 | 설명 |
1668
+ |---|---|---|
1669
+ | `font` (선택) | [`ConditionalFormatFont`](#cell-conditionalformatfont) | 글꼴 |
1670
+ | `fill` (선택) | [`ConditionalFormatFill`](#cell-conditionalformatfill) | 채우기 |
1671
+ | `border` (선택) | [`ConditionalFormatBorder`](#cell-conditionalformatborder) | 테두리 |
1672
+ | `numberFormat` (선택) | 문자열 | 숫자 서식 코드. 현재는 조회만 지원한다 |
1673
+
1674
+ <a id="cell-conditionalformatvalue"></a>
1675
+ #### `ConditionalFormatValue`
1676
+
1677
+ | 항목 | 형식 | 설명 |
1678
+ |---|---|---|
1679
+ | `type` | [`ConditionalFormatValueType`](#cell-conditionalformatvaluetype) | 시각 규칙이 값 범위를 나누는 기준점 종류. min·max·autoMin·autoMax 는 데이터에서 잡으므로 formula 를 쓰지 않는다 |
1680
+ | `formula` (선택) | `string \| number` | num·percent·percentile 의 값, formula 의 수식 |
1681
+
1682
+ <a id="cell-conditionalformatrule"></a>
1683
+ #### `ConditionalFormatRule`
1684
+
1685
+ | 항목 | 형식 | 설명 |
1686
+ |---|---|---|
1687
+ | `type` | [`ConditionalFormatRuleType`](#cell-conditionalformatruletype) | 규칙 종류. 나머지 필드 가운데 무엇을 함께 쓰는지 이 값이 정한다 |
1688
+ | `operator` (선택) | [`ConditionalFormatOperator`](#cell-conditionalformatoperator) | cellIs 가 값을 견주는 방식 |
1689
+ | `formula1` (선택) | `string \| number` | cellIs 의 비교값, expression 의 참·거짓 수식 |
1690
+ | `formula2` (선택) | `string \| number` | cellIs 가 between·notBetween 일 때 쓰는 두 번째 경계값 |
1691
+ | `text` (선택) | 문자열 | containsText·notContainsText·beginsWith·endsWith 가 찾을 문자열 |
1692
+ | `timePeriod` (선택) | [`ConditionalFormatTimePeriod`](#cell-conditionalformattimeperiod) | timePeriod 가 볼 기간 |
1693
+ | `rank` (선택) | 숫자 | top10 이 고를 개수. percent 가 참이면 1~100, 아니면 1~1000 |
1694
+ | `percent` (선택) | 참/거짓 | top10 의 rank 를 개수가 아니라 백분율로 읽는다 |
1695
+ | `bottom` (선택) | 참/거짓 | top10 을 위에서가 아니라 아래에서 고른다 |
1696
+ | `colors` (선택) | 문자열 목록 | colorScale 의 눈금 색 "#RRGGBB" 2~3개. dataBar 에서는 현재 조회만 지원한다 |
1697
+ | `cfvo` (선택) | [`ConditionalFormatValue`](#cell-conditionalformatvalue) 목록 | colorScale·iconSet 의 기준점. 생략하면 데이터 범위를 고르게 나눈다. dataBar 에서는 현재 조회만 지원한다 |
1698
+ | `gradient` (선택) | 참/거짓 | dataBar 막대를 단색이 아니라 그라데이션으로 그린다. 현재는 조회만 지원한다 |
1699
+ | `dataBar` (선택) | 문자열 | dataBar 가 쓸 막대 프리셋. 막대는 이 프리셋으로만 만들 수 있다. 조회는 막대 모양이 프리셋과 같을 때 이 이름을 준다 |
1700
+ | `iconSet` (선택) | 문자열 | iconSet 이 쓸 아이콘 묶음 |
1701
+ | `reverse` (선택) | 참/거짓 | iconSet 의 아이콘을 반대 순서로 매긴다 |
1702
+ | `style` (선택) | [`ConditionalFormatStyle`](#cell-conditionalformatstyle) | 조건이 맞은 셀에 입힐 강조 서식. 생략하면 기본 강조를 쓰며, 시각 규칙에는 지정할 수 없다 |
1703
+
1704
+ <a id="cell-conditionalformatinfo"></a>
1705
+ #### `ConditionalFormatInfo`
1706
+
1707
+ | 항목 | 형식 | 설명 |
1708
+ |---|---|---|
1709
+ | `priority` | 숫자 | 우선순위 |
1710
+ | `stopIfTrue` | 참/거짓 | 조건이 맞으면 뒤 규칙을 적용하지 않을지 여부 |
1711
+ | `ranges` | 문자열 | 적용 영역(콤마로 구분된 참조 영역) |
1712
+ | `rule` | [`ConditionalFormatRule`](#cell-conditionalformatrule) | 규칙 내용. 강조 서식은 그 안의 style 에 담긴다 |
1713
+
1714
+ <a id="cell-datavalidationrule"></a>
1715
+ #### `DataValidationRule`
1716
+
1717
+ | 항목 | 형식 | 설명 |
1718
+ |---|---|---|
1719
+ | `ranges` | 문자열 | 적용 영역. 절대 참조 표기("$A$1:$B$2")이며 떨어져 있는 여러 영역은 콤마로 이어 붙인 한 문자열이다 |
1720
+ | `type` | [`DataValidationType`](#cell-datavalidationtype) | 검사 종류 |
1721
+ | `formula1` (선택) | `string \| number` | 검사에 쓰는 값·참조·수식. any 종류에는 없다 |
1722
+ | `operator` (선택) | [`DataValidationOperator`](#cell-datavalidationoperator) | 비교 연산자. 숫자·날짜·시간·길이 종류에만 있다 |
1723
+ | `formula2` (선택) | `string \| number` | between·notBetween 의 두 번째 경계 |
1724
+ | `allowBlank` | 참/거짓 | 빈 셀을 허용하는지 여부 |
1725
+ | `showDropDown` (선택) | 참/거짓 | 목록을 드롭다운으로 보여줄지 여부. list 종류에만 있다 |
1726
+ | `showInputMessage` | 참/거짓 | 셀을 선택했을 때 안내 메시지를 보여줄지 여부 |
1727
+ | `inputTitle` (선택) | 문자열 | 안내 메시지 제목 |
1728
+ | `inputMessage` (선택) | 문자열 | 안내 메시지 본문 |
1729
+ | `showErrorMessage` | 참/거짓 | 규칙을 어겼을 때 오류 메시지를 보여줄지 여부 |
1730
+ | `errorStyle` | [`DataValidationErrorStyle`](#cell-datavalidationerrorstyle) | 오류 표시 방식 |
1731
+ | `errorTitle` (선택) | 문자열 | 오류 메시지 제목 |
1732
+ | `errorMessage` (선택) | 문자열 | 오류 메시지 본문 |
1733
+
1734
+ <a id="cell-commentinfo"></a>
1735
+ #### `CommentInfo`
1736
+
1737
+ | 항목 | 형식 | 설명 |
1738
+ |---|---|---|
1739
+ | `cell` | 문자열 | 메모가 붙은 셀(A1 표기) |
1740
+ | `text` | 문자열 | 메모 내용 문자열. 여러 줄은 "\n" 으로 이어진다 |
1741
+ | `visible` | 참/거짓 | 항상 보이는지 여부. false 인 메모는 셀에 마우스를 올릴 때만 보인다 |
1742
+
1743
+ <a id="cell-cellcontent"></a>
1744
+ #### `CellContent`
1745
+
1746
+ | 항목 | 형식 | 설명 |
1747
+ |---|---|---|
1748
+ | `value` | `string \| number \| boolean \| undefined` | 셀 값. 수식 셀은 계산 결과값이고 빈 셀은 undefined 다 |
1749
+ | `displayValue` | 문자열 | 화면에 보이는 문자열(서식 적용 후) |
1750
+ | `formula` | 문자열 (없을 수 있음) | 수식. 수식이 아니면 null |
1751
+
1752
+ <a id="cell-hyperlinkinfo"></a>
1753
+ #### `HyperlinkInfo`
1754
+
1755
+ | 항목 | 형식 | 설명 |
1756
+ |---|---|---|
1757
+ | `range` | 문자열 | — |
1758
+ | `type` | `"web" \| "email" \| "book" \| "document" \| "file" \| ""` | — |
1759
+ | `location` | 문자열 | — |
1760
+ | `display` | 문자열 | — |
1761
+
1762
+ <a id="cell-hyperlinkoptions"></a>
1763
+ #### `HyperlinkOptions`
1764
+
1765
+ | 항목 | 형식 | 설명 |
1766
+ |---|---|---|
1767
+ | `location` | 문자열 | 링크 대상. 웹 주소, 이메일 주소, 문서 안의 참조("Sheet1!A1"), 정의된 이름을 받으며 type 에 맞는 형식이 아니면 걸 수 없다 |
1768
+ | `display` (선택) | 문자열 (없을 수 있음) | 좌상단 셀에 넣을 표시 텍스트. 셀 값이 숫자이거나 줄바꿈이 든 문자열이면 무시되고 셀 값이 그대로 남는다. 셀 값이 그 밖의 문자열이면 display 로 바뀌고, 셀이 비어 있으면 display 가 들어가며 생략하면 location 이 들어간다 |
1769
+ | `type` (선택) | [`HyperlinkType`](#cell-hyperlinktype) (없을 수 있음) | 링크 종류. 생략하면 location 을 보고 판별한다 |
1770
+
1771
+ <a id="cell-borderline"></a>
1772
+ #### `BorderLine`
1773
+
1774
+ | 항목 | 형식 | 설명 |
1775
+ |---|---|---|
1776
+ | `style` | [`BorderLineStyle`](#cell-borderlinestyle) | 선 스타일 |
1777
+ | `color` (선택) | 문자열 | 선 색 "#RRGGBB" |
1778
+
1779
+ <a id="cell-borderdiagonal"></a>
1780
+ #### `BorderDiagonal`
1781
+
1782
+ | 항목 | 형식 | 설명 |
1783
+ |---|---|---|
1784
+ | `style` | [`BorderLineStyle`](#cell-borderlinestyle) | 선 스타일 |
1785
+ | `color` (선택) | 문자열 | 선 색 "#RRGGBB" |
1786
+ | `direction` | `"diagonal_up" \| "diagonal_down" \| "diagonal_cross"` | 대각선 방향. setBorder 의 type 으로 그대로 넘길 수 있다 |
1787
+
1788
+ <a id="cell-borderinfo"></a>
1789
+ #### `BorderInfo`
1790
+
1791
+ | 항목 | 형식 | 설명 |
1792
+ |---|---|---|
1793
+ | `top` | [`BorderLine`](#cell-borderline) (없을 수 있음) | 테두리가 없으면 null |
1794
+ | `bottom` | [`BorderLine`](#cell-borderline) (없을 수 있음) | — |
1795
+ | `left` | [`BorderLine`](#cell-borderline) (없을 수 있음) | — |
1796
+ | `right` | [`BorderLine`](#cell-borderline) (없을 수 있음) | — |
1797
+ | `diagonal` | [`BorderDiagonal`](#cell-borderdiagonal) (없을 수 있음) | — |
1798
+
1799
+ <a id="cell-fillpattern"></a>
1800
+ #### `FillPattern`
1801
+
1802
+ | 항목 | 형식 | 설명 |
1803
+ |---|---|---|
1804
+ | `type` | 문자열 | 무늬 종류("lightGrid", "darkVertical" 등) |
1805
+ | `color` (선택) | 문자열 | 무늬선 색 "#RRGGBB" |
1806
+
1807
+ <a id="cell-fillinfo"></a>
1808
+ #### `FillInfo`
1809
+
1810
+ | 항목 | 형식 | 설명 |
1811
+ |---|---|---|
1812
+ | `type` | `"solid" \| "pattern" \| "gradient"` | — |
1813
+ | `backgroundColor` (선택) | 문자열 | 바탕색 "#RRGGBB" |
1814
+ | `pattern` (선택) | [`FillPattern`](#cell-fillpattern) | 바탕색 위에 겹쳐 그리는 무늬 |
1815
+
1816
+ <a id="cell-tableoptionupdate"></a>
1817
+ #### `TableOptionUpdate`
1818
+
1819
+ | 항목 | 형식 | 설명 |
1820
+ |---|---|---|
1821
+ | `headerRow` (선택) | 참/거짓 | 머리글 행을 둘지 여부 |
1822
+ | `totalsRow` (선택) | 참/거짓 | 요약 행을 둘지 여부 |
1823
+ | `firstColumn` (선택) | 참/거짓 | 첫 열에 강조 서식을 줄지 여부 |
1824
+ | `lastColumn` (선택) | 참/거짓 | 끝 열에 강조 서식을 줄지 여부 |
1825
+ | `bandedRows` (선택) | 참/거짓 | 행을 한 줄씩 번갈아 다른 색으로 칠할지 여부 |
1826
+ | `bandedColumns` (선택) | 참/거짓 | 열을 한 줄씩 번갈아 다른 색으로 칠할지 여부 |
1827
+
1828
+ <a id="cell-tableoptions"></a>
1829
+ #### `TableOptions`
1830
+
1831
+ | 항목 | 형식 | 설명 |
1832
+ |---|---|---|
1833
+ | `headerRow` | 참/거짓 | 머리글 행을 두는지 여부 |
1834
+ | `totalsRow` | 참/거짓 | 요약 행을 두는지 여부 |
1835
+ | `firstColumn` | 참/거짓 | 첫 열에 강조 서식을 주는지 여부 |
1836
+ | `lastColumn` | 참/거짓 | 끝 열에 강조 서식을 주는지 여부 |
1837
+ | `bandedRows` | 참/거짓 | 행을 한 줄씩 번갈아 다른 색으로 칠하는지 여부 |
1838
+ | `bandedColumns` | 참/거짓 | 열을 한 줄씩 번갈아 다른 색으로 칠하는지 여부 |
1839
+ | `style` | 문자열 | 표에 적용된 표 스타일 이름 ("TableStyleMedium2" 등) |
1840
+
1841
+ <a id="cell-tableinfo"></a>
1842
+ #### `TableInfo`
1843
+
1844
+ | 항목 | 형식 | 설명 |
1845
+ |---|---|---|
1846
+ | `name` | 문자열 | 표 이름 |
1847
+ | `sheet` | 문자열 | 표가 놓인 시트 이름 |
1848
+ | `range` | 문자열 | 표 전체 영역의 A1 표기. 머리글 행과 요약 행이 함께 들어간다 |
1849
+ | `headerRow` | 참/거짓 | 머리글 행을 두는지 여부 |
1850
+ | `totalsRow` | 참/거짓 | 요약 행을 두는지 여부 |
1851
+ | `firstColumn` | 참/거짓 | 첫 열에 강조 서식을 주는지 여부 |
1852
+ | `lastColumn` | 참/거짓 | 끝 열에 강조 서식을 주는지 여부 |
1853
+ | `bandedRows` | 참/거짓 | 행을 한 줄씩 번갈아 다른 색으로 칠하는지 여부 |
1854
+ | `bandedColumns` | 참/거짓 | 열을 한 줄씩 번갈아 다른 색으로 칠하는지 여부 |
1855
+ | `style` | 문자열 | 표에 적용된 표 스타일 이름 ("TableStyleMedium2" 등) |
1856
+
1857
+ <a id="cell-filtercolumn"></a>
1858
+ #### `FilterColumn`
1859
+
1860
+ | 항목 | 형식 | 설명 |
1861
+ |---|---|---|
1862
+ | `colId` | 숫자 | 필터 영역 첫 열부터 센 0-based 오프셋. applyFilter·clearFilter·sort 에 그대로 넘길 수 있다 |
1863
+ | `filterType` | [`FilterType`](#cell-filtertype) | 필터 종류 |
1864
+ | `criteria` | `Record<string, unknown> \| null` | applyFilter 에 넘기는 조건과 같은 형태. 알 수 없는 필터 종류면 null 이다 |
1865
+
1866
+ <a id="cell-filtersortstate"></a>
1867
+ #### `FilterSortState`
1868
+
1869
+ | 항목 | 형식 | 설명 |
1870
+ |---|---|---|
1871
+ | `colId` | 숫자 | 필터 영역 첫 열부터 센 0-based 오프셋. sort 에 넘기는 colId 와 같다 |
1872
+ | `order` | [`SortOrder`](#cell-sortorder) | 정렬 방향 |
1873
+
1874
+ <a id="cell-filterinfo"></a>
1875
+ #### `FilterInfo`
1876
+
1877
+ | 항목 | 형식 | 설명 |
1878
+ |---|---|---|
1879
+ | `enabled` | 참/거짓 | 필터가 있는지 여부. false 면 이 필드만 들어 있다 |
1880
+ | `range` (선택) | 문자열 | 필터 영역의 A1 표기 (예: "A1:D20") |
1881
+ | `columns` (선택) | [`FilterColumn`](#cell-filtercolumn) 목록 | 조건이 걸린 열의 목록 |
1882
+ | `hiddenRowCount` (선택) | 숫자 | 필터 조건에 걸려 숨겨진 행 수. 사용자가 직접 숨긴 행은 세지 않는다 |
1883
+ | `sort` (선택) | [`FilterSortState`](#cell-filtersortstate) (없을 수 있음) | 정렬 상태. 정렬한 적이 없으면 null 이고, 정렬 키가 여럿인 문서는 첫 기준만 담는다 |
1884
+
1885
+ <a id="cell-nameupdate"></a>
1886
+ #### `NameUpdate`
1887
+
1888
+ | 항목 | 형식 | 설명 |
1889
+ |---|---|---|
1890
+ | `newName` (선택) | 문자열 | 새 이름. 공백이나 허용되지 않는 문자를 쓸 수 없고, 예약된 이름이나 셀 참조로 읽히는 이름, 최대 길이를 넘는 이름도 받지 않는다 |
1891
+ | `formula` (선택) | 문자열 | 새 수식 또는 참조. `=` 로 시작해도 되고 아니어도 된다 |
1892
+
1893
+ <a id="cell-nameinfo"></a>
1894
+ #### `NameInfo`
1895
+
1896
+ | 항목 | 형식 | 설명 |
1897
+ |---|---|---|
1898
+ | `name` | 문자열 | 정의된 이름 |
1899
+ | `sheet` | 문자열 (없을 수 있음) | 특정 시트에서만 쓰는 이름이면 그 시트. 문서 전체에서 쓰는 이름이면 null |
1900
+ | `formula` | 문자열 | `=` 로 시작하는 수식 |
1901
+ | `ranges` | 문자열 | 이름이 가리키는 실제 영역이다. 시트 이름을 붙인 A1 주소를 콤마로 이어 붙이며, 상수나 오류를 가리키는 이름과 지원하지 않는 함수를 쓴 이름은 빈 문자열이다 |
1902
+
1903
+ <a id="cell-fontinfo"></a>
1904
+ #### `FontInfo`
1905
+
1906
+ | 항목 | 형식 | 설명 |
1907
+ |---|---|---|
1908
+ | `bold` | 참/거짓 (없을 수 있음) | 굵게 여부 |
1909
+ | `italic` | 참/거짓 (없을 수 있음) | 기울임 여부 |
1910
+ | `underline` | `"single" \| "double" \| "none"` | 밑줄 종류 |
1911
+ | `strikethrough` | 참/거짓 (없을 수 있음) | 취소선 여부 |
1912
+ | `name` | 문자열 (없을 수 있음) | 글꼴 이름 |
1913
+ | `size` | 숫자 (없을 수 있음) | 글꼴 크기(pt) |
1914
+ | `color` | 문자열 (없을 수 있음) | 글꼴 색 "#RRGGBB" |
1915
+
1916
+ <a id="cell-alignmentinfo"></a>
1917
+ #### `AlignmentInfo`
1918
+
1919
+ | 항목 | 형식 | 설명 |
1920
+ |---|---|---|
1921
+ | `horizontalAlign` | 문자열 (없을 수 있음) | 가로 정렬. 값 어휘는 HorizontalAlign |
1922
+ | `verticalAlign` | 문자열 (없을 수 있음) | 세로 정렬. 값 어휘는 VerticalAlign |
1923
+ | `wrapText` | 참/거짓 (없을 수 있음) | 텍스트 줄바꿈 여부 |
1924
+ | `indent` | 숫자 | 들여쓰기 수준 |
1925
+
1926
+ ### 부록 — 상수 목록 (Spreadsheet)
1927
+
1928
+ <a id="cell-horizontalalign"></a>
1929
+ #### `HorizontalAlign`
1930
+
1931
+ `Range.setHorizontalAlign` 에 넘기는 셀 가로 정렬이다.
1932
+
1933
+ 지정하지 않은 셀은 데이터 종류에 따라 그려진다(문자는 왼쪽, 숫자는 오른쪽). 조회는 명시 지정된 값만 돌려주므로 기본 상태에서는 값이 없다.
1934
+
1935
+ | 상수 | 설명 |
1936
+ |---|---|
1937
+ | `LEFT` | — |
1938
+ | `CENTER` | — |
1939
+ | `RIGHT` | — |
1940
+ | `JUSTIFY` | — |
1941
+ | `DISTRIBUTED` | — |
1942
+
1943
+ <a id="cell-verticalalign"></a>
1944
+ #### `VerticalAlign`
1945
+
1946
+ `Range.setVerticalAlign` 에 넘기는 셀 세로 정렬이다.
1947
+
1948
+ 지정하지 않은 셀은 아래쪽으로 그려진다. 조회는 명시 지정된 값만 돌려준다.
1949
+
1950
+ | 상수 | 설명 |
1951
+ |---|---|
1952
+ | `TOP` | — |
1953
+ | `CENTER` | — |
1954
+ | `BOTTOM` | — |
1955
+ | `JUSTIFY` | — |
1956
+
1957
+ <a id="cell-bordertype"></a>
1958
+ #### `BorderType`
1959
+
1960
+ `Range.setBorder` 의 첫 인자로 넘기는 테두리 적용 위치다.
1961
+
1962
+ 값은 모델 어휘(`Constants.ot.BORDER_TYPE_*`)와 같은 문자열이다.
1963
+
1964
+ | 상수 | 설명 |
1965
+ |---|---|
1966
+ | `ALL` | 바깥 네 변과 내부 선 전체 |
1967
+ | `RECTANGLE` | 바깥 네 변 |
1968
+ | `CROSS` | 내부의 가로선과 세로선 |
1969
+ | `TOP` | 위쪽 변 |
1970
+ | `BOTTOM` | 아래쪽 변 |
1971
+ | `LEFT` | 왼쪽 변 |
1972
+ | `RIGHT` | 오른쪽 변 |
1973
+ | `CENTER` | 내부의 세로선 |
1974
+ | `MIDDLE` | 내부의 가로선 |
1975
+ | `DIAGONAL` | 방향이 정해지지 않아 테두리가 그려지지 않는다. 대각선은 DIAGONAL_UP·DIAGONAL_DOWN·DIAGONAL_CROSS 로 지정한다 |
1976
+ | `DIAGONAL_UP` | 각 셀의 왼쪽 아래에서 오른쪽 위로 긋는 대각선 |
1977
+ | `DIAGONAL_DOWN` | 각 셀의 왼쪽 위에서 오른쪽 아래로 긋는 대각선 |
1978
+ | `DIAGONAL_CROSS` | 각 셀의 대각선 두 방향 |
1979
+ | `NONE` | 테두리 제거. 선 스타일과 색은 무시된다 |
1980
+
1981
+ <a id="cell-borderlinestyle"></a>
1982
+ #### `BorderLineStyle`
1983
+
1984
+ `Range.setBorder` 의 두 번째 인자로 넘기는 테두리 선 스타일이다. 생략하면 `THIN` 이다.
1985
+
1986
+ 값은 렌더러가 아는 선 스타일 전부(`view/util/borderStyleUtils.js` 의 우선순위 목록 · 조건부 서식이 쓰는 `controller/dxfStyle.js` 의 `CF_PROFILE.border.styles`)와 같아야 한다. 목록 밖의 문자열은 검증 없이 저장되고 화면에는 테두리가 지정한 모양으로 그려지지 않는다.
1987
+ 생성기가 객체 리터럴만 읽으므로 그 목록에서 파생할 수 없다. 대신 dispatch 테스트가 어긋남을 잡는다.
1988
+
1989
+ | 상수 | 설명 |
1990
+ |---|---|
1991
+ | `HAIR` | — |
1992
+ | `THIN` | — |
1993
+ | `MEDIUM` | — |
1994
+ | `THICK` | — |
1995
+ | `DOUBLE` | — |
1996
+ | `DOTTED` | — |
1997
+ | `DASHED` | — |
1998
+ | `DASH_DOT` | — |
1999
+ | `DASH_DOT_DOT` | — |
2000
+ | `MEDIUM_DASHED` | — |
2001
+ | `MEDIUM_DASH_DOT` | — |
2002
+ | `MEDIUM_DASH_DOT_DOT` | — |
2003
+ | `SLANT_DASH_DOT` | — |
2004
+ | `NONE` | — |
2005
+
2006
+ <a id="cell-sortorder"></a>
2007
+ #### `SortOrder`
2008
+
2009
+ `Range.sort` 와 `Filter.sort` 에 넘기는 정렬 방향이다.
2010
+
2011
+ | 상수 | 설명 |
2012
+ |---|---|
2013
+ | `ASCENDING` | — |
2014
+ | `DESCENDING` | — |
2015
+
2016
+ <a id="cell-hyperlinktype"></a>
2017
+ #### `HyperlinkType`
2018
+
2019
+ `Range.setHyperlink` 의 `options.type` 에 넘기는 하이퍼링크 종류다.
2020
+
2021
+ `BOOK` 은 같은 문서 안의 위치로 이동하는 링크이며 `location` 에 시트·범위를 준다.
2022
+
2023
+ | 상수 | 설명 |
2024
+ |---|---|
2025
+ | `WEB` | — |
2026
+ | `EMAIL` | — |
2027
+ | `BOOK` | — |
2028
+
2029
+ <a id="cell-datavalidationtype"></a>
2030
+ #### `DataValidationType`
2031
+
2032
+ `Range.setDataValidation` 의 `rule.type` 에 넘기는 데이터 유효성 규칙 종류다.
2033
+
2034
+ `ANY` 는 입력을 제한하지 않고 안내 메시지만 붙이는 종류이므로 수식이 필요 없다.
2035
+ `LIST` 는 `formula1` 에 콤마 목록(`=` 없이) 또는 단일 열·행 범위 참조(`=` 필수)를 받고, `CUSTOM` 은 불리언 수식을 받는다. 나머지는 `operator` 와 짝으로 경계값을 받는다.
2036
+
2037
+ | 상수 | 설명 |
2038
+ |---|---|
2039
+ | `ANY` | — |
2040
+ | `LIST` | — |
2041
+ | `WHOLE` | — |
2042
+ | `DECIMAL` | — |
2043
+ | `DATE` | — |
2044
+ | `TIME` | — |
2045
+ | `TEXT_LENGTH` | — |
2046
+ | `CUSTOM` | — |
2047
+
2048
+ <a id="cell-datavalidationoperator"></a>
2049
+ #### `DataValidationOperator`
2050
+
2051
+ `Range.setDataValidation` 의 `rule.operator` 에 넘기는 데이터 유효성 비교 연산자다.
2052
+
2053
+ 숫자·날짜·시간·길이 종류에서만 쓴다. `BETWEEN`/`NOT_BETWEEN` 은 `formula2` 로 두 번째 경계를 함께 받는다.
2054
+
2055
+ | 상수 | 설명 |
2056
+ |---|---|
2057
+ | `BETWEEN` | — |
2058
+ | `NOT_BETWEEN` | — |
2059
+ | `EQUAL` | — |
2060
+ | `NOT_EQUAL` | — |
2061
+ | `LESS_THAN` | — |
2062
+ | `LESS_THAN_OR_EQUAL` | — |
2063
+ | `GREATER_THAN` | — |
2064
+ | `GREATER_THAN_OR_EQUAL` | — |
2065
+
2066
+ <a id="cell-datavalidationerrorstyle"></a>
2067
+ #### `DataValidationErrorStyle`
2068
+
2069
+ `Range.setDataValidation` 의 `rule.errorStyle` 에 넘기는 데이터 유효성 위반 시 오류 표시 방식이다. 생략하면 `STOP` 이다.
2070
+
2071
+ `STOP` 은 입력을 거부하고, `WARNING`/`INFORMATION` 은 경고 후 입력을 허용한다.
2072
+
2073
+ | 상수 | 설명 |
2074
+ |---|---|
2075
+ | `STOP` | — |
2076
+ | `WARNING` | — |
2077
+ | `INFORMATION` | — |
2078
+
2079
+ <a id="cell-conditionalformatruletype"></a>
2080
+ #### `ConditionalFormatRuleType`
2081
+
2082
+ `Range.addConditionalFormat` 의 `rule.type` 에 넘기는 조건부 서식 규칙 종류다.
2083
+
2084
+ `CELL_IS` 는 `operator` + 경계값, `EXPRESSION` 은 불리언 수식, 텍스트 계열은 비교 문자열, `TOP10` 은 순위(`rank`), `TIME_PERIOD` 는 기간 토큰을 함께 받는다. 여기까지는 수식 계열로 강조 서식을 `style` 로 직접 지정한다.
2085
+
2086
+ `COLOR_SCALE`/`DATA_BAR`/`ICON_SET` 은 시각 규칙이라 `style` 을 받지 않고 색 목록 또는 프리셋 식별자와 임계값(`cfvo`)으로 서술한다.
2087
+
2088
+ | 상수 | 설명 |
2089
+ |---|---|
2090
+ | `CELL_IS` | — |
2091
+ | `EXPRESSION` | — |
2092
+ | `CONTAINS_TEXT` | — |
2093
+ | `NOT_CONTAINS_TEXT` | — |
2094
+ | `BEGINS_WITH` | — |
2095
+ | `ENDS_WITH` | — |
2096
+ | `CONTAINS_BLANKS` | — |
2097
+ | `NOT_CONTAINS_BLANKS` | — |
2098
+ | `CONTAINS_ERRORS` | — |
2099
+ | `NOT_CONTAINS_ERRORS` | — |
2100
+ | `TOP10` | — |
2101
+ | `ABOVE_AVERAGE` | — |
2102
+ | `BELOW_AVERAGE` | — |
2103
+ | `DUPLICATE_VALUES` | — |
2104
+ | `UNIQUE_VALUES` | — |
2105
+ | `TIME_PERIOD` | — |
2106
+ | `COLOR_SCALE` | — |
2107
+ | `DATA_BAR` | — |
2108
+ | `ICON_SET` | — |
2109
+
2110
+ <a id="cell-conditionalformatoperator"></a>
2111
+ #### `ConditionalFormatOperator`
2112
+
2113
+ `cellIs` 규칙의 `operator` 에 넘기는 조건부 서식 비교 연산자다.
2114
+
2115
+ `BETWEEN`/`NOT_BETWEEN` 은 `formula2` 로 두 번째 경계를 함께 받는다.
2116
+
2117
+ | 상수 | 설명 |
2118
+ |---|---|
2119
+ | `EQUAL` | — |
2120
+ | `NOT_EQUAL` | — |
2121
+ | `BETWEEN` | — |
2122
+ | `NOT_BETWEEN` | — |
2123
+ | `GREATER_THAN` | — |
2124
+ | `GREATER_THAN_OR_EQUAL` | — |
2125
+ | `LESS_THAN` | — |
2126
+ | `LESS_THAN_OR_EQUAL` | — |
2127
+
2128
+ <a id="cell-conditionalformattimeperiod"></a>
2129
+ #### `ConditionalFormatTimePeriod`
2130
+
2131
+ 규칙 종류가 `timePeriod` 일 때 `rule.timePeriod` 에 넘기는 기간 토큰이다.
2132
+
2133
+ 기준일은 문서를 여는 시점의 오늘 날짜이므로 규칙이 가리키는 셀 집합은 날짜가 바뀌면 달라진다.
2134
+
2135
+ | 상수 | 설명 |
2136
+ |---|---|
2137
+ | `YESTERDAY` | — |
2138
+ | `TODAY` | — |
2139
+ | `TOMORROW` | — |
2140
+ | `LAST_7_DAYS` | — |
2141
+ | `LAST_WEEK` | — |
2142
+ | `THIS_WEEK` | — |
2143
+ | `NEXT_WEEK` | — |
2144
+ | `LAST_MONTH` | — |
2145
+ | `THIS_MONTH` | — |
2146
+ | `NEXT_MONTH` | — |
2147
+
2148
+ <a id="cell-conditionalformatvaluetype"></a>
2149
+ #### `ConditionalFormatValueType`
2150
+
2151
+ `cfvo[].type` 에 넘기는 조건부 서식 시각 규칙 임계값의 기준이다.
2152
+
2153
+ `NUM`/`PERCENT`/`PERCENTILE`/`FORMULA` 는 `formula` 로 값을 함께 받고, `MIN`/`MAX` 는 범위의 최소·최대를 쓴다. `AUTO_MIN`/`AUTO_MAX` 는 데이터 막대 프리셋의 기본 임계값이라 조회에만 나오고 입력은 받지 않는다.
2154
+
2155
+ | 상수 | 설명 |
2156
+ |---|---|
2157
+ | `NUM` | — |
2158
+ | `MIN` | — |
2159
+ | `MAX` | — |
2160
+ | `PERCENT` | — |
2161
+ | `PERCENTILE` | — |
2162
+ | `FORMULA` | — |
2163
+ | `AUTO_MIN` | — |
2164
+ | `AUTO_MAX` | — |
2165
+
2166
+ <a id="cell-filtertype"></a>
2167
+ #### `FilterType`
2168
+
2169
+ `Filter.applyFilter` 의 `criteria.filterType` 에 넘기는 필터 조건 종류다.
2170
+
2171
+ 종류에 따라 criteria 의 나머지 필드가 달라진다. `VALUES` 는 표시할 값 목록을, `CUSTOM` 은 조건식 1~2개를, `TOP10` 은 개수나 비율을, `DYNAMIC` 은 평균 기준 토큰을 함께 받는다.
2172
+
2173
+ `Filter.getInfo` 의 `columns[].filterType` 도 같은 어휘다. 단 단일 `EQUAL` 조건으로 적용한 `CUSTOM` 은 모델에서 값 목록으로 저장되어 조회 시 `VALUES` 로 나온다.
2174
+
2175
+ | 상수 | 설명 |
2176
+ |---|---|
2177
+ | `VALUES` | — |
2178
+ | `CUSTOM` | — |
2179
+ | `TOP10` | — |
2180
+ | `DYNAMIC` | — |
2181
+
2182
+ <a id="cell-filteroperator"></a>
2183
+ #### `FilterOperator`
2184
+
2185
+ `custom` criteria 의 `conditions[].operator` 에 넘기는 사용자 지정 필터 조건식의 연산자다.
2186
+
2187
+ `EQUAL` 은 단일 조건에서만 쓸 수 있다(두 조건 조합에서는 지원하지 않는다).
2188
+ "사이"·"사이 제외" 는 별도 연산자가 아니라 두 조건의 AND·OR 조합으로 표현한다.
2189
+
2190
+ | 상수 | 설명 |
2191
+ |---|---|
2192
+ | `EQUAL` | — |
2193
+ | `NOT_EQUAL` | — |
2194
+ | `GREATER_THAN` | — |
2195
+ | `GREATER_OR_EQUAL` | — |
2196
+ | `LESS_THAN` | — |
2197
+ | `LESS_OR_EQUAL` | — |
2198
+ | `BEGINS_WITH` | — |
2199
+ | `NOT_BEGINS_WITH` | — |
2200
+ | `ENDS_WITH` | — |
2201
+ | `NOT_ENDS_WITH` | — |
2202
+ | `CONTAINS` | — |
2203
+ | `NOT_CONTAINS` | — |
2204
+
2205
+ <a id="cell-filterdynamictype"></a>
2206
+ #### `FilterDynamicType`
2207
+
2208
+ `dynamic` criteria 의 `type` 에 넘기는 동적 필터의 기준이다.
2209
+
2210
+ | 상수 | 설명 |
2211
+ |---|---|
2212
+ | `ABOVE_AVERAGE` | — |
2213
+ | `BELOW_AVERAGE` | — |
2214
+
2215
+ <a id="mod-show"></a>
2216
+ ## Presentation
2217
+
2218
+ Presentation 문서를 다루는 기능입니다. 슬라이드 추가·복제, 도형·이미지·표 편집, 테마 적용 등을 외부 서비스에서 호출할 수 있습니다.
2219
+
2220
+ <a id="show-document"></a>
2221
+ ### Document — 문서 (`Document`)
2222
+
2223
+ 문서 전체를 다루는 진입점으로, 슬라이드 조회·검색(getSlide/findShapes/findText 등),
2224
+ 슬라이드 삽입·삭제·복제·이동(insertSlide/deleteSlide/duplicateSlide 등),
2225
+ 날짜·슬라이드 번호·바닥글 일괄 설정(setDate/setSlideNumber/setFooter 등),
2226
+ 테마 적용(setColorScheme/setFontScheme/setFormatScheme 등),
2227
+ 저장·다운로드·인쇄(save/download/print 등), 슬라이드 쇼 시작(startSlideShow)을 제공한다.
2228
+
2229
+ | 기능 | 설명 | 입력 | 결과 |
2230
+ |---|---|---|---|
2231
+ | `getDocumentInfo` | 문서(캔버스) 정보를 반환한다. | — | 슬라이드 영역의 가로·세로 크기 (px) 와 전체 슬라이드 수<br>`{ width: number; height: number; slideCount: number }` |
2232
+ | `getSlideSize` | 슬라이드 영역 크기 (px). 문서 내 모든 슬라이드가 공유하는 단일 값. | — | 슬라이드 영역의 가로·세로 크기 (px)<br>`{ width: number; height: number }` |
2233
+ | `getSlide` | 인덱스로 슬라이드를 가져온다. | `index` 숫자 — 0-based | 해당 슬라이드 (범위를 벗어나면 null)<br>[`Slide`](#show-slide) (없을 수 있음) |
2234
+ | `getSlideIndex` | 슬라이드의 0-based 인덱스를 찾는다. | `slideProxy` [`Slide`](#show-slide) — 대상 슬라이드 | 문서에 없는 슬라이드면 -1<br>숫자 |
2235
+ | `getSlides` | 문서의 모든 슬라이드를 순서대로 반환한다. | — | 슬라이드 목록<br>[`Slide`](#show-slide) 목록 |
2236
+ | `getLayoutList` | 지정한 슬라이드가 속한 마스터의 레이아웃 목록을 반환한다.<br>레이아웃은 마스터 단위의 상위 개념이라 문서 레벨에서 조회한다. | `slideProxy` [`Slide`](#show-slide) — 대상 슬라이드 | 레이아웃 목록 (대상 슬라이드가 없으면 빈 배열 반환)<br>`{ name: string; type: SlideLayoutType }[]` |
2237
+ | `getSlideCount` | *설명 준비 중* | — | 문서의 전체 슬라이드 수<br>숫자 |
2238
+ | `getCurrentSlide` | 현재 보기의 슬라이드를 반환한다. | — | 현재 슬라이드 (문서에 슬라이드가 없으면 null)<br>[`Slide`](#show-slide) (없을 수 있음) |
2239
+ | `findSlides` | 조건에 맞는 슬라이드를 검색한다. | `filter` (선택) [`SlideFilter`](#show-slidefilter) — 검색 조건 (기본값: 전체 슬라이드) | 조건에 맞는 슬라이드 목록<br>[`Slide`](#show-slide) 목록 |
2240
+ | `findShapes` | 여러 슬라이드에서 조건에 맞는 도형을 검색한다.<br>슬라이드별 검색은 Slide.findShapes 와 동일하며, 결과를 슬라이드 순서대로 합친다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`ShapeFilter`](#show-shapefilter) — 검색 조건 (Slide.findShapes 와 동일) (기본값: 전체 도형) | 조건에 맞는 도형 목록<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2241
+ | `findTables` | 여러 슬라이드에서 조건에 맞는 표를 검색한다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`TableFilter`](#show-tablefilter) — 검색 조건 (Slide.findTables 와 동일) (기본값: 전체 표) | 조건에 맞는 표 목록<br>[`Table`](#show-table) 목록 |
2242
+ | `findCharts` | 여러 슬라이드에서 조건에 맞는 차트를 검색한다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`ChartFilter`](#show-chartfilter) — 검색 조건 (Slide.findCharts 와 동일) (기본값: 전체 차트) | 조건에 맞는 차트 목록<br>[`Chart`](#show-chart) 목록 |
2243
+ | `findComments` | 여러 슬라이드에서 조건에 맞는 댓글을 검색한다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`CommentFilter`](#show-commentfilter) — 검색 조건 (Slide.findComments 와 동일) (기본값: 전체 댓글) | 조건에 맞는 댓글 목록<br>[`Comment`](#show-comment) 목록 |
2244
+ | `findText` | 텍스트를 검색한다. slideProxyList 를 주면 그 슬라이드들만 검색한다.<br>매치는 문서 순서(슬라이드 → 도형 → 표 셀)로 반환된다.<br>병합으로 숨겨진 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 검색되지 않는다. | `query` 문자열 — 찾을 텍스트<br>`slideProxyList` (선택) [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드 (기본값: 전체 슬라이드)<br>`caseSensitive` (선택) 참/거짓 — 대소문자 구분 (기본값: false) | 매치 목록. target 은 표 셀 매치면 TableCell, 아니면 도형 프록시(Shape)이며, range 를 그대로 서식 API 에 넘겨 매치 구간만 편집할 수 있다 (예: `m.target.setBold(true, m.range)`). range 의 from/to 는 글자 offset(to 포함), text 는 검색 시점의 매치 텍스트다.<br>`{ target: (TableCell \| Shape); range: TextRange; text: string }[]` |
2245
+ | `getTableStyleNames` | 적용 가능한 표 스타일 이름 목록을 반환한다.<br>여기서 얻은 이름을 slide.insertTable / table.setStyle 에 그대로 넘긴다. | — | 표 스타일 이름 목록 (편집기 '표 스타일' 갤러리와 동일)<br>문자열 목록 |
2246
+ | `getColorSchemeList` | 적용 가능한 색상 테마(빌트인 + 사용자 정의) 목록을 반환한다. | — | 색상 테마 목록 (prst: 프리셋 이름, name: 표시 이름, colors: 슬롯 이름 → #RRGGBB)<br>`{ prst: string; name: string; colors: Record<string, unknown> }[]` |
2247
+ | `getColorScheme` | 문서의 색상 테마를 반환한다. (setColorScheme 대칭)<br>현재 슬라이드가 속한 마스터의 테마이며, setSlideColorScheme 으로 준 슬라이드별 재정의는 포함하지 않는다.<br>슬라이드별 조회는 slide.getColorScheme() 을 사용한다. | — | 색상 테마 (prst: getColorSchemeList 에 있는 테마일 때만 채워지고 파일에서 읽은 문서 고유 테마면 null, name: 테마 이름, colors: 슬롯 이름 → #RRGGBB). 문서에 슬라이드가 없으면 null<br>`{ prst: string \| null; name: string; colors: Record<string, unknown> } \| null` |
2248
+ | `getFontScheme` | 문서의 테마 글꼴을 반환한다. (setFontScheme 대칭) | — | 현재 테마 글꼴 (prst: getFontSchemeList 에 있는 테마일 때만 채워지고 목록에 없는 문서 고유 테마면 null, name: 테마 이름). 문서에 슬라이드가 없으면 null<br>`{ prst: string \| null; name: string } \| null` |
2249
+ | `getFormatScheme` | 문서의 테마 효과를 반환한다. (setFormatScheme 대칭) | — | 현재 테마 효과 (prst: getFormatSchemeList 에 있는 테마일 때만 채워짐, name: 표시 이름, 목록에 없으면 테마 원본 이름). 문서에 슬라이드가 없으면 null<br>`{ prst: string \| null; name: string } \| null` |
2250
+ | `isCommentsVisible` | 문서 전체의 댓글 표시 여부를 반환한다. (showComments 대칭) | — | 댓글이 표시 중이면 true<br>참/거짓 |
2251
+ | `getFontSchemeList` | 적용 가능한 테마 글꼴(빌트인 + 사용자 정의) 목록을 반환한다. | — | 테마 글꼴 목록 (prst: 프리셋 이름, name: 표시 이름)<br>`{ prst: string; name: string }[]` |
2252
+ | `getFormatSchemeList` | 적용 가능한 테마 효과 목록을 반환한다. | — | 테마 효과 목록 (prst: 프리셋 이름, name: 표시 이름)<br>`{ prst: string; name: string }[]` |
2253
+ | `getChartStyleList` | 차트 프리셋 스타일(1~12)별 계열 색 팔레트를 현재 슬라이드에 적용된 테마 기준으로 반환한다.<br>set_chart_style 의 style 을 고를 때 참고용.<br>style 은 색 그룹(4) × 배경/선 변형(3) 조합. 색은 그룹으로만 결정되므로 같은 그룹(예: 1~3)은 colors 가 동일하고,<br>그룹 내 차이(뒤 1/2/3)는 배경/선 변형(variant)이다. 색은 테마 accent 에 종속 — 테마가 바뀌면 값도 바뀐다. | — | 차트 스타일 목록. 문서에 슬라이드가 없으면 빈 배열<br>`{ style: number; colors: string[]; variant: string }[]` |
2254
+ | `replaceText` | 검색 텍스트를 찾아 모두 새 텍스트로 바꾼다. (모두 바꾸기) slideProxyList 를 주면 그 슬라이드들만 바꾼다.<br>병합으로 숨겨진 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 바뀌지 않는다.<br>협업 잠금 등으로 편집할 수 없는 텍스트의 매치도 바꾸지 않고 skippedCount 로 반환한다. | `query` 문자열 — 찾을 텍스트<br>`replacement` (선택) 문자열 — 바꿀 텍스트. 빈 문자열이면 매치를 삭제한다 (기본값: "")<br>`slideProxyList` (선택) [`Slide`](#show-slide) 목록 — 치환 대상 슬라이드 (기본값: 전체 슬라이드)<br>`caseSensitive` (선택) 참/거짓 — 대소문자 구분 (기본값: false) | 치환한 매치 수 / 제외한 매치 수<br>`{ replacedCount: number; skippedCount: number }` |
2255
+ | `insertSlide` | 새 슬라이드를 삽입한다. | `index` (선택) 숫자 — 삽입 위치 (0-based) (기본값: 마지막에 추가)<br>`layoutType` (선택) [`SlideLayoutType`](#show-slidelayouttype) — 레이아웃 종류. 같은 type 이 여럿이면 첫 번째. 지정한 type 미존재 시 BLANK (문서에 BLANK 가 없으면 첫 번째 마스터의 첫 번째 레이아웃) (기본값: SlideLayoutType.BLANK) | 삽입된 슬라이드<br>[`Slide`](#show-slide) |
2256
+ | `uploadImageFromUrl` | 이미지(URL / data:URI)를 서버 파일 DB 에 업로드한다. (SVG 임포트의 이미지 처리)<br>업로드 해소는 ApiUtils.uploadImageLink 로 공통화돼 있다(도형/배경 setImageFill·htmlImport 공유). | `url` 문자열 — 이미지 URL 또는 data URI | 성공 시 로더의 imgFileInfo 원본 그대로(src/width/height, isError 없음) resolve, 실패 시 { isError: true } resolve<br>`{isError?:boolean, src?:string, width?:number, height?:number}` |
2257
+ | `deleteSlide` | 슬라이드 하나를 삭제한다. | `slideProxy` [`Slide`](#show-slide) — 삭제할 슬라이드 | — |
2258
+ | `deleteSlides` | 여러 슬라이드를 일괄 삭제한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 삭제할 슬라이드 배열 | — |
2259
+ | `duplicateSlide` | 슬라이드 하나를 복제한다. | `slideProxy` [`Slide`](#show-slide) — 복제할 슬라이드 | 복제된 슬라이드 Proxy<br>[`Slide`](#show-slide) (없을 수 있음) |
2260
+ | `duplicateSlides` | 여러 슬라이드를 일괄 복제한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 복제할 슬라이드 배열 | 복제된 슬라이드 Proxy 배열<br>[`Slide`](#show-slide) 목록 |
2261
+ | `moveSlide` | 슬라이드를 다른 위치로 이동한다. | `fromIndex` 숫자 — 이동 원본 인덱스 (0-based)<br>`toIndex` 숫자 — 이동 대상 인덱스 (0-based) | — |
2262
+ | `goToSlide` | 지정한 슬라이드로 현재 보기를 전환한다. | `slideProxy` [`Slide`](#show-slide) — 이동할 슬라이드 | — |
2263
+ | `setDate` | 모든 슬라이드의 날짜 머리글/바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `date` (선택) [`HeaderFooterDate`](#show-headerfooterdate) — 날짜 설정 (기본값: 자동갱신 날짜) | — |
2264
+ | `removeDate` | 모든 슬라이드의 날짜 머리글/바닥글을 제거한다. | — | — |
2265
+ | `setSlideNumber` | 모든 슬라이드에 슬라이드 번호를 표시한다. | — | — |
2266
+ | `removeSlideNumber` | 모든 슬라이드의 슬라이드 번호를 제거한다. | — | — |
2267
+ | `setFooter` | 모든 슬라이드의 바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `text` 문자열 — 바닥글 텍스트 | — |
2268
+ | `removeFooter` | 모든 슬라이드의 바닥글을 제거한다. | — | — |
2269
+ | `hideSlides` | 여러 슬라이드의 숨김 상태를 일괄 변경한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열<br>`isHidden` 참/거짓 — true: 숨김, false: 표시 | — |
2270
+ | `resetBackgrounds` | 여러 슬라이드의 배경을 일괄 초기화한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열 | — |
2271
+ | `setTransition` | 여러 슬라이드에 전환 효과를 일괄 적용한다. (단일 undo 로 처리)<br>효과가 지원하는 옵션만 반영되며, 주지 않은 값은 기본 모델에서 채운다.<br>효과 제거는 type 으로 하지 않고 removeTransition() 을 사용한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열 (전체 적용은 getSlides() 를 넘긴다)<br>`transition` [`Transition`](#show-transition) — 전환 효과 설정 | — |
2272
+ | `removeTransition` | 여러 슬라이드의 전환 효과를 제거한다. (단일 undo 로 처리) | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열 | — |
2273
+ | `setColorScheme` | 문서 전체의 색상 테마를 변경한다.<br>getColorSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `colorSchemePrst` 문자열 — 색상 테마 프리셋 이름 | — |
2274
+ | `setSlideColorScheme` | 지정한 슬라이드들에만 색상 테마를 적용한다.<br>이후 setColorScheme 으로 문서 전체 테마를 바꾸면 여기서 준 슬라이드별 재정의는 모두 해제된다.<br>getColorSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열<br>`colorSchemePrst` 문자열 — 색상 테마 프리셋 이름 | — |
2275
+ | `createColorScheme` | 사용자 정의 색상 테마를 생성하고 현재 문서에 적용한다. | `colorScheme` [`ColorScheme`](#show-colorscheme) — 새 색상 테마 정보 | — |
2276
+ | `setFontScheme` | 문서의 테마 글꼴을 변경한다.<br>getFontSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `fontSchemePrst` 문자열 — 테마 글꼴 프리셋 이름 | — |
2277
+ | `setFormatScheme` | 문서의 테마 효과를 변경한다.<br>getFormatSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `formatSchemePrst` 문자열 — 테마 효과 프리셋 이름 | — |
2278
+ | `save` | 문서를 저장한다.<br>(서버 I/O 이므로 Actor 경유) | — | — |
2279
+ | `close` | 문서를 닫는다.<br>(앱 레벨 동작이므로 Actor 경유) | — | — |
2280
+ | `download` | 문서를 다운로드한다.<br>(서버 I/O 이므로 Actor 경유) | — | — |
2281
+ | `downloadAsPdf` | 문서를 PDF 로 변환해 다운로드한다. 원본 형식(pptx 등)으로 받으려면 download() 를 사용한다.<br>요청만 보내고 변환 완료를 기다리지 않는다 — 변환 진행·실패는 앱 상태 UI 가 표시한다.<br>OfficeFilter 사용 시 해당 API 미지원 (미구현)<br>(서버 변환·I/O 이므로 Actor 경유) | — | — |
2282
+ | `print` | 현재 문서를 인쇄한다.<br>(브라우저 인쇄/PDF 등 앱 레벨 동작이므로 Actor 경유) | — | — |
2283
+ | `showComments` | 문서 전체의 댓글 표시 여부를 설정한다. | `show` 참/거짓 — true: 댓글 표시, false: 댓글 숨김 | — |
2284
+ | `startSlideShow` | 슬라이드 쇼(전체화면 발표)를 시작한다. | `fromCurrent` (선택) 참/거짓 — true: 현재 슬라이드부터, false: 처음부터 (기본값: false) | — |
2285
+ | `selectAll` | 지정한 범위를 모두 선택한다. | `scope` (선택) [`SelectScope`](#show-selectscope) — "shape": 현재 슬라이드의 모든 도형 - "slide": 모든 슬라이드 - "text": 현재 편집 중인 텍스트 전체 (텍스트 편집 중이 아니면 아무것도 선택 안 함) (기본값: SelectScope.SHAPE) | 선택 대상이 없으면 false<br>참/거짓 |
2286
+ | `setViewMode` | 편집 화면의 보기 배율/맞춤을 변경한다. | `mode` [`ViewMode`](#show-viewmode) — 보기 배율 또는 창 맞춤. 허용값은 ViewMode 의 8개뿐이다. | — |
2287
+
2288
+ <a id="show-slide"></a>
2289
+ ### Slide — 슬라이드 (`Slide`)
2290
+
2291
+ 슬라이드 한 장을 다루는 핸들로, 도형·표·차트·댓글 조회와 검색(getShapes/findShapes/findText 등),
2292
+ 개체 삽입(insertShape/insertTable/insertImage 등),
2293
+ 도형 그룹·복제·삭제·배분(groupShapes/duplicateShape/deleteShape 등), 배경 채우기(setFill 계열),
2294
+ 레이아웃·전환 효과(setLayout/setTransition 등), 슬라이드 노트 편집(setSlideNoteText 등)을 제공하며,
2295
+ 대상 슬라이드가 없으면(협업 중 삭제 등) getter 는 null(목록은 빈 배열)을 반환하고
2296
+ setter 는 SLIDE_NOT_FOUND 로 실패한다.
2297
+
2298
+ | 기능 | 설명 | 입력 | 결과 |
2299
+ |---|---|---|---|
2300
+ | `getShapes` | 슬라이드의 모든 도형을 반환한다. | — | 도형 목록<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2301
+ | `getShape` | 인덱스로 도형을 가져온다. | `index` 숫자 — 0-based | 해당 도형 (범위를 벗어나면 null)<br>`Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control \| null` |
2302
+ | `findShapes` | 조건에 맞는 도형을 검색한다. | `filter` (선택) [`ShapeFilter`](#show-shapefilter) — 검색 조건 (기본값: 전체 도형) | 조건에 맞는 도형 목록<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2303
+ | `findTables` | 조건에 맞는 표를 검색한다. | `filter` (선택) [`TableFilter`](#show-tablefilter) — 검색 조건 (기본값: 전체 표) | 조건에 맞는 표 목록<br>[`Table`](#show-table) 목록 |
2304
+ | `findCharts` | 조건에 맞는 차트 배열을 반환한다. | `filter` (선택) [`ChartFilter`](#show-chartfilter) — 검색 조건 (기본값: 전체 차트) | [`Chart`](#show-chart) 목록 |
2305
+ | `getComments` | 슬라이드의 최상위 댓글(답글 제외) 목록을 반환한다. | — | 댓글 목록<br>[`Comment`](#show-comment) 목록 |
2306
+ | `getPrevComment` | UI의 메모 탐색 기준으로 이전 최상위 댓글을 반환한다. | `commentProxy` [`Comment`](#show-comment) — 기준 최상위 댓글 | 이전 댓글 (없으면 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
2307
+ | `getNextComment` | UI의 메모 탐색 기준으로 다음 최상위 댓글을 반환한다. | `commentProxy` [`Comment`](#show-comment) — 기준 최상위 댓글 | 다음 댓글 (없으면 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
2308
+ | `findComments` | 조건에 맞는 댓글을 검색한다. | `filter` (선택) [`CommentFilter`](#show-commentfilter) — 검색 조건 (기본값: 전체 댓글) | 조건에 맞는 댓글 목록<br>[`Comment`](#show-comment) 목록 |
2309
+ | `findText` | 이 슬라이드에서 텍스트를 검색한다. 매치는 도형 → 표 셀 순서로 반환된다.<br>병합으로 숨겨진 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 검색되지 않는다. | `query` 문자열 — 찾을 텍스트<br>`caseSensitive` (선택) 참/거짓 — 대소문자 구분 (기본값: false) | 매치 목록. target 은 표 셀 매치면 TableCell, 아니면 도형 프록시(Shape)이며, range(글자 offset, to 포함)를 그대로 서식 API 에 넘겨 매치 구간만 편집할 수 있다 (예: `m.target.setBold(true, m.range)`). text 는 검색 시점의 매치 텍스트다.<br>`{ target: (TableCell \| Shape); range: TextRange; text: string }[]` |
2310
+ | `getSlideNoteText` | 슬라이드 노트의 텍스트를 plain text 로 반환한다.<br>노트 슬라이드가 없으면 생성하지 않고 빈 문자열을 반환한다. | — | 노트 텍스트. 대상 슬라이드가 없으면 null<br>문자열 (없을 수 있음) |
2311
+ | `getBackgroundFill` | 슬라이드에 명시적으로 설정된 배경 채우기를 반환한다. (setSolidFill/setGradientFill/setImageFill/setPatternFill 대칭)<br>레이아웃/마스터 상속 배경은 포함하지 않으며, 슬라이드 자체 배경이 없으면 `{ type: "none" }`. | — | 배경 채우기 정보. 대상 슬라이드가 없으면 null<br>[`Fill`](#show-fill) (없을 수 있음) |
2312
+ | `getLayoutType` | 슬라이드에 적용된 레이아웃 종류를 반환한다. (setLayout 대칭) | — | 레이아웃 종류. 없으면 null<br>[`SlideLayoutType`](#show-slidelayouttype) (없을 수 있음) |
2313
+ | `getTransition` | 슬라이드 전환 효과를 setTransition 의 평면 입력 형태로 반환한다. (setTransition 대칭)<br>표준 효과는 완전 대칭이나, 한쇼 확장 저장 케이스(대각선 wipe/strips 는 wipeout,<br>plus 안쪽은 fourboxwipe)는 부분 복원된다: wipeout 은 type=strips 로 되돌아가며(대각선 wipe 와 strips 는<br>동일 애니메이션이라 strips 로 통일), dur/spokes 등 setTransition 입력이 아닌 값은 반환하지 않는다. | — | 전환 효과 설정. 효과가 없거나 대상 슬라이드가 없으면 null<br>[`Transition`](#show-transition) (없을 수 있음) |
2314
+ | `isHidden` | 슬라이드 숨김 여부를 반환한다. | — | 숨김 슬라이드면 true. 대상 슬라이드가 없으면 null<br>`boolean \| null` |
2315
+ | `isShowMasterShapes` | 마스터(레이아웃)의 배경 도형 표시 여부를 반환한다.<br>이 슬라이드에 설정된 값 기준이다. | — | 마스터 도형이 표시 중이면 true. 대상 슬라이드가 없으면 null<br>`boolean \| null` |
2316
+ | `isSlideNumberVisible` | 슬라이드 번호 표시 여부를 반환한다. | — | 슬라이드 번호가 표시 중이면 true. 대상 슬라이드가 없으면 null<br>`boolean \| null` |
2317
+ | `getDate` | 날짜 머리글/바닥글 설정을 반환한다. (setDate 대칭)<br>자동갱신 날짜는 { format, language }, 고정 텍스트 날짜는 { text } 로 반환한다. | — | 날짜 설정. 날짜 머리글/바닥글이 없거나 대상 슬라이드가 없으면 null. DateFormat/DateLanguage 밖의 파일 저장값은 해당 필드를 생략한다<br>[`HeaderFooterDate`](#show-headerfooterdate) (없을 수 있음) |
2318
+ | `getFooter` | 바닥글 텍스트를 반환한다. | — | 바닥글 텍스트. 바닥글이 없거나 대상 슬라이드가 없으면 null<br>문자열 (없을 수 있음) |
2319
+ | `getColorScheme` | 이 슬라이드에 적용된 색상 테마를 반환한다.<br>슬라이드 재정의가 없으면 마스터(문서) 테마가 반환된다. | — | 색상 테마 (prst: doc.getColorSchemeList() 에 있는 테마일 때만 채워짐, name: 표시 이름, colors: 슬롯 이름 → #RRGGBB). 대상 슬라이드가 없으면 null<br>`{ prst: string \| null; name: string; colors: Record<string, unknown> } \| null` |
2320
+ | `replaceText` | 이 슬라이드에서 검색 텍스트를 찾아 모두 새 텍스트로 바꾼다. (모두 바꾸기)<br>병합으로 숨겨진 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 바뀌지 않는다.<br>협업 잠금 등으로 편집할 수 없는 텍스트의 매치도 바꾸지 않고 skippedCount 로 반환한다. | `query` 문자열 — 찾을 텍스트<br>`replacement` (선택) 문자열 — 바꿀 텍스트. 빈 문자열이면 매치를 삭제한다 (기본값: "")<br>`caseSensitive` (선택) 참/거짓 — 대소문자 구분 (기본값: false) | 치환한 매치 수 / 제외한 매치 수<br>`{ replacedCount: number; skippedCount: number }` |
2321
+ | `insertShape` | 도형을 삽입한다. | `presetId` (선택) [`ShapePreset`](#common-shapepreset) — 도형 프리셋 ID (ShapePreset enum 참조) (기본값: ShapePreset.RECT)<br>`transform` (선택) `{ x?: number; y?: number; width?: number; height?: number; angle?: number }` — 위치/크기 (px 단위) (기본값: 슬라이드 중앙, 기본 크기)<br> · `x` X 좌표 (px) (기본값: 가로 중앙)<br> · `y` Y 좌표 (px) (기본값: 세로 중앙)<br> · `width` 너비 (px) (기본값: 프리셋 기본 크기)<br> · `height` 높이 (px) (기본값: 프리셋 기본 크기)<br> · `angle` 회전 각도 (degree) (기본값: 0) | 삽입된 도형<br>`Shape \| Line` |
2322
+ | `insertTextBox` | 글상자(텍스트박스)를 삽입한다. 삽입 후 반환된 프록시의 setText/insertText 로 텍스트를 넣는다. | `transform` (선택) `{ x?: number; y?: number; width?: number; height?: number; angle?: number }` — 위치/크기 (px 단위) (기본값: 슬라이드 중앙, 기본 크기)<br> · `x` X 좌표 (px) (기본값: 가로 중앙)<br> · `y` Y 좌표 (px) (기본값: 세로 중앙)<br> · `width` 너비 (px) (기본값: 기본 크기)<br> · `height` 높이 (px) (기본값: 기본 크기)<br> · `angle` 회전 각도 (degree) (기본값: 0) | [`Shape`](#show-shape) |
2323
+ | `insertTable` | 표를 삽입한다. | `rowNum` 숫자 — 행 수<br>`colNum` 숫자 — 열 수<br>`styleName` (선택) 문자열 — 표 스타일 이름 (doc.getTableStyleNames() 결과). 목록에 없는 이름이면 throw (기본값: 문서 기본 스타일) | 삽입된 표<br>[`Table`](#show-table) |
2324
+ | `insertImage` | 웹 이미지를 삽입한다. | `url` 문자열 — 이미지 URL | 삽입된 이미지 도형 Proxy<br>[`Image`](#show-image) |
2325
+ | `insertWebVideo` | 웹 동영상(YouTube / 3DS)을 삽입한다. | `url` 문자열 — 웹 동영상 URL (YouTube watch/embed/shorts/youtu.be, 3DS media) | 삽입된 웹 동영상 도형 Proxy<br>[`Image`](#show-image) |
2326
+ | `saveAsPicture` | 슬라이드의 도형들을 하나의 이미지로 저장한다. (기존 UI 동작과 동일) | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 이미지로 저장할 도형 Proxy 배열 | — |
2327
+ | `groupShapes` | 여러 도형을 하나의 그룹으로 묶는다.<br>묶인 도형은 그룹의 자식으로 다시 만들어지므로 넘긴 프록시는 더 이상 유효하지 않다.<br>자식은 반환된 그룹의 getChildren() 으로 다시 얻는다. | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 그룹화할 도형 Proxy 배열 (서로 다른 도형 2개 미만이면 throw) | 생성된 그룹 도형 (실패 시 null)<br>[`Group`](#show-group) (없을 수 있음) |
2328
+ | `ungroupShapes` | 그룹을 해제해 자식 도형으로 분리한다.<br>분리된 자식은 새 도형으로 다시 만들어지므로 해제 전에 얻어 둔 자식 프록시는 더 이상 유효하지 않다.<br>분리된 도형은 반환값으로 받는다. | `shapeProxy` [`Group`](#show-group) — 그룹 해제할 그룹 도형 Proxy | 분리된 자식 도형 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2329
+ | `deleteShape` | 도형 하나를 삭제한다. | `shapeProxy` `Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control` — 삭제할 도형 Proxy | — |
2330
+ | `deleteShapes` | 여러 도형을 일괄 삭제한다. | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 삭제할 도형 Proxy 배열 | — |
2331
+ | `duplicateShape` | 도형을 복제한다. 차트는 복제할 수 없어 null을 반환한다. | `shapeProxy` `Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control` — 복제할 도형 Proxy | 새로 생성된 도형 Proxy<br>`Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control \| null` |
2332
+ | `duplicateShapes` | 도형을 복제한다. 차트는 복제할 수 없어 결과에서 제외된다. | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 복제할 도형 Proxy 배열 | 새로 생성된 도형 Proxy 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2333
+ | `distributeShapes` | 여러 도형을 균등하게 분배(distribute) 한다.<br>bbox 중심 기준으로 정렬한 뒤, 양 끝 도형 사이 간격이 모두 같아지도록 재배치한다. (2개 미만이면 변경 없음) | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 분배할 도형 Proxy 배열<br>`direction` [`DistributeDirection`](#show-distributedirection) — 분배 방향 | — |
2334
+ | `hide` | 이 슬라이드의 숨김 상태를 설정한다. | `isHidden` 참/거짓 — true: 슬라이드 숨김, false: 슬라이드 표시 | — |
2335
+ | `setLayout` | 슬라이드에 레이아웃을 적용한다.<br>같은 type 이 여럿이면 마스터 순서상 첫 번째 레이아웃이 선택된다. | `layoutType` [`SlideLayoutType`](#show-slidelayouttype) — 레이아웃 종류. doc.getLayoutList(slide) 로 사용 가능한 type 확인 | 적용 여부 (해당 type 이 이 슬라이드의 마스터에 없으면 false)<br>참/거짓 |
2336
+ | `resetLayout` | 슬라이드 레이아웃을 초기화한다. | — | — |
2337
+ | `resetBackground` | 슬라이드 배경을 초기화한다. | — | — |
2338
+ | `setShowMasterShapes` | 마스터(레이아웃)의 배경 도형 표시 여부를 설정한다. | `show` 참/거짓 — true: 마스터 도형 표시, false: 숨김 | — |
2339
+ | `setSolidFill` | 슬라이드 배경을 단색으로 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명) (기본값: 기존 값 유지) | — |
2340
+ | `setGradientFill` | 슬라이드 배경을 그라데이션으로 설정한다.<br><br><b>예제</b><pre><code>slide.setGradientFill("lin", [{ color: "#FF0000" }, { color: "#0000FF" }], 90);</code></pre> | `type` (선택) [`GradientType`](#show-gradienttype) — 그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR)<br>`stops` (선택) `{ color: string; pos?: number; alpha?: number }[]` — 색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])<br>`angle` (선택) 숫자 — 그라데이션 각도 (lin 일 때만 사용) (기본값: 45) | — |
2341
+ | `setImageFill` | 슬라이드 배경을 이미지로 설정한다. | `imageUrl` 문자열 — 이미지 URL<br>`fillMode` (선택) [`ImageFillMode`](#show-imagefillmode) — 이미지 채우기 방식 (기본값: ImageFillMode.STRETCH)<br>`alpha` (선택) 숫자 — 투명도 (0~100) (기본값: 0(불투명))<br>`detail` (선택) [`ImageFillDetail`](#show-imagefilldetail) — 세부 옵션. offset/scale/mirror/align 은 fillMode=ImageFillMode.TILE 일 때만 반영 (기본값: {}) | 이미지 업로드 후 배경 적용이 끝나면 resolve. 업로드 실패 시 EXECUTION_ERROR 로 reject<br>— |
2342
+ | `removeFill` | 슬라이드 배경 채우기를 제거한다. | — | — |
2343
+ | `setPatternFill` | 슬라이드 배경을 패턴(무늬)으로 설정한다. (getBackgroundFill 왕복 대칭 — setFill 의 pattern 경로) | `preset` [`PatternPreset`](#show-patternpreset) — 무늬 프리셋 (apiConstants.PatternPreset)<br>`foreColor` (선택) 문자열 — 전경색 hex (#RRGGBB) 또는 scheme color (기본값: accent1(테마 강조색1))<br>`backColor` (선택) 문자열 — 배경색 hex (#RRGGBB) 또는 scheme color (기본값: bg1(테마 배경색1))<br>`foreAlpha` (선택) 숫자 — 전경색 투명도 (0~100) (기본값: 0(불투명))<br>`backAlpha` (선택) 숫자 — 배경색 투명도 (0~100) (기본값: 0(불투명)) | — |
2344
+ | `setFill` | getBackgroundFill() 이 반환한 채우기 객체를 그대로 슬라이드 배경에 적용한다. (getBackgroundFill 대칭)<br>type 으로 분기해 대응 setter 를 호출한다. image 는 readback 의 embed 를 재사용해 같은 문서 안에서 복원한다.<br>embed 가 없는 image 입력은 무시된다(새 이미지는 개별 setImageFill 사용). | `fill` (선택) [`Fill`](#show-fill) — getBackgroundFill() 반환값 | — |
2345
+ | `insertComment` | 댓글을 추가한다. | `text` 문자열 — 댓글 텍스트 | 생성된 댓글 (실패 시 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
2346
+ | `replyComment` | 댓글에 답글을 추가한다. | `commentProxy` [`Comment`](#show-comment) — 부모 댓글<br>`text` 문자열 — 답글 텍스트 | 생성된 답글<br>[`Comment`](#show-comment) (없을 수 있음) |
2347
+ | `deleteComment` | 댓글 하나를 삭제한다. 부모 댓글이면 그 답글도 함께 삭제된다. | `commentProxy` [`Comment`](#show-comment) — 삭제할 댓글 | — |
2348
+ | `deleteComments` | 여러 댓글을 일괄 삭제한다. 부모 댓글이 포함되면 그 답글도 함께 삭제된다. (UI 동작과 일치) | `commentProxyList` [`Comment`](#show-comment) 목록 — 삭제할 댓글 배열 | — |
2349
+ | `setTransition` | 슬라이드 전환 효과를 설정한다. 평면 입력을 모델 포맷으로 변환해 적용한다.<br>효과가 지원하는 옵션만 반영되며, 주지 않은 값은 기본 모델에서 채운다.<br>효과 제거는 type 으로 하지 않고 removeTransition() 을 사용한다. | `transition` [`Transition`](#show-transition) — 전환 효과 설정 | — |
2350
+ | `removeTransition` | 전환 효과를 제거한다. | — | — |
2351
+ | `previewTransition` | 이 슬라이드에 설정된 전환 효과 미리보기를 화면에서 재생한다.<br>미리보기는 현재 보고 있는 슬라이드에서만 동작하므로, 이 슬라이드가 현재 슬라이드가<br>아니면 재생하지 않고 예외를 던진다. 다른 슬라이드는 먼저 goToSlide 로 이동한 뒤 호출한다.<br>문서를 변경하지 않는 표시용 동작이다. | `autoPreview` (선택) 참/거짓 — 지정하면 재생 대신 '자동 미리보기 설정'을 on/off 로 토글한다 (전환 효과 설정 시 자동으로 미리보기를 재생할지 여부, 앱 전역 설정) (기본값: 없음(즉시 미리보기 재생)) | — |
2352
+ | `setDate` | 이 슬라이드의 날짜 머리글/바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `date` (선택) [`HeaderFooterDate`](#show-headerfooterdate) — 날짜 설정 (기본값: 자동갱신 날짜) | — |
2353
+ | `removeDate` | 이 슬라이드의 날짜 머리글/바닥글을 제거한다. | — | — |
2354
+ | `setSlideNumber` | 이 슬라이드에 슬라이드 번호를 표시한다. | — | — |
2355
+ | `removeSlideNumber` | 이 슬라이드의 슬라이드 번호를 제거한다. | — | — |
2356
+ | `setFooter` | 이 슬라이드의 바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `text` 문자열 — 바닥글 텍스트 | — |
2357
+ | `removeFooter` | 이 슬라이드의 바닥글을 제거한다. | — | — |
2358
+ | `setSlideNoteText` | 슬라이드 노트 텍스트를 설정한다. (기존 노트 내용은 대체됨) | `text` 문자열 — 노트 텍스트 | — |
2359
+ | `appendSlideNoteText` | 슬라이드 노트 끝에 텍스트를 이어 붙인다. | `text` 문자열 — 추가할 노트 텍스트 | — |
2360
+
2361
+ <a id="show-basepathshape"></a>
2362
+ ### BasePathShape — 도형 (패스) (`BasePathShape`)
2363
+
2364
+ 채우기·선·효과를 지원하는 도형들의 공통 API 로, 채우기(setSolidFill/setGradientFill/setImageFill 등),
2365
+ 선 서식(setLineColor/setLineWidth/setLineDash 등),
2366
+ 그림자·네온·부드러운 가장자리·반사 효과(setOuterShadow/setGlow/setSoftEdge 등),
2367
+ 3D 서식(set3d/remove3d)을 제공한다.
2368
+ 대상 도형이 없으면(협업 중 삭제 등) getter 는 null 을 반환하고 setter 는 SHAPE_NOT_FOUND 로 실패한다.
2369
+
2370
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2371
+
2372
+ | 기능 | 설명 | 입력 | 결과 |
2373
+ |---|---|---|---|
2374
+ | `getFill` | 도형 채우기를 반환한다. (setFill 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>type 별 개별 setter 는 setSolidFill/setGradientFill/setImageFill/setPatternFill/removeFill 이다. | — | 채우기 정보. noFill 이면 `{ type: FillType.NONE }`, 대상 도형이 없으면(협업 중 삭제 등) null<br>[`Fill`](#show-fill) (없을 수 있음) |
2375
+ | `getLineStyle` | 선 스타일을 반환한다. (setLineStyle 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>개별 setter 는 setLineColor/setLineGradient/setLineWidth/setLineDash/setLineCap/setLineJoin 이다.<br><br>선 채우기는 getFill 과 같은 형태로 담는다. | — | 선 스타일. 대상 도형이 없으면 null<br>[`LineStyle`](#show-linestyle) (없을 수 있음) |
2376
+ | `getLineColor` | 선 색상을 반환한다. (setLineColor 대칭. 투명도까지 필요하면 getLineStyle 사용) | — | 선 색상 (hex "#RRGGBB" — scheme color 도 hex 로 풀려서 나온다). 선이 없거나 대상 도형이 없으면 null<br>문자열 (없을 수 있음) |
2377
+ | `getLineWidth` | 선 두께(pt)를 반환한다. (setLineWidth 대칭) | — | 선 두께 (pt). 선 없음(noFill)이어도 두께는 그대로 반환한다. 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2378
+ | `getLineDash` | 선 대시 유형을 반환한다. (setLineDash 대칭) | — | 선 대시 유형. LineDash enum 이 아니거나 대상 도형이 없으면 null<br>[`LineDash`](#common-linedash) (없을 수 있음) |
2379
+ | `getLineCap` | 선 끝 모양(cap)을 반환한다. (setLineCap 대칭) | — | 선 끝 모양. 설정이 없거나 대상 도형이 없으면 null<br>[`LineCap`](#show-linecap) (없을 수 있음) |
2380
+ | `getLineJoin` | 선 연결 유형(join)을 반환한다. (setLineJoin 대칭) | — | 선 연결(모서리) 유형. 설정이 없거나 대상 도형이 없으면 null<br>[`LineJoin`](#show-linejoin) (없을 수 있음) |
2381
+ | `getEffects` | 도형에 적용된 효과를 반환한다. 적용된 효과만 키로 포함된다.<br>각 값은 대응 setter(setOuterShadow/setInnerShadow/setGlow/setSoftEdge/setReflection/set3d) 의 인자와 같은 형태다.<br>그림자·네온의 alpha 는 불투명(0)이어도 항상 포함되고, 길이(pt)·비율(%)은 소수 첫째 자리로 반올림된다.<br>outerShadow·innerShadow 가 함께 실린 문서면 둘 다 담는다 (setter 로는 하나만 넣을 수 있다). | — | 효과 정보. 적용된 효과가 없으면 빈 객체 `{}`, 대상 도형이 없으면(협업 중 삭제 등) null<br>[`Effects`](#show-effects) (없을 수 있음) |
2382
+ | `setSolidFill` | 도형 채우기를 단색으로 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지) | — |
2383
+ | `setGradientFill` | 그라데이션 채우기를 설정한다.<br><br><b>예제</b><pre><code>shape.setGradientFill("lin", [{ color: "#FF0000" }, { color: "#0000FF" }], 90);</code></pre> | `type` (선택) [`GradientType`](#show-gradienttype) — 그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR)<br>`stops` (선택) `{ color: string; pos?: number; alpha?: number }[]` — 색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100, 0=불투명) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])<br>`angle` (선택) 숫자 — 그라데이션 각도 (lin 일 때만 사용) (기본값: 45) | — |
2384
+ | `setImageFill` | 이미지 채우기를 설정한다.<br><br><b>예제</b><pre><code>shape.setImageFill(url, ImageFillMode.TILE, 0, { scale: { x: 50, y: 50 }, mirror: "x", align: "tl", rotateWithShape: true });</code></pre> | `imageUrl` 문자열 — 이미지 URL<br>`fillMode` (선택) [`ImageFillMode`](#show-imagefillmode) — 이미지 채우기 방식 (기본값: ImageFillMode.STRETCH)<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명) (기본값: 0)<br>`detail` (선택) [`ImageFillDetail`](#show-imagefilldetail) — 세부 옵션. offset/scale/mirror/align 은 fillMode=ImageFillMode.TILE 일 때만 반영 (기본값: {}) | 이미지 업로드 후 채우기 적용이 끝나면 resolve. 대상 도형이 없으면(업로드 중 삭제 포함) SHAPE_NOT_FOUND 로, 업로드 실패 시 EXECUTION_ERROR 로 reject<br>— |
2385
+ | `removeFill` | 채우기를 제거한다 (noFill). | — | — |
2386
+ | `setPatternFill` | 패턴(무늬) 채우기를 설정한다. (getFill 왕복 대칭) | `preset` [`PatternPreset`](#show-patternpreset) — 무늬 프리셋 (apiConstants.PatternPreset)<br>`foreColor` (선택) 문자열 — 전경색 hex (#RRGGBB) 또는 scheme color (기본은 테마 강조색1) (기본값: "accent1")<br>`backColor` (선택) 문자열 — 배경색 hex (#RRGGBB) 또는 scheme color (기본은 테마 배경색1) (기본값: "bg1")<br>`foreAlpha` (선택) 숫자 — 전경색 투명도 (0~100, 0=불투명) (기본값: 0)<br>`backAlpha` (선택) 숫자 — 배경색 투명도 (0~100, 0=불투명) (기본값: 0) | — |
2387
+ | `setFill` | getFill() 이 반환한 채우기 객체를 그대로 적용한다. (getFill 대칭 — 도형→도형 채우기 복사)<br>image 는 조회 결과의 embed 를 재사용하므로 같은 문서 안에서만 복원된다.<br>embed 없는 image 는 적용할 그림이 없어 거부한다 (새 이미지는 setImageFill). | `fill` (선택) [`Fill`](#show-fill) — getFill() 반환값. 생략하면 아무것도 변경하지 않는다 | — |
2388
+ | `setLineColor` | 선 색상을 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지) | — |
2389
+ | `setLineGradient` | 선(테두리) 그라데이션 채우기를 설정한다.<br><br><b>예제</b><pre><code>shape.setLineGradient("lin", [{ color: "#FF0000" }, { color: "#0000FF" }], 90);</code></pre> | `type` (선택) [`GradientType`](#show-gradienttype) — 그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR)<br>`stops` (선택) `{ color: string; pos?: number; alpha?: number }[]` — 색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100, 0=불투명) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])<br>`angle` (선택) 숫자 — 그라데이션 각도 (lin 일 때만 사용) (기본값: 45) | — |
2390
+ | `removeLineColor` | 선 색상을 제거한다 (noFill). | — | — |
2391
+ | `setLineWidth` | 선 두께를 설정한다. | `lineWidth` 숫자 — 선 두께 (pt 단위) | — |
2392
+ | `setLineDash` | 선 스타일(대시)을 설정한다. | `lineDash` [`LineDash`](#common-linedash) — 선 대시 스타일 | — |
2393
+ | `setLineCap` | 선 끝 모양(cap)을 설정한다. | `lineCap` [`LineCap`](#show-linecap) — 선 끝 모양 | — |
2394
+ | `setLineJoin` | 선 연결 유형(join)을 설정한다. | `lineJoin` [`LineJoin`](#show-linejoin) — 선 연결(모서리) 유형 | — |
2395
+ | `setLineStyle` | getLineStyle() 이 반환한 선 스타일 객체를 그대로 적용한다. (getLineStyle 대칭 — 도형→도형 선 복사) | `style` (선택) [`LineStyle`](#show-linestyle) — getLineStyle() 반환값. 생략하면 아무것도 변경하지 않는다 | — |
2396
+ | `setOuterShadow` | 외부 그림자를 적용한다. (getEffects().outerShadow 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 OuterShadow 참조).<br>도형이 갖는 그림자는 하나다 - 내부 그림자가 걸려 있으면 외부 그림자로 바뀐다. | `shadow` (선택) [`OuterShadow`](#show-outershadow) — 그림자 설정 | — |
2397
+ | `setInnerShadow` | 내부 그림자를 적용한다. (getEffects().innerShadow 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 InnerShadow 참조).<br>도형이 갖는 그림자는 하나다 - 외부 그림자가 걸려 있으면 내부 그림자로 바뀐다. | `shadow` (선택) [`InnerShadow`](#show-innershadow) — 그림자 설정 | — |
2398
+ | `setGlow` | 네온(광선) 효과를 적용한다. (getEffects().glow 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 Glow 참조). | `glow` (선택) [`Glow`](#show-glow) — 네온(광선) 설정 | — |
2399
+ | `setSoftEdge` | 옅은 테두리(softEdge) 효과를 적용한다. (getEffects().softEdge 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 SoftEdge 참조). | `softEdge` (선택) [`SoftEdge`](#show-softedge) — 옅은 테두리 설정 | — |
2400
+ | `setReflection` | 반사 효과를 적용한다. (getEffects().reflection 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 Reflection 참조). | `reflection` (선택) [`Reflection`](#show-reflection) — 반사 설정 | — |
2401
+ | `removeEffect` | 효과를 제거한다. 그 효과가 걸려 있지 않으면 아무 일도 하지 않는다.<br>도형이 직접 가진 효과만 제거한다 - 도형 스타일(effectRef)에서 상속받은 효과는 제거할 수 없어,<br>getEffects() 가 돌려주는데도 아무 일도 하지 않는 경우가 있다. | `effectType` [`EffectType`](#show-effecttype) — 제거할 효과 타입 | — |
2402
+ | `set3d` | 도형에 3D 효과를 적용한다. scene3d 와 sp3d 중 비어 있는 인자는 적용하지 않는다. | `scene3d` (선택) [`Scene3d`](#show-scene3d) — 카메라(회전) 설정. 생략하면 적용하지 않음<br>`sp3d` (선택) [`Sp3d`](#show-sp3d) — 입체(깊이) 설정. 생략하면 적용하지 않음 | — |
2403
+ | `remove3d` | 도형의 3D 효과를 제거한다. | — | — |
2404
+ | `setEffects` | getEffects() 가 반환한 효과 객체를 그대로 적용한다. (getEffects 대칭 — 도형→도형 효과 복사)<br>포함된 효과 키만 대응 setter 로 적용한다. scene3d/sp3d 는 set3d 로 함께 넘긴다.<br>대상의 기존 효과를 지우지는 않는다 - 완전 복사하려면 removeEffect/remove3d 로 먼저 제거한 뒤 적용한다.<br>outerShadow 와 innerShadow 를 함께 넘기면 거부하지 않고 outerShadow → innerShadow 순서로 적용해 항상 innerShadow 가 남는다. | `effects` (선택) [`Effects`](#show-effects) — getEffects() 반환값. 생략하면 아무것도 변경하지 않는다 | — |
2405
+
2406
+ <a id="show-baseshape"></a>
2407
+ ### BaseShape — 도형 공통 (`BaseShape`)
2408
+
2409
+ 모든 도형 종류가 공유하는 공통 API 로, 위치·크기·회전 조회와 변경(getTransform/moveBy/setRotation 등),
2410
+ 정렬·순서·뒤집기(align/reorder/flip), 하이퍼링크(getHyperlink/setHyperlink/removeHyperlink),
2411
+ 도형 종류 판별 가드(isShape/isImage/isChart 등)를 제공한다.
2412
+ 대상 도형이 없으면(협업 중 삭제 등) getter 는 null 을 반환하고 setter 는 SHAPE_NOT_FOUND 로 실패한다.
2413
+
2414
+ 프록시는 (슬라이드 id, 도형 id) 를 담은 값 핸들이라 조회할 때마다 새 인스턴스가 온다.
2415
+ 같은 도형을 가리키는지 === 로 비교하거나 Set/Map 의 키로 쓸 수 없다.
2416
+
2417
+ | 기능 | 설명 | 입력 | 결과 |
2418
+ |---|---|---|---|
2419
+ | `isShape` | 이 핸들이 `Shape` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Shape` |
2420
+ | `isImage` | 이 핸들이 `Image` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Image` |
2421
+ | `isLine` | 이 핸들이 `Line` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Line` |
2422
+ | `isGroup` | 이 핸들이 `Group` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Group` |
2423
+ | `isChart` | 이 핸들이 `Chart` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Chart` |
2424
+ | `isTable` | 이 핸들이 `Table` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Table` |
2425
+ | `isDiagram` | 이 핸들이 `Diagram` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Diagram` |
2426
+ | `isOleObject` | 이 핸들이 `OleObject` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is OleObject` |
2427
+ | `isControl` | 이 핸들이 `Control` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Control` |
2428
+ | `getTransform` | 도형의 위치, 크기, 회전 정보를 반환한다.<br>x/y 는 반전(flip) 여부와 무관하게 도형의 좌상단이라, 반환값을 다른 도형의 setTransform 에 그대로 넘기면<br>두 도형이 같은 자리에 놓인다.<br>값은 에디터 입력 단위로 반올림해 반환한다 - 크기는 소수 한 자리, 위치는 정수.<br>setter 도 같은 단위로 넣으므로, 임포트 문서처럼 더 잘게 놓인 도형은 되넘길 때 그만큼 움직인다. | — | 도형의 위치·크기·회전 정보. 대상 도형이 없으면(협업 중 삭제 등) null<br>[`ShapeTransform`](#show-shapetransform) (없을 수 있음) |
2429
+ | `getWidth` | 도형의 너비를 반환한다. (setWidth 대칭) | — | 너비 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2430
+ | `getHeight` | 도형의 높이를 반환한다. (setHeight 대칭) | — | 높이 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2431
+ | `getX` | 도형의 X 좌표를 반환한다. (setX 대칭) | — | X 좌표 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2432
+ | `getY` | 도형의 Y 좌표를 반환한다. (setY 대칭) | — | Y 좌표 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2433
+ | `getRotation` | 도형의 회전 각도를 반환한다. (setRotation 대칭) | — | 회전 각도 (degree). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2434
+ | `getPresetId` | 도형의 OOXML preset id (prst) 를 반환한다. | — | preset id (prst), 없으면 null<br>문자열 (없을 수 있음) |
2435
+ | `isPlaceholder` | 도형이 placeholder(제목 · 본문 틀 등)인지 반환한다. | — | placeholder 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2436
+ | `getPlaceholderType` | 도형의 placeholder 종류를 반환한다. | — | placeholder 종류. placeholder 가 아니거나 대상 도형이 없으면 null<br>[`PlaceholderType`](#show-placeholdertype) (없을 수 있음) |
2437
+ | `hasText` | 도형이 텍스트를 담고 있는지 반환한다. 에디터가 텍스트를 비었다고 보는 기준과 같다 —<br>공백만 있거나 빈 문단이 둘 이상(개행만 넣은 상태)이면 true, 빈 문단 하나뿐이면 false 다.<br>도형 레벨 텍스트가 없는 종류(표·그룹·차트)는 항상 false 다. (표는 셀 단위로 조회) | — | 텍스트 존재 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2438
+ | `getZOrderIndex` | 부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다. 0 이 맨 뒤이며, 클수록 앞이다. | — | z-order 순번. 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2439
+ | `isFlippedH` | 도형이 좌우로 반전된 상태인지 반환한다. (flip(FlipDirection.HORIZONTAL) 을 호출하면 이 값이 뒤집힌다) | — | 좌우 반전 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2440
+ | `isFlippedV` | 도형이 상하로 반전된 상태인지 반환한다. (flip(FlipDirection.VERTICAL) 을 호출하면 이 값이 뒤집힌다) | — | 상하 반전 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2441
+ | `getHyperlink` | 도형에 설정된 하이퍼링크를 반환한다. 반환 객체를 그대로 setHyperlink 에 넘길 수 있다.<br>지원하지 않는 종류(프로그램 실행·매크로 등)가 걸려 있으면 null 이다. | — | 하이퍼링크 정보. 하이퍼링크(action)가 없으면 null<br>[`Hyperlink`](#show-hyperlink) (없을 수 있음) |
2442
+ | `setWidth` | 도형의 너비를 설정한다. 크기 조정이 불가능한 도형이면 무시된다. | `width` 숫자 — 너비 (px 단위, 소수 한 자리로 반올림) | — |
2443
+ | `setHeight` | 도형의 높이를 설정한다. 크기 조정이 불가능한 도형이면 무시된다. | `height` 숫자 — 높이 (px 단위, 소수 한 자리로 반올림) | — |
2444
+ | `setX` | 도형의 X 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. (상대 이동은 moveBy) | `x` 숫자 — X 좌표 (px 단위, 정수로 반올림) | — |
2445
+ | `setY` | 도형의 Y 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. | `y` 숫자 — Y 좌표 (px 단위, 정수로 반올림) | — |
2446
+ | `moveBy` | 도형을 현재 위치 기준으로 x, y 만큼 상대 이동한다. (절대 좌표 설정은 setX / setY) | `distance` [`ShapeMoveDistance`](#show-shapemovedistance) — 이동량 (px 단위) | — |
2447
+ | `setRotation` | 도형의 회전 각도를 절대값으로 설정한다. 회전이 불가능한 도형이면 무시된다. (getRotation 대칭) | `rotation` 숫자 — 회전 각도 (degree) | — |
2448
+ | `setTransform` | 도형의 위치·크기·회전을 한 번에 설정한다. getTransform() 반환값을 그대로 넘길 수 있다. (getTransform 대칭)<br>값을 준 필드만 크기→위치→회전 순으로 적용하고, 생략한 필드는 현재 값을 유지한다.<br>각 필드는 개별 setter 와 같이 해당 조작(크기/이동/회전)이 불가능한 도형에서 무시된다. | `transform` (선택) `Partial<ShapeTransform>` — 위치/크기 (px) · 회전 (degree) | — |
2449
+ | `flip` | 도형을 상하 또는 좌우로 반전한다. 현재 반전 상태를 뒤집는 토글이며, 지금 반전돼 있는지는<br>isFlippedH()/isFlippedV() 로 읽는다. 회전이 불가능한 도형에서는 반전도 무시된다.<br>회전된 도형은 각도도 거울상으로 함께 바뀐다 (getRotation() 값이 360 - 기존 각도 로 바뀐다). | `direction` [`FlipDirection`](#show-flipdirection) — 반전 방향 | — |
2450
+ | `reorder` | 도형의 정렬 순서(앞으로/뒤로)를 변경한다. 이미 목표 위치라 바뀔 것이 없으면 무시된다. | `order` [`ShapeZOrder`](#common-shapezorder) — 순서 변경 타입 | — |
2451
+ | `align` | 도형을 슬라이드 기준으로 정렬한다. 이동이 불가능한 도형이면 무시된다.<br>그룹 자식도 그룹 안이 아니라 슬라이드를 기준으로 움직인다(에디터와 같다).<br>자식이 그룹 밖으로 나가면 그룹이 자식을 담도록 함께 넓어진다. | `alignType` [`AlignType`](#show-aligntype) — 정렬 타입 | — |
2452
+ | `setHyperlink` | 도형에 하이퍼링크를 설정한다. (getHyperlink 대칭 — 반환 객체를 그대로 넘겨 하이퍼링크를 복사할 수 있다)<br>지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다. | `hyperlink` [`Hyperlink`](#show-hyperlink) — getHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다 | — |
2453
+ | `removeHyperlink` | 도형의 하이퍼링크를 제거한다. | — | — |
2454
+
2455
+ <a id="show-chart"></a>
2456
+ ### Chart — 차트 (`Chart`)
2457
+
2458
+ 차트 도형을 다루는 핸들로, 차트 종류·스타일(setType/setStyle), 제목·축 제목(setTitle/setAxisTitle),
2459
+ 범례·데이터 라벨 위치(setLegendPosition/setDataLabelPosition), 눈금선(setGridLine) 편집과
2460
+ 현재 서식 상태 조회(getType/getTitle/getChartInfo 등)를 제공한다.
2461
+
2462
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2463
+
2464
+ | 기능 | 설명 | 입력 | 결과 |
2465
+ |---|---|---|---|
2466
+ | `getType` | 차트 종류를 반환한다. ChartType 에 없는 종류는 "unknown" 을 반환한다. | — | 문자열 |
2467
+ | `isEditable` | 이 차트를 편집할 수 있는지 반환한다. 외부 데이터를 소스로 하는 차트는 조회만 되고 편집은 되지 않는다. | — | 참/거짓 |
2468
+ | `getTitle` | 차트 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열을 반환한다. | — | 문자열 |
2469
+ | `getAxisTitle` | 지정한 축의 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열이고, 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null 을 반환한다. | `axis` [`ChartAxis`](#common-chartaxis) — 제목을 읽을 축(가로축 또는 세로축) | 문자열 (없을 수 있음) |
2470
+ | `getLegendPosition` | 범례 위치를 반환한다. 범례를 숨긴 차트는 "none" 이고, 위치를 알아낼 수 없는 차트는 "right" 로 보고한다. | — | [`ChartLegendPosition`](#common-chartlegendposition) |
2471
+ | `getDataLabelPosition` | 데이터레이블 위치를 반환한다. 데이터레이블을 표시하지 않는 차트는 "none" 을 반환한다. | — | [`ChartDataLabelPosition`](#common-chartdatalabelposition) |
2472
+ | `getGridLine` | 지정한 축의 눈금선 종류를 반환한다. 눈금선을 꺼 둔 축은 "none" 이고, 그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 null 을 반환한다. | `axis` [`ChartAxis`](#common-chartaxis) — 눈금선을 읽을 축(가로축 또는 세로축) | [`ChartGridLineType`](#common-chartgridlinetype) (없을 수 있음) |
2473
+ | `getChartInfo` | 차트의 서식 상태를 한 번에 반환한다. 각 값은 이름이 같은 조회 메서드와 같은 규약을 따른다. axisTitle 과 gridLine 의 null 은 그 차트 종류에 해당 축의 제목·눈금선이 아예 없다는 뜻이고, "none" 은 쓸 수는 있지만 꺼져 있다는 뜻이다. | — | `{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string \| null; vertical: string \| null }; gridLine: { horizontal: ChartGridLineType \| null; vertical: ChartGridLineType \| null } }` |
2474
+ | `setType` | 차트 종류를 바꾼다. 지금 종류와 같은 값을 넘기면 아무것도 바뀌지 않는다. | `chartType` [`ChartType`](#common-charttype) — 바꿀 차트 종류(enum 문자열, 예: "clustered_column") | — |
2475
+ | `setStyle` | 차트의 프리셋 스타일을 바꾼다. 번호에 대응하는 실제 색은 문서 테마를 따른다. | `style` 숫자 — 스타일 번호(1~12 정수). 세 개씩 색 그룹이 나뉘고(1~3, 4~6, 7~9, 10~12), 한 그룹 안의 세 번호는 배경만 다르다(반투명 배경, 흰색 배경, 색상 배경과 계열 테두리 순) | — |
2476
+ | `setTitle` | 차트 제목을 설정한다. | `title` 문자열 — 차트에 표시할 제목 | — |
2477
+ | `setAxisTitle` | 지정한 축의 제목을 설정한다. 축 제목은 원형 계열·도넛·방사형을 뺀 차트 종류에서 지원한다. | `axis` [`ChartAxis`](#common-chartaxis) — 제목을 설정할 축(가로축 또는 세로축)<br>`title` 문자열 — 축에 표시할 제목 | — |
2478
+ | `setLegendPosition` | 범례 위치를 설정한다. "none" 을 넘기면 범례를 숨긴다. | `position` [`ChartLegendPosition`](#common-chartlegendposition) — 범례를 놓을 자리 | — |
2479
+ | `setDataLabelPosition` | 데이터레이블 위치를 설정한다. "none" 을 넘기면 데이터레이블을 숨긴다.<br>쓸 수 있는 위치는 차트 종류마다 다르며, "none" 은 모든 종류에서 쓸 수 있다. | `position` [`ChartDataLabelPosition`](#common-chartdatalabelposition) — 데이터레이블을 놓을 자리 | — |
2480
+ | `setGridLine` | 지정한 축의 눈금선을 설정한다. "none" 을 넘기면 그 축의 눈금선을 숨긴다.<br>그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 "none" 을 포함해 어떤 값을 넘겨도 오류가 발생한다. | `axis` [`ChartAxis`](#common-chartaxis) — 눈금선을 설정할 축(가로축 또는 세로축)<br>`gridType` [`ChartGridLineType`](#common-chartgridlinetype) — 표시할 눈금선 종류 | — |
2481
+
2482
+ <a id="show-comment"></a>
2483
+ ### Comment — 댓글 (`Comment`)
2484
+
2485
+ 댓글 하나를 다루는 핸들로, 내용·작성자·작성 시각·위치 조회(getText/getAuthorName/getDateTime 등),
2486
+ 답글 관계 조회(isReply/getParent/getReplies 등), 내용 수정(setText/appendText),
2487
+ 위치 이동(moveBy/setPosition), 표시 스타일 변경(setStyle)을 제공하며,
2488
+ 대상 댓글이 없으면(협업 중 삭제 등) getter 는 null(목록은 빈 배열)을 반환하고
2489
+ setter 는 COMMENT_NOT_FOUND 로 실패한다.
2490
+
2491
+ | 기능 | 설명 | 입력 | 결과 |
2492
+ |---|---|---|---|
2493
+ | `getText` | 댓글 텍스트를 반환한다. | — | 댓글 텍스트. 대상 댓글이 없으면 null<br>문자열 (없을 수 있음) |
2494
+ | `getAuthorName` | 댓글 작성자 이름을 반환한다. | — | 작성자 이름 (작성자 정보가 없으면 빈 문자열). 대상 댓글이 없으면 null<br>문자열 (없을 수 있음) |
2495
+ | `getDateTime` | 댓글 작성 일시를 반환한다. | — | 작성 일시 'YYYY-MM-DDTHH:mm:ss.SSS'. 대상 댓글이 없으면 null<br>문자열 (없을 수 있음) |
2496
+ | `getPosition` | 댓글 메모 아이콘의 슬라이드 기준 위치를 반환한다. | — | 댓글 메모 아이콘의 위치 (px 단위). 대상 댓글이 없으면 null<br>[`CommentPosition`](#show-commentposition) (없을 수 있음) |
2497
+ | `isReply` | 이 댓글이 답글인지 여부를 반환한다. | — | 답글이면 true. 대상 댓글이 없으면 null<br>`boolean \| null` |
2498
+ | `getParent` | 해당 댓글의 부모 댓글을 반환한다. | — | 부모 댓글. 답글이 아니거나 대상 댓글이 없으면 null<br>[`Comment`](#show-comment) (없을 수 있음) |
2499
+ | `hasReplies` | 답글이 하나라도 있는지 여부를 반환한다. | — | 답글이 있으면 true. 대상 댓글이 없으면 null<br>`boolean \| null` |
2500
+ | `getStyle` | 댓글 메모 스타일을 반환한다. (setStyle 대칭)<br>스타일을 지정한 적 없는 댓글도 작성자별 기본 스타일로 반환된다. | — | 메모 스타일. 대상 댓글이 없거나 프리셋 밖 스타일이면 null<br>[`CommentStyle`](#show-commentstyle) (없을 수 있음) |
2501
+ | `getReplies` | 이 댓글의 답글 목록을 반환한다. | — | 답글 목록. 대상 댓글이 없으면 빈 배열<br>[`Comment`](#show-comment) 목록 |
2502
+ | `setText` | 댓글 텍스트를 설정한다. (기존 내용은 대체됨) | `text` 문자열 — 댓글 텍스트 | — |
2503
+ | `appendText` | 댓글 텍스트 끝에 이어 붙인다. | `text` 문자열 — 추가할 텍스트 | — |
2504
+ | `moveBy` | 댓글 메모를 x, y 만큼 상대 이동시킨다. | `distance` 객체 — { x, y } (px 단위 이동량). 양수 = 오른쪽/아래 | — |
2505
+ | `setPosition` | 댓글 메모를 슬라이드 기준 절대 위치로 이동시킨다. (상대 이동은 moveBy) | `position` `Partial<CommentPosition>` — { x, y } (px 단위 절대 좌표). 생략한 축은 현재값 유지 | — |
2506
+ | `setStyle` | 댓글 메모 스타일을 변경한다. (getStyle 대칭) | `style` [`CommentStyle`](#show-commentstyle) — 메모 스타일 | — |
2507
+
2508
+ <a id="show-control"></a>
2509
+ ### Control (`Control`)
2510
+
2511
+ 컨트롤 개체를 다루는 핸들로, 내용 편집은 지원하지 않으며
2512
+ 위치·크기·정렬·순서 등 BaseShape 공통 API 만 제공한다.
2513
+
2514
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2515
+
2516
+ | 기능 | 설명 | 입력 | 결과 |
2517
+ |---|---|---|---|
2518
+
2519
+ <a id="show-diagram"></a>
2520
+ ### Diagram (`Diagram`)
2521
+
2522
+ 다이어그램 개체를 다루는 핸들로, 내용 편집은 지원하지 않으며
2523
+ 위치·크기·정렬·순서 등 BaseShape 공통 API 만 제공한다.
2524
+
2525
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2526
+
2527
+ | 기능 | 설명 | 입력 | 결과 |
2528
+ |---|---|---|---|
2529
+
2530
+ <a id="show-group"></a>
2531
+ ### Group — 그룹 (`Group`)
2532
+
2533
+ 그룹 도형을 다루는 핸들로, 하위 도형 조회(getChildren)와 그룹 해제(ungroup)를 제공하며,
2534
+ 위치·크기·정렬·순서는 BaseShape 공통 API 를 그대로 쓴다.
2535
+
2536
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2537
+
2538
+ | 기능 | 설명 | 입력 | 결과 |
2539
+ |---|---|---|---|
2540
+ | `getChildren` | 그룹의 자식 도형 목록을 반환한다. | — | 자식 도형 목록. 그룹 도형이 없으면(협업 중 삭제 등) 빈 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2541
+ | `ungroup` | 그룹을 해제하여 자식 도형을 슬라이드 최상위로 분리한다.<br>해제 후 이 Group 인스턴스와 미리 얻어 둔 자식 프록시는 무효가 된다 (자식이 새 id 를 받는다). | — | 분리된 자식 도형 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2542
+
2543
+ <a id="show-image"></a>
2544
+ ### Image — 이미지 (`Image`)
2545
+
2546
+ 이미지 도형을 다루는 핸들로, 원본 크기 되돌리기(resetSize)와 이미지 자르기 조회·설정(getCrop/setCrop)을
2547
+ 제공하며, 위치·크기·채우기·선·효과는 BasePathShape 공통 API 를 그대로 쓴다.
2548
+
2549
+ > 📎 [**BasePathShape**](#show-basepathshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2550
+
2551
+ | 기능 | 설명 | 입력 | 결과 |
2552
+ |---|---|---|---|
2553
+ | `getCrop` | 이미지에 적용된 자르기(crop) 상태를 반환한다. (setCrop 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>모든 값의 단위는 퍼센트다 (-100~100). 자르지 않은 방향은 0 이고, 음수는 바깥 여백이다. | — | 자르기 상태. 대상 이미지가 없으면 null<br>[`ImageCrop`](#show-imagecrop) (없을 수 있음) |
2554
+ | `resetSize` | 이미지를 문서에 실린 원본 크기로 되돌린다. 자르기(crop)가 있으면 함께 제거한다. | — | — |
2555
+ | `setCrop` | 이미지를 지정한 방향으로 자른다. (getCrop 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>지정한 방향만 적용하고 생략한 방향은 기존 값을 유지한다. 자르기를 없애려면 0 을 명시한다.<br>모든 값의 단위는 퍼센트다 (-100~100). 양수는 그 방향을 잘라 내고, 음수는 바깥 여백을 만든다.<br>병합 결과가 지금 값과 같으면 아무것도 하지 않는다. | `crop` `Partial<ImageCrop>` — 자르기 설정 | — |
2556
+
2557
+ <a id="show-line"></a>
2558
+ ### Line — 선 (`Line`)
2559
+
2560
+ 연결선을 다루는 핸들로, 시작·끝 화살표 조회·설정(getHeadEnd/getTailEnd/setHeadEnd/setTailEnd)을
2561
+ 제공하고 선 색·두께·점선 등 선 서식은 BasePathShape 공통 API 를 그대로 쓰며, 회전·반전은
2562
+ 지원하지 않아(에디터 UI 도 같은 제약) 물려받은 setRotation/flip 은 액션을 만들지 않고 무시된다.
2563
+
2564
+ > 📎 [**BasePathShape**](#show-basepathshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2565
+
2566
+ | 기능 | 설명 | 입력 | 결과 |
2567
+ |---|---|---|---|
2568
+ | `getHeadEnd` | 연결선의 시작 화살표(headEnd)를 반환한다. (setHeadEnd 대칭 - 반환 객체를 그대로 넘길 수 있다) | — | 시작 화살표 설정. 대상 연결선이 없으면 null. 화살표가 없는 상태는 null 이 아니라 type 이 LineEndType.NONE 인 객체다<br>[`LineEnd`](#show-lineend) (없을 수 있음) |
2569
+ | `getTailEnd` | 연결선의 끝 화살표(tailEnd)를 반환한다. (setTailEnd 대칭 - 반환 객체를 그대로 넘길 수 있다) | — | 끝 화살표 설정. 대상 연결선이 없으면 null. 화살표가 없는 상태는 null 이 아니라 type 이 LineEndType.NONE 인 객체다<br>[`LineEnd`](#show-lineend) (없을 수 있음) |
2570
+ | `setHeadEnd` | 연결선의 시작 화살표(headEnd)를 설정한다. (getHeadEnd 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>화살표를 없애려면 type 에 LineEndType.NONE 을 준다.<br>width/length 를 생략하면 기존 크기가 아니라 기본값(MEDIUM)이 적용된다. | `lineEnd` `Partial<LineEnd> & {type: LineEndType}` — 화살표 설정 | — |
2571
+ | `setTailEnd` | 연결선의 끝 화살표(tailEnd)를 설정한다. (getTailEnd 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>화살표를 없애려면 type 에 LineEndType.NONE 을 준다.<br>width/length 를 생략하면 기존 크기가 아니라 기본값(MEDIUM)이 적용된다. | `lineEnd` `Partial<LineEnd> & {type: LineEndType}` — 화살표 설정 | — |
2572
+
2573
+ <a id="show-oleobject"></a>
2574
+ ### OleObject (`OleObject`)
2575
+
2576
+ OLE 개체를 다루는 핸들로, 내용 편집은 지원하지 않으며
2577
+ 위치·크기·정렬·순서 등 BaseShape 공통 API 만 제공한다.
2578
+
2579
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2580
+
2581
+ | 기능 | 설명 | 입력 | 결과 |
2582
+ |---|---|---|---|
2583
+
2584
+ <a id="show-shape"></a>
2585
+ ### Shape — 도형 (`Shape`)
2586
+
2587
+ 일반 도형과 텍스트 상자를 다루는 핸들로, 텍스트 조회·편집(getText/setText/insertText 등),
2588
+ 글자 서식(setFontStyle/setBold/setFontSize 등), 문단 서식(setAlignH/setLineSpacing/setBulletStyle 등),
2589
+ 텍스트 상자 옵션(setAlignV/setTextboxAutoFit), 도형 모양 조절값(getAdjustValues/setAdjustValue 등)을 제공한다.
2590
+
2591
+ > 📎 [**BasePathShape**](#show-basepathshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2592
+
2593
+ | 기능 | 설명 | 입력 | 결과 |
2594
+ |---|---|---|---|
2595
+ | `getParagraphStyle` | 대표 단락(range 가 걸친 첫 단락)의 단락 서식을 반환한다. (setParagraphStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setParagraphStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이라 단락이 직접 지정한 값만 골라낼 수는 없고,<br>같은 단락에 그대로 다시 넘기면 상속값과 같은 속성은 직접 지정으로 남지 않는다.<br>목록 수준은 서식 값이 아니라 상속 프리셋이라 담지 않는다. (getLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 서식. 텍스트/단락 없으면 null<br>[`ParagraphStyle`](#show-paragraphstyle) (없을 수 있음) |
2596
+ | `getAlignH` | 대표 단락의 가로 정렬을 반환한다. (setAlignH 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 가로 정렬. 텍스트/단락 없으면 null<br>[`TextAlignH`](#show-textalignh) (없을 수 있음) |
2597
+ | `getLineSpacing` | 대표 단락의 줄 간격 값을 반환한다. (setLineSpacing 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2598
+ | `getLineSpacingType` | 대표 단락의 줄 간격 유형을 반환한다. (setLineSpacing 의 type 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 유형. 텍스트/단락 없으면 null<br>[`LineSpacingType`](#show-linespacingtype) (없을 수 있음) |
2599
+ | `getSpaceBefore` | 대표 단락의 단락 앞 간격(UI "문단 위")을 반환한다. (setSpaceBefore 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 앞 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2600
+ | `getSpaceAfter` | 대표 단락의 단락 뒤 간격(UI "문단 아래")을 반환한다. (setSpaceAfter 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 뒤 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2601
+ | `getMarginLeft` | 대표 단락의 왼쪽 여백(UI "텍스트 앞")을 반환한다. (setMarginLeft 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 왼쪽 여백 (pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2602
+ | `getFirstLineIndent` | 대표 단락의 첫 줄 들여쓰기(UI "첫 줄")를 반환한다. (setFirstLineIndent 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 첫 줄 들여쓰기 (pt, 음수는 내어쓰기). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2603
+ | `getLevel` | 대표 단락의 목록 수준을 반환한다. (setLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 목록 수준 (1~9). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2604
+ | `getBulletStyle` | 대표 단락의 글머리 기호 스타일을 반환한다. 반환 필드를 풀어서 setBulletStyle(type, subType, startAt) 에 넘길 수 있다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이고, 없는 값(시작 번호)과 되넘길 수 없는 값(프리셋 밖 번호 유형)은 키를 담지 않는다.<br>그림 글머리·프리셋 밖 문자는 조회 전용이라 그대로는 적용되지 않는다. (제약은 setBulletStyle 참조) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글머리 기호 스타일. 텍스트/단락 없으면 null<br>[`BulletStyle`](#show-bulletstyle) (없을 수 있음) |
2605
+ | `getText` | 텍스트를 plain text로 반환한다. 문단 사이의 개행은 그대로 들어가지만,<br>마지막 문단을 끝맺는 개행은 글자가 아니라 담지 않는다 (빈 텍스트는 ""). | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (UTF-16 코드 단위 offset) (기본값: 전체 텍스트) | 해당 구간의 텍스트 (plain text). 텍스트 모델이 없거나 빈 구간이면 ""<br>문자열 |
2606
+ | `getFontStyle` | 대표 run(range 가 걸친 첫 run)의 글꼴 스타일을 반환한다. (setFontStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setFontStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터/표 스타일 상속까지 반영해 실제 적용된 값이라 run 이 직접 지정한 값만 골라낼 수는 없다. | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 스타일. run/스타일 없으면 빈 객체 `{}`, 대상 텍스트가 없거나(협업 중 삭제 등) 유효하지 않은 구간이면 null<br>[`FontStyle`](#show-fontstyle) (없을 수 있음) |
2607
+ | `getBold` | 대표 run 의 굵게 여부를 반환한다. (setBold 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 굵게 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2608
+ | `getItalic` | 대표 run 의 기울임 여부를 반환한다. (setItalic 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 기울임 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2609
+ | `getUnderline` | 대표 run 의 밑줄 유형을 반환한다. (setUnderline 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 밑줄 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Underline`](#show-underline) (없을 수 있음) |
2610
+ | `getStrike` | 대표 run 의 취소선 유형을 반환한다. (setStrike 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 취소선 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Strike`](#show-strike) (없을 수 있음) |
2611
+ | `getFontSize` | 대표 run 의 글자 크기(pt)를 반환한다. (setFontSize 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 크기 (pt). 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>숫자 (없을 수 있음) |
2612
+ | `getFontFamily` | 대표 run 의 글꼴 이름을 반환한다. (setFontFamily 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 이름. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2613
+ | `getTextColor` | 대표 run 의 글자 색상을 반환한다. (setTextColor 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 색상 (hex "#RRGGBB" — scheme color 도 hex 로 풀려서 나온다). solid 채우기가 아니거나 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2614
+ | `getTextHyperlink` | 텍스트 구간의 하이퍼링크를 반환한다. (setTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 복사할 수 있다)<br>range 를 주면 그 구간의 첫 글자, range 가 없으면 텍스트의 첫 글자가 속한 run 을 기준으로 한다.<br>도형 자체에 걸린 하이퍼링크는 getHyperlink 로 읽는다. | `range` (선택) [`TextRange`](#show-textrange) — 조회할 텍스트 구간 (기본값: 텍스트 첫 글자) | 하이퍼링크 정보 (getHyperlink 와 같은 Hyperlink 객체). 링크 없음/텍스트 없음/미노출 action 이면 null<br>[`Hyperlink`](#show-hyperlink) (없을 수 있음) |
2615
+ | `getTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 반환한다. (setTextboxAutoFit 대칭) | — | 자동 맞춤 유형. 대상 텍스트가 없으면 null<br>[`AutoFitType`](#show-autofittype) (없을 수 있음) |
2616
+ | `getAlignV` | 텍스트 세로 정렬을 반환한다. (setAlignV 대칭)<br>TextAlignV 는 TOP 이 0 인 숫자 enum 이라, 값이 있는지는 truthy 검사가 아니라 null 비교로 본다. | — | 세로 정렬. 대상 텍스트가 없으면 null<br>[`TextAlignV`](#show-textalignv) (없을 수 있음) |
2617
+ | `setText` | 텍스트를 설정한다. 인자 조합에 따라 다음과 같이 동작한다.<br>- range 없음: 전체 텍스트를 text 로 교체<br>- range 있음: 지정한 구간만 text 로 교체<br>- text 가 빈 문자열("")이면 교체 대신 해당 범위를 삭제<br><br>삭제 없이 끼워넣는 삽입은 insertText 를 사용한다.<br>(단, from 이 텍스트 끝이면 지울 글자가 없어 끝 삽입으로 동작).<br><br>대체된 자리의 글자 서식은 구간 시작 위치의 글자 서식을, 문단 서식은 기존 문단의 서식을 따른다. | `text` 문자열 — 설정할 텍스트. 빈 문자열("")이면 삭제로 동작<br>`range` (선택) [`TextRange`](#show-textrange) — 교체할 텍스트 구간 to = from + 글자수 - 1 (0-based) 예: "가나다" 전체 = {from: 0, to: 2}, "가나다" 중 "가" = {from: 0, to: 0} offset 은 UTF-16 코드 단위라 서로게이트 페어를 가르는 range 는 반쪽이 아니라 그 글자 전체가 대상이 된다 (range 를 받는 서식 setter 도 같다) (기본값: 전체 텍스트) | — |
2618
+ | `insertText` | 텍스트를 삽입한다.<br>삽입한 글자의 서식은 삽입 지점 바로 앞 글자의 런 서식을 따른다. | `text` 문자열 — 삽입할 텍스트<br>`textOffset` (선택) 숫자 — 삽입 위치 offset (기본값: 텍스트 끝) | — |
2619
+ | `setFontStyle` | 글꼴 스타일을 설정한다. 단일 속성은 setBold/setItalic/setFontSize/setFontFamily/setTextColor 사용 권장. | `style` [`FontStyle`](#show-fontstyle) — 글꼴 스타일 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2620
+ | `setBold` | 글자를 굵게 설정한다. | `enabled` 참/거짓 — true: 굵게, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2621
+ | `setItalic` | 글자 기울임을 설정한다. | `enabled` 참/거짓 — true: 기울임, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2622
+ | `setUnderline` | 글자 밑줄을 설정한다. | `underline` [`Underline`](#show-underline) — 밑줄 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2623
+ | `setStrike` | 글자 취소선을 설정한다. | `strike` [`Strike`](#show-strike) — 취소선 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2624
+ | `setFontSize` | 글자 크기를 설정한다. | `fontSize` 숫자 — pt 단위<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2625
+ | `setFontFamily` | 글꼴을 설정한다. | `fontFamily` 문자열 — 글꼴 이름<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2626
+ | `setTextColor` | 글자 색상을 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2627
+ | `setTextHyperlink` | 텍스트에 하이퍼링크를 설정한다. (getTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 링크를 복사할 수 있다)<br>도형 전체에 링크를 거는 setHyperlink 와 달리 링크가 글자(run) 단위로 걸리며 하이퍼링크 서식으로 표시된다.<br>지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다. | `hyperlink` [`Hyperlink`](#show-hyperlink) — getTextHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2628
+ | `removeTextHyperlink` | 텍스트의 하이퍼링크를 제거한다. (도형 자체에 걸린 하이퍼링크는 removeHyperlink) | `range` (선택) [`TextRange`](#show-textrange) — 제거할 텍스트 구간 (기본값: 전체 텍스트) | — |
2629
+ | `insertSymbol` | 지정한 offset 위치에 특수문자(symbol)를 삽입한다. | `textOffset` 숫자 — 삽입 위치 offset<br>`symbol` 문자열 — 삽입할 특수문자 (개행 불가 — 문단을 나누려면 insertText) | — |
2630
+ | `setAlignH` | 텍스트 가로 정렬을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다. | `align` [`TextAlignH`](#show-textalignh) — 가로 정렬<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2631
+ | `setParagraphStyle` | 단락 서식을 한 번에 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.<br>값을 준 속성만 바뀐다. null/undefined 는 "변경 없음"으로 무시하며, 지정한 값을 상속 상태로 되돌리는 방법은 아직 없다.<br>단일 속성은 setLineSpacing/setMarginLeft/setFirstLineIndent/setSpaceBefore/setSpaceAfter 사용 권장.<br>목록 수준은 바꿀 때 딸려오는 부수 효과(글머리 기호·글자 크기)가 있어 여기 담지 않는다. (setLevel 참고) | `style` [`ParagraphStyle`](#show-paragraphstyle) — 단락 서식 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2632
+ | `setLineSpacing` | 줄 간격을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.<br>lineSpacing 의 단위는 유형에 따라 다르다 - MULTIPLE 이면 배수 백분율(150=1.5배), EXACT 이면 pt 다. | `lineSpacing` 숫자 — 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt)<br>`type` (선택) [`LineSpacingType`](#show-linespacingtype) — 줄 간격 유형 (기본값: LineSpacingType.MULTIPLE)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2633
+ | `setSpaceBefore` | 단락 앞 간격(UI "문단 위")을 설정한다. | `spaceBefore` 숫자 — 단락 앞 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2634
+ | `setSpaceAfter` | 단락 뒤 간격(UI "문단 아래")을 설정한다. | `spaceAfter` 숫자 — 단락 뒤 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2635
+ | `setMarginLeft` | 단락 전체의 왼쪽 여백(UI "텍스트 앞")을 설정한다. 첫 줄만 들여쓰려면 setFirstLineIndent 를 사용한다. | `marginLeft` 숫자 — 왼쪽 여백 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2636
+ | `setFirstLineIndent` | 단락 첫 줄의 들여쓰기(UI "첫 줄")를 설정한다. 둘째 줄부터는 marginLeft 를 따른다.<br>양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음이다.<br>글머리 기호 목록의 계층 깊이를 바꾸려면 setLevel 을 사용한다. | `firstLineIndent` 숫자 — 첫 줄 들여쓰기 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2637
+ | `setLevel` | 목록 수준(개요 계층 깊이)을 설정한다. range 가 걸친 단락을 모두 같은 수준으로 맞춘다.<br>pt 단위 들여쓰기(setFirstLineIndent/setMarginLeft)와 달리 수준은 상속 프리셋 선택이라,<br>바꾸면 그 수준의 글머리 기호·글자 크기가 따라오고 marginLeft 는 새 수준의 값으로 덮인다.<br>setMarginLeft 로 지정한 값도 버려지므로 둘을 함께 쓸 때는 setLevel 을 먼저 호출한다. (firstLineIndent 는 유지)<br>대상 텍스트가 허용하는 범위(제목 개체는 1 수준뿐)로 제한한다. | `level` 숫자 — 목록 수준 (1=최상위 ~ 9)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2638
+ | `setBulletStyle` | 글머리 기호 스타일을 설정한다. (getBulletStyle 대칭)<br>그림 글머리(BulletType.BLIP)는 적용을 지원하지 않는 조회 전용 유형이라 거부한다.<br>CharType 프리셋 밖의 문자도 적용할 수 없다 (조회 전용이라 받을 인자가 없다). | `bulletType` `Exclude<BulletType, "buBlip">` — 글머리 기호 유형<br>`subType` (선택) `NumberedType \| CharType` — BulletType.AUTO_NUM: 번호 매기기 유형 (기본값 NumberedType.NUMBER_WITH_DOT), BulletType.CHAR: 글머리 문자 유형 (기본값 CharType.DOT)<br>`startAt` (선택) 숫자 — 시작 번호 (BulletType.AUTO_NUM 일 때만 사용) (기본값: 1)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2639
+ | `setAlignV` | 텍스트 세로 정렬을 설정한다. (getAlignV 대칭) | `align` [`TextAlignV`](#show-textalignv) — 세로 정렬 | — |
2640
+ | `setTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 설정한다. 이미 같은 유형이면 아무것도 하지 않는다. | `autoAlignType` [`AutoFitType`](#show-autofittype) — 자동 맞춤 유형 | — |
2641
+ | `getAdjustValues` | 일반 도형에 정의된 조절값과 조절 가능한 범위를 반환한다. 반환된 name 은 조절값 조회와 변경 API 에서 사용한다. | — | 조절값 목록. 대상 도형이 없으면(협업 중 삭제 등) null<br>`AdjustValue[] \| null` |
2642
+ | `isFlatTx` | 3D 회전 시 텍스트를 평면으로 유지하는지 반환한다. (setFlatTx 대칭) | — | 텍스트 평면 유지 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2643
+ | `setFlatTx` | 3D 회전 시 텍스트를 평면으로 유지할지 설정한다. (isFlatTx 대칭) | `enabled` 참/거짓 — true 이면 텍스트 평면 유지, false 이면 해제 | — |
2644
+ | `setAdjustValue` | 일반 도형의 조절값(adjust value) 하나를 변경한다. 여러 조절값을 함께 변경하려면 setAdjustValues 를 사용한다. | `name` 문자열 — 조절값 이름(getAdjustValues 결과)<br>`value` 숫자 — 조절값. 정수로 반올림되며 허용 범위를 벗어나면 최솟값 또는 최댓값으로 제한됨 (getAdjustValues 의 min/max 가 null 인 경우처럼 범위를 알 수 없으면 제한하지 않는다) | — |
2645
+ | `setAdjustValues` | 일반 도형의 여러 조절값(adjust value)을 한 번에 변경한다. | `avList` [`AdjustValueUpdate`](#show-adjustvalueupdate) 목록 — 변경할 조절값 목록 | — |
2646
+
2647
+ <a id="show-table"></a>
2648
+ ### Table — 표 (`Table`)
2649
+
2650
+ 표 도형을 다루는 핸들로, 셀·행·열 조회와 검색(getCell/getCells/findCells 등),
2651
+ 행·열 삽입·삭제(insertRow/deleteRow/insertCol 등), 셀 병합·해제(mergeCell/unmergeCell),
2652
+ 표 스타일(setStyle/setStyleOption), 행 높이·열 너비 조정(setRowHeight/setColWidth)을 제공한다.
2653
+
2654
+ > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2655
+
2656
+ | 기능 | 설명 | 입력 | 결과 |
2657
+ |---|---|---|---|
2658
+ | `getRowCount` | 표의 행 개수를 반환한다. | — | 행 개수. 표가 없으면 0<br>숫자 |
2659
+ | `getColCount` | 표의 열 개수를 반환한다. | — | 열 개수. 표가 없으면 0<br>숫자 |
2660
+ | `getCell` | 지정 좌표의 셀을 반환한다. 병합 영역 내부 좌표를 지정하면 그 병합 영역의 대표 셀을 반환한다. | `row` 숫자 — 행 인덱스 (0-based)<br>`col` 숫자 — 열 인덱스 (0-based) | 해당 셀 (범위를 벗어나거나 표가 없으면 null)<br>[`TableCell`](#show-tablecell) (없을 수 있음) |
2661
+ | `getCells` | 모든 셀을 배열로 반환한다.<br>병합된 셀은 대표 셀 하나만 포함한다. | — | 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2662
+ | `findCells` | 조건에 맞는 셀 배열을 반환한다.<br>복수 조건은 AND 로 결합한다. range 는 셀 본체가 범위와 겹치면 매칭된다<br>(병합 대표 셀이 범위 밖에 있어도 셀 일부가 범위 안이면 결과에 포함된다).<br>그 외 조건은 병합된 셀의 대표 셀 좌표/속성 기준으로 평가한다. | `filter` (선택) [`CellFilter`](#show-cellfilter) — 검색 조건. null 도 조건 없음으로 본다 (기본값: 전체 셀) | 조건에 맞는 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2663
+ | `getColWidth` | 지정 열의 너비를 반환한다. (setColWidth 대칭) | `colIndex` 숫자 — 열 인덱스 (0-based) | 너비 (px 단위), 범위 밖이거나 표가 없으면 null<br>숫자 (없을 수 있음) |
2664
+ | `getRowHeight` | 지정 행의 높이를 반환한다. (setRowHeight 대칭) | `rowIndex` 숫자 — 행 인덱스 (0-based) | 높이 (px 단위), 범위 밖이거나 표가 없으면 null<br>숫자 (없을 수 있음) |
2665
+ | `getRow` | 지정 행의 셀 배열을 반환한다.<br>병합된 셀은 대표 셀 하나만 포함한다. | `rowIndex` 숫자 — 0-based 행 인덱스 | 해당 행의 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2666
+ | `getColumn` | 지정 열의 셀 배열을 반환한다.<br>병합된 셀은 대표 셀 하나만 포함한다. | `colIndex` 숫자 — 0-based 열 인덱스 | 해당 열의 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2667
+ | `getStyleName` | 표에 적용된 스타일 이름을 반환한다. (setStyle 대칭)<br>반환한 이름은 그대로 setStyle 에 되먹일 수 있다. 다만 문서에만 실려 있고 편집기 갤러리에는<br>없는 스타일이면 doc.getTableStyleNames() 목록에는 나오지 않는다. | — | 표 스타일 이름. 스타일이 없거나 이름이 없는 스타일(문서가 이름을 싣지 않은 경우)이면 null<br>문자열 (없을 수 있음) |
2668
+ | `getStyleOption` | 표 스타일 옵션(머리글 행, 줄무늬 행 등)의 활성화 여부를 반환한다. (setStyleOption 대칭) | `option` [`TableStyleOption`](#show-tablestyleoption) — 옵션 유형 (apiConstants.TableStyleOption) | 활성화 여부. 표나 표 속성을 읽을 수 없으면 null<br>`boolean \| null` |
2669
+ | `setStyle` | 표 스타일을 변경한다. (getStyleName 대칭) | `styleName` 문자열 — 표 스타일 이름 (doc.getTableStyleNames() 결과) | — |
2670
+ | `setStyleOption` | 표 스타일 옵션(머리글 행, 줄무늬 행 등)을 변경한다. (getStyleOption 대칭) | `option` [`TableStyleOption`](#show-tablestyleoption) — 옵션 유형 (apiConstants.TableStyleOption)<br>`enabled` 참/거짓 — 활성화 여부 | — |
2671
+ | `mergeCell` | 지정 범위의 셀을 병합한다. | `startRow` 숫자 — 병합 시작 행 인덱스 (0-based)<br>`startCol` 숫자 — 병합 시작 열 인덱스 (0-based)<br>`endRow` 숫자 — 병합 끝 행 인덱스 (0-based, inclusive)<br>`endCol` 숫자 — 병합 끝 열 인덱스 (0-based, inclusive) | — |
2672
+ | `unmergeCell` | 지정 범위의 병합된 셀을 해제한다. | `startRow` 숫자 — 해제 시작 행 인덱스 (0-based)<br>`startCol` 숫자 — 해제 시작 열 인덱스 (0-based)<br>`endRow` 숫자 — 해제 끝 행 인덱스 (0-based, inclusive)<br>`endCol` 숫자 — 해제 끝 열 인덱스 (0-based, inclusive) | — |
2673
+ | `insertRow` | 기준 행의 위 또는 아래에 행을 삽입한다.<br>새 행은 기준 행의 서식을 상속한다. | `baseRowIndex` 숫자 — 삽입 기준 행 인덱스 (0-based)<br>`position` [`InsertPosition`](#show-insertposition) — InsertPosition.ABOVE \| InsertPosition.BELOW<br>`insertNum` 숫자 — 삽입할 행 개수 | — |
2674
+ | `deleteRow` | 지정 범위의 행을 삭제한다. 모든 행을 지울 수는 없다 - 한 행짜리 표에서 그 행을 지우려 하면 오류가 난다.<br>표 자체를 없애려면 Slide.deleteShape 를 쓴다. | `startRow` 숫자 — 삭제 시작 행 인덱스 (0-based)<br>`endRow` 숫자 — 삭제 끝 행 인덱스 (0-based, inclusive) | — |
2675
+ | `insertCol` | 기준 열의 왼쪽 또는 오른쪽에 열을 삽입한다.<br>새 열은 기준 열의 서식을 상속한다. | `baseColIndex` 숫자 — 삽입 기준 열 인덱스 (0-based)<br>`position` [`InsertPosition`](#show-insertposition) — InsertPosition.LEFT \| InsertPosition.RIGHT<br>`insertNum` 숫자 — 삽입할 열 개수 | — |
2676
+ | `deleteCol` | 지정 범위의 열을 삭제한다. 모든 열을 지울 수는 없다 - 한 열짜리 표에서 그 열을 지우려 하면 오류가 난다.<br>표 자체를 없애려면 Slide.deleteShape 를 쓴다. | `startCol` 숫자 — 삭제 시작 열 인덱스 (0-based)<br>`endCol` 숫자 — 삭제 끝 열 인덱스 (0-based, inclusive) | — |
2677
+ | `setRowHeight` | 지정 행의 높이를 변경한다. | `rowIndex` 숫자 — 행 인덱스 (0-based)<br>`newHeight` 숫자 — 새 높이 (px 단위). rowIndex 가 표의 행 수를 벗어나면 무시된다 | — |
2678
+ | `setColWidth` | 지정 열의 너비를 변경한다. | `colIndex` 숫자 — 열 인덱스 (0-based)<br>`newWidth` 숫자 — 새 너비 (px 단위). colIndex 가 표의 열 수를 벗어나면 무시된다 | — |
2679
+
2680
+ <a id="show-tablecell"></a>
2681
+ ### TableCell — 표 셀 (`TableCell`)
2682
+
2683
+ 표 셀 하나를 다루는 핸들로, 셀 텍스트 조회·편집과 글자·문단 서식(getText/setText/setFontStyle 등),
2684
+ 셀 배경 채우기(setSolidFill/setFill), 테두리(getBorderStyle/setBorderStyle),
2685
+ 행·열 위치 조회(getRowIndex/getColIndex)를 제공한다.
2686
+
2687
+ | 기능 | 설명 | 입력 | 결과 |
2688
+ |---|---|---|---|
2689
+ | `isShape` | 이 핸들이 `Shape` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Shape` |
2690
+ | `getParagraphStyle` | 대표 단락(range 가 걸친 첫 단락)의 단락 서식을 반환한다. (setParagraphStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setParagraphStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이라 단락이 직접 지정한 값만 골라낼 수는 없고,<br>같은 단락에 그대로 다시 넘기면 상속값과 같은 속성은 직접 지정으로 남지 않는다.<br>목록 수준은 서식 값이 아니라 상속 프리셋이라 담지 않는다. (getLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 서식. 텍스트/단락 없으면 null<br>[`ParagraphStyle`](#show-paragraphstyle) (없을 수 있음) |
2691
+ | `getAlignH` | 대표 단락의 가로 정렬을 반환한다. (setAlignH 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 가로 정렬. 텍스트/단락 없으면 null<br>[`TextAlignH`](#show-textalignh) (없을 수 있음) |
2692
+ | `getLineSpacing` | 대표 단락의 줄 간격 값을 반환한다. (setLineSpacing 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2693
+ | `getLineSpacingType` | 대표 단락의 줄 간격 유형을 반환한다. (setLineSpacing 의 type 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 유형. 텍스트/단락 없으면 null<br>[`LineSpacingType`](#show-linespacingtype) (없을 수 있음) |
2694
+ | `getSpaceBefore` | 대표 단락의 단락 앞 간격(UI "문단 위")을 반환한다. (setSpaceBefore 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 앞 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2695
+ | `getSpaceAfter` | 대표 단락의 단락 뒤 간격(UI "문단 아래")을 반환한다. (setSpaceAfter 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 뒤 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2696
+ | `getMarginLeft` | 대표 단락의 왼쪽 여백(UI "텍스트 앞")을 반환한다. (setMarginLeft 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 왼쪽 여백 (pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2697
+ | `getFirstLineIndent` | 대표 단락의 첫 줄 들여쓰기(UI "첫 줄")를 반환한다. (setFirstLineIndent 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 첫 줄 들여쓰기 (pt, 음수는 내어쓰기). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2698
+ | `getLevel` | 대표 단락의 목록 수준을 반환한다. (setLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 목록 수준 (1~9). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2699
+ | `getBulletStyle` | 대표 단락의 글머리 기호 스타일을 반환한다. 반환 필드를 풀어서 setBulletStyle(type, subType, startAt) 에 넘길 수 있다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이고, 없는 값(시작 번호)과 되넘길 수 없는 값(프리셋 밖 번호 유형)은 키를 담지 않는다.<br>그림 글머리·프리셋 밖 문자는 조회 전용이라 그대로는 적용되지 않는다. (제약은 setBulletStyle 참조) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글머리 기호 스타일. 텍스트/단락 없으면 null<br>[`BulletStyle`](#show-bulletstyle) (없을 수 있음) |
2700
+ | `getText` | 텍스트를 plain text로 반환한다. 문단 사이의 개행은 그대로 들어가지만,<br>마지막 문단을 끝맺는 개행은 글자가 아니라 담지 않는다 (빈 텍스트는 ""). | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (UTF-16 코드 단위 offset) (기본값: 전체 텍스트) | 해당 구간의 텍스트 (plain text). 텍스트 모델이 없거나 빈 구간이면 ""<br>문자열 |
2701
+ | `getFontStyle` | 대표 run(range 가 걸친 첫 run)의 글꼴 스타일을 반환한다. (setFontStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setFontStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터/표 스타일 상속까지 반영해 실제 적용된 값이라 run 이 직접 지정한 값만 골라낼 수는 없다. | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 스타일. run/스타일 없으면 빈 객체 `{}`, 대상 텍스트가 없거나(협업 중 삭제 등) 유효하지 않은 구간이면 null<br>[`FontStyle`](#show-fontstyle) (없을 수 있음) |
2702
+ | `getBold` | 대표 run 의 굵게 여부를 반환한다. (setBold 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 굵게 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2703
+ | `getItalic` | 대표 run 의 기울임 여부를 반환한다. (setItalic 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 기울임 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2704
+ | `getUnderline` | 대표 run 의 밑줄 유형을 반환한다. (setUnderline 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 밑줄 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Underline`](#show-underline) (없을 수 있음) |
2705
+ | `getStrike` | 대표 run 의 취소선 유형을 반환한다. (setStrike 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 취소선 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Strike`](#show-strike) (없을 수 있음) |
2706
+ | `getFontSize` | 대표 run 의 글자 크기(pt)를 반환한다. (setFontSize 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 크기 (pt). 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>숫자 (없을 수 있음) |
2707
+ | `getFontFamily` | 대표 run 의 글꼴 이름을 반환한다. (setFontFamily 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 이름. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2708
+ | `getTextColor` | 대표 run 의 글자 색상을 반환한다. (setTextColor 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 색상 (hex "#RRGGBB" — scheme color 도 hex 로 풀려서 나온다). solid 채우기가 아니거나 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2709
+ | `getTextHyperlink` | 텍스트 구간의 하이퍼링크를 반환한다. (setTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 복사할 수 있다)<br>range 를 주면 그 구간의 첫 글자, range 가 없으면 텍스트의 첫 글자가 속한 run 을 기준으로 한다.<br>도형 자체에 걸린 하이퍼링크는 getHyperlink 로 읽는다. | `range` (선택) [`TextRange`](#show-textrange) — 조회할 텍스트 구간 (기본값: 텍스트 첫 글자) | 하이퍼링크 정보 (getHyperlink 와 같은 Hyperlink 객체). 링크 없음/텍스트 없음/미노출 action 이면 null<br>[`Hyperlink`](#show-hyperlink) (없을 수 있음) |
2710
+ | `getTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 반환한다. (setTextboxAutoFit 대칭) | — | 자동 맞춤 유형. 대상 텍스트가 없으면 null<br>[`AutoFitType`](#show-autofittype) (없을 수 있음) |
2711
+ | `getAlignV` | 텍스트 세로 정렬을 반환한다. (setAlignV 대칭)<br>TextAlignV 는 TOP 이 0 인 숫자 enum 이라, 값이 있는지는 truthy 검사가 아니라 null 비교로 본다. | — | 세로 정렬. 대상 텍스트가 없으면 null<br>[`TextAlignV`](#show-textalignv) (없을 수 있음) |
2712
+ | `setText` | 텍스트를 설정한다. 인자 조합에 따라 다음과 같이 동작한다.<br>- range 없음: 전체 텍스트를 text 로 교체<br>- range 있음: 지정한 구간만 text 로 교체<br>- text 가 빈 문자열("")이면 교체 대신 해당 범위를 삭제<br><br>삭제 없이 끼워넣는 삽입은 insertText 를 사용한다.<br>(단, from 이 텍스트 끝이면 지울 글자가 없어 끝 삽입으로 동작).<br><br>대체된 자리의 글자 서식은 구간 시작 위치의 글자 서식을, 문단 서식은 기존 문단의 서식을 따른다. | `text` 문자열 — 설정할 텍스트. 빈 문자열("")이면 삭제로 동작<br>`range` (선택) [`TextRange`](#show-textrange) — 교체할 텍스트 구간 to = from + 글자수 - 1 (0-based) 예: "가나다" 전체 = {from: 0, to: 2}, "가나다" 중 "가" = {from: 0, to: 0} offset 은 UTF-16 코드 단위라 서로게이트 페어를 가르는 range 는 반쪽이 아니라 그 글자 전체가 대상이 된다 (range 를 받는 서식 setter 도 같다) (기본값: 전체 텍스트) | — |
2713
+ | `insertText` | 텍스트를 삽입한다.<br>삽입한 글자의 서식은 삽입 지점 바로 앞 글자의 런 서식을 따른다. | `text` 문자열 — 삽입할 텍스트<br>`textOffset` (선택) 숫자 — 삽입 위치 offset (기본값: 텍스트 끝) | — |
2714
+ | `setFontStyle` | 글꼴 스타일을 설정한다. 단일 속성은 setBold/setItalic/setFontSize/setFontFamily/setTextColor 사용 권장. | `style` [`FontStyle`](#show-fontstyle) — 글꼴 스타일 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2715
+ | `setBold` | 글자를 굵게 설정한다. | `enabled` 참/거짓 — true: 굵게, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2716
+ | `setItalic` | 글자 기울임을 설정한다. | `enabled` 참/거짓 — true: 기울임, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2717
+ | `setUnderline` | 글자 밑줄을 설정한다. | `underline` [`Underline`](#show-underline) — 밑줄 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2718
+ | `setStrike` | 글자 취소선을 설정한다. | `strike` [`Strike`](#show-strike) — 취소선 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2719
+ | `setFontSize` | 글자 크기를 설정한다. | `fontSize` 숫자 — pt 단위<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2720
+ | `setFontFamily` | 글꼴을 설정한다. | `fontFamily` 문자열 — 글꼴 이름<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2721
+ | `setTextColor` | 글자 색상을 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2722
+ | `setTextHyperlink` | 텍스트에 하이퍼링크를 설정한다. (getTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 링크를 복사할 수 있다)<br>도형 전체에 링크를 거는 setHyperlink 와 달리 링크가 글자(run) 단위로 걸리며 하이퍼링크 서식으로 표시된다.<br>지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다. | `hyperlink` [`Hyperlink`](#show-hyperlink) — getTextHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2723
+ | `removeTextHyperlink` | 텍스트의 하이퍼링크를 제거한다. (도형 자체에 걸린 하이퍼링크는 removeHyperlink) | `range` (선택) [`TextRange`](#show-textrange) — 제거할 텍스트 구간 (기본값: 전체 텍스트) | — |
2724
+ | `insertSymbol` | 지정한 offset 위치에 특수문자(symbol)를 삽입한다. | `textOffset` 숫자 — 삽입 위치 offset<br>`symbol` 문자열 — 삽입할 특수문자 (개행 불가 — 문단을 나누려면 insertText) | — |
2725
+ | `setAlignH` | 텍스트 가로 정렬을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다. | `align` [`TextAlignH`](#show-textalignh) — 가로 정렬<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2726
+ | `setParagraphStyle` | 단락 서식을 한 번에 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.<br>값을 준 속성만 바뀐다. null/undefined 는 "변경 없음"으로 무시하며, 지정한 값을 상속 상태로 되돌리는 방법은 아직 없다.<br>단일 속성은 setLineSpacing/setMarginLeft/setFirstLineIndent/setSpaceBefore/setSpaceAfter 사용 권장.<br>목록 수준은 바꿀 때 딸려오는 부수 효과(글머리 기호·글자 크기)가 있어 여기 담지 않는다. (setLevel 참고) | `style` [`ParagraphStyle`](#show-paragraphstyle) — 단락 서식 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2727
+ | `setLineSpacing` | 줄 간격을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.<br>lineSpacing 의 단위는 유형에 따라 다르다 - MULTIPLE 이면 배수 백분율(150=1.5배), EXACT 이면 pt 다. | `lineSpacing` 숫자 — 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt)<br>`type` (선택) [`LineSpacingType`](#show-linespacingtype) — 줄 간격 유형 (기본값: LineSpacingType.MULTIPLE)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2728
+ | `setSpaceBefore` | 단락 앞 간격(UI "문단 위")을 설정한다. | `spaceBefore` 숫자 — 단락 앞 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2729
+ | `setSpaceAfter` | 단락 뒤 간격(UI "문단 아래")을 설정한다. | `spaceAfter` 숫자 — 단락 뒤 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2730
+ | `setMarginLeft` | 단락 전체의 왼쪽 여백(UI "텍스트 앞")을 설정한다. 첫 줄만 들여쓰려면 setFirstLineIndent 를 사용한다. | `marginLeft` 숫자 — 왼쪽 여백 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2731
+ | `setFirstLineIndent` | 단락 첫 줄의 들여쓰기(UI "첫 줄")를 설정한다. 둘째 줄부터는 marginLeft 를 따른다.<br>양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음이다.<br>글머리 기호 목록의 계층 깊이를 바꾸려면 setLevel 을 사용한다. | `firstLineIndent` 숫자 — 첫 줄 들여쓰기 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2732
+ | `setLevel` | 목록 수준(개요 계층 깊이)을 설정한다. range 가 걸친 단락을 모두 같은 수준으로 맞춘다.<br>pt 단위 들여쓰기(setFirstLineIndent/setMarginLeft)와 달리 수준은 상속 프리셋 선택이라,<br>바꾸면 그 수준의 글머리 기호·글자 크기가 따라오고 marginLeft 는 새 수준의 값으로 덮인다.<br>setMarginLeft 로 지정한 값도 버려지므로 둘을 함께 쓸 때는 setLevel 을 먼저 호출한다. (firstLineIndent 는 유지)<br>대상 텍스트가 허용하는 범위(제목 개체는 1 수준뿐)로 제한한다. | `level` 숫자 — 목록 수준 (1=최상위 ~ 9)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2733
+ | `setBulletStyle` | 글머리 기호 스타일을 설정한다. (getBulletStyle 대칭)<br>그림 글머리(BulletType.BLIP)는 적용을 지원하지 않는 조회 전용 유형이라 거부한다.<br>CharType 프리셋 밖의 문자도 적용할 수 없다 (조회 전용이라 받을 인자가 없다). | `bulletType` `Exclude<BulletType, "buBlip">` — 글머리 기호 유형<br>`subType` (선택) `NumberedType \| CharType` — BulletType.AUTO_NUM: 번호 매기기 유형 (기본값 NumberedType.NUMBER_WITH_DOT), BulletType.CHAR: 글머리 문자 유형 (기본값 CharType.DOT)<br>`startAt` (선택) 숫자 — 시작 번호 (BulletType.AUTO_NUM 일 때만 사용) (기본값: 1)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2734
+ | `setAlignV` | 텍스트 세로 정렬을 설정한다. (getAlignV 대칭) | `align` [`TextAlignV`](#show-textalignv) — 세로 정렬 | — |
2735
+ | `setTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 설정한다. 이미 같은 유형이면 아무것도 하지 않는다. | `autoAlignType` [`AutoFitType`](#show-autofittype) — 자동 맞춤 유형 | — |
2736
+ | `getRowIndex` | 셀의 행 인덱스를 반환한다. | — | 행 인덱스 (0-based)<br>숫자 |
2737
+ | `getColIndex` | 셀의 열 인덱스를 반환한다. | — | 열 인덱스 (0-based)<br>숫자 |
2738
+ | `getColSpan` | 셀이 가로로 차지하는 열 수를 반환한다. 병합되지 않았으면 1 이다. | — | 열 병합 수. 표가 없거나 해당 위치에 셀이 없으면 null<br>숫자 (없을 수 있음) |
2739
+ | `getRowSpan` | 셀이 세로로 차지하는 행 수를 반환한다. 병합되지 않았으면 1 이다. | — | 행 병합 수. 표가 없거나 해당 위치에 셀이 없으면 null<br>숫자 (없을 수 있음) |
2740
+ | `getFill` | 셀에 명시적으로 설정된 배경 채우기를 반환한다. (setSolidFill 대칭)<br>스타일 상속분은 포함하지 않으며(셀에 직접 지정한 채우기만), alpha 는 setSolidFill 과 같은<br>투명도(0~100, 0=불투명)로 반환한다. | — | 채우기 정보. 명시적 fill 없으면 `{ type: FillType.NONE }`, 표가 없으면 null<br>[`Fill`](#show-fill) (없을 수 있음) |
2741
+ | `getBorderStyle` | 지정 위치의 셀 테두리 스타일을 반환한다. (setBorderStyle 대칭)<br>ALL 일괄 조회는 지원하지 않는다 - 한 변씩 조회한다. | `position` `Exclude<BorderPosition, "all">` — 테두리 위치 | 테두리 스타일. 해당 위치에 명시적 테두리가 없으면 null<br>[`BorderStyle`](#show-borderstyle) (없을 수 있음) |
2742
+ | `deleteText` | 셀 안의 모든 텍스트를 제거한다. | — | — |
2743
+ | `setSolidFill` | 셀 배경을 단색으로 채운다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명, 100=완전 투명). 생략하면 기존 투명도 유지 | — |
2744
+ | `setFill` | getFill() 이 반환한 채우기 객체를 그대로 적용한다. (getFill 대칭 — 셀 채우기 복사)<br>셀 채우기 설정은 단색만 지원한다 — getFill() 이 다른 타입(none/gradient 등)을 돌려준 셀의 값은 되넘길 수 없다. | `fill` `Fill & { type: "solidFill" }` — 적용할 단색 채우기 | — |
2745
+ | `setBorderStyle` | 셀 테두리 스타일을 설정한다. 생략한 속성은 유지되지 않고 기본값이 되므로, 일부만 바꾸려면<br>getBorderStyle() 반환값에 바꿀 속성을 덮어 함께 넘긴다. 셋을 모두 생략하면 아무것도 바꾸지 않는다.<br>ALL 은 위/아래/왼쪽/오른쪽 4변만 설정한다 - 대각선은 포함하지 않는다. 색상은 hex / scheme color 모두 자동 판정. | `position` [`BorderPosition`](#show-borderposition) — 테두리 위치<br>`color` (선택) 문자열 — hex (#RRGGBB) 또는 scheme color name<br>`width` (선택) 숫자 — 선 두께 (pt 단위)<br>`lineDash` (선택) [`LineDash`](#common-linedash) — 선 대시 유형 | — |
2746
+
2747
+ ### 부록 — 입출력 데이터 형식 (Presentation)
2748
+
2749
+ <a id="show-slidefilter"></a>
2750
+ #### `SlideFilter`
2751
+
2752
+ | 항목 | 형식 | 설명 |
2753
+ |---|---|---|
2754
+ | `indexes` (선택) | 숫자 목록 | 0-based 인덱스 목록 (빈 배열은 대상 없음) |
2755
+ | `isHidden` (선택) | 참/거짓 | 숨김 슬라이드 여부 |
2756
+ | `layoutType` (선택) | [`SlideLayoutType`](#show-slidelayouttype) | 레이아웃 종류 |
2757
+ | `textContains` (선택) | 문자열 | 슬라이드 내 포함 텍스트 |
2758
+ | `hasComment` (선택) | 참/거짓 | 댓글 존재 여부 |
2759
+ | `hasTransition` (선택) | 참/거짓 | 전환 효과 존재 여부 |
2760
+
2761
+ <a id="show-headerfooterdate"></a>
2762
+ #### `HeaderFooterDate`
2763
+
2764
+ | 항목 | 형식 | 설명 |
2765
+ |---|---|---|
2766
+ | `format` (선택) | [`DateFormat`](#show-dateformat) | 자동갱신 날짜 형식 (text 지정 시 무시) (기본값: DateFormat.Datetime1) |
2767
+ | `language` (선택) | [`DateLanguage`](#show-datelanguage) | 자동갱신 날짜 언어 (text 지정 시 무시) (기본값: DateLanguage.ENGLISH) |
2768
+ | `text` (선택) | 문자열 | 지정 시 고정 텍스트로 처리 (자동갱신 안 함) |
2769
+
2770
+ <a id="show-colorscheme"></a>
2771
+ #### `ColorScheme`
2772
+
2773
+ | 항목 | 형식 | 설명 |
2774
+ |---|---|---|
2775
+ | `name` | 문자열 | 사용자 정의 색상 테마 이름 |
2776
+ | `tb_color_dark_1` | 문자열 | 텍스트/배경 어두운 색 1 (#RRGGBB) |
2777
+ | `tb_color_light_1` | 문자열 | 텍스트/배경 밝은 색 1 (#RRGGBB) |
2778
+ | `tb_color_dark_2` | 문자열 | 텍스트/배경 어두운 색 2 (#RRGGBB) |
2779
+ | `tb_color_light_2` | 문자열 | 텍스트/배경 밝은 색 2 (#RRGGBB) |
2780
+ | `accent_1` | 문자열 | 강조 색 1 (#RRGGBB) |
2781
+ | `accent_2` | 문자열 | 강조 색 2 (#RRGGBB) |
2782
+ | `accent_3` | 문자열 | 강조 색 3 (#RRGGBB) |
2783
+ | `accent_4` | 문자열 | 강조 색 4 (#RRGGBB) |
2784
+ | `accent_5` | 문자열 | 강조 색 5 (#RRGGBB) |
2785
+ | `accent_6` | 문자열 | 강조 색 6 (#RRGGBB) |
2786
+ | `hyperlink` | 문자열 | 하이퍼링크 색 (#RRGGBB) |
2787
+ | `opened_hyperlink` | 문자열 | 방문한 하이퍼링크 색 (#RRGGBB) |
2788
+
2789
+ <a id="show-shapefilter"></a>
2790
+ #### `ShapeFilter`
2791
+
2792
+ | 항목 | 형식 | 설명 |
2793
+ |---|---|---|
2794
+ | `excludePlaceholder` (선택) | 참/거짓 | placeholder 제외 여부 |
2795
+ | `placeholderType` (선택) | [`PlaceholderType`](#show-placeholdertype) | placeholder 유형 |
2796
+ | `shapeType` (선택) | [`ShapeType`](#show-shapetype) | 도형 종류 |
2797
+ | `presetId` (선택) | `ShapePreset \| ShapePresetFamily \| string \| (ShapePreset \| ShapePresetFamily \| string)[]` | 도형 프리셋. ShapePreset 값(정확 매칭) 또는 ShapePresetFamily 키(계열 매칭). 배열로 여러 개 지정 가능 |
2798
+ | `textContains` (선택) | 문자열 | 도형 텍스트에 포함된 문자열 |
2799
+ | `hasText` (선택) | 참/거짓 | 텍스트 존재 여부 |
2800
+ | `fillType` (선택) | [`FillType`](#show-filltype) | 채우기 유형 |
2801
+ | `fillColor` (선택) | 문자열 | 채우기 색상 (hex) |
2802
+ | `hasLine` (선택) | 참/거짓 | 선 존재 여부 |
2803
+ | `lineColor` (선택) | 문자열 | 선 색상 (hex) |
2804
+ | `position` (선택) | [`GridPosition`](#show-gridposition) | 슬라이드 9등분 기준 위치 |
2805
+ | `size` (선택) | [`SizeCategory`](#show-sizecategory) | 슬라이드 대비 상대 크기 |
2806
+ | `hasHyperlink` (선택) | 참/거짓 | 하이퍼링크 존재 여부 |
2807
+ | `hasEffect` (선택) | 참/거짓 | 효과 적용 여부 |
2808
+
2809
+ <a id="show-tablefilter"></a>
2810
+ #### `TableFilter`
2811
+
2812
+ | 항목 | 형식 | 설명 |
2813
+ |---|---|---|
2814
+ | `textContains` (선택) | 문자열 | 셀 텍스트에 포함된 문자열 |
2815
+ | `rowCount` (선택) | 숫자 | 행 수 |
2816
+ | `colCount` (선택) | 숫자 | 열 수 |
2817
+
2818
+ <a id="show-commentfilter"></a>
2819
+ #### `CommentFilter`
2820
+
2821
+ | 항목 | 형식 | 설명 |
2822
+ |---|---|---|
2823
+ | `textContains` (선택) | 문자열 | 댓글 텍스트에 포함된 문자열 |
2824
+ | `isReply` (선택) | 참/거짓 | 답글 여부 |
2825
+
2826
+ <a id="show-transition"></a>
2827
+ #### `Transition`
2828
+
2829
+ | 항목 | 형식 | 설명 |
2830
+ |---|---|---|
2831
+ | `type` | [`TransitionType`](#show-transitiontype) | 전환 효과 종류 |
2832
+ | `speed` (선택) | [`SpeedType`](#show-speedtype) | 전환 속도 (기본값: 효과별 기본 속도) |
2833
+ | `dir` (선택) | [`TransitionEffectDir`](#show-transitioneffectdir) | 전환 방향. 효과별 유효값 상이 — push/cover/pull/wipe/flip:l/r/u/d, comb:horz/vert, split/plus/zoom:in/out, strips:lu/ld/ru/rd (기본값: 효과별 기본 방향) |
2834
+ | `orient` (선택) | [`TransitionEffectDir`](#show-transitioneffectdir) | 분할 방향 (SPLIT 효과 전용: horz\|vert) (기본값: 효과 기본값) |
2835
+ | `thruBlack` (선택) | 참/거짓 | 검은 화면을 거쳐 전환 (FADE/CUT 효과 전용) (기본값: false) |
2836
+ | `advTm` (선택) | 숫자 | 자동 진행 시간 (ms) (기본값: 자동 진행 안 함) |
2837
+ | `advClick` (선택) | 참/거짓 | 클릭으로 진행 여부 (기본값: true) |
2838
+
2839
+ <a id="show-chartfilter"></a>
2840
+ #### `ChartFilter`
2841
+
2842
+ | 항목 | 형식 | 설명 |
2843
+ |---|---|---|
2844
+ | `chartType` (선택) | [`ChartType`](#common-charttype) | 차트 종류 필터 |
2845
+
2846
+ <a id="show-commentposition"></a>
2847
+ #### `CommentPosition`
2848
+
2849
+ | 항목 | 형식 | 설명 |
2850
+ |---|---|---|
2851
+ | `x` | 숫자 | X 좌표 (px 단위) |
2852
+ | `y` | 숫자 | Y 좌표 (px 단위) |
2853
+
2854
+ <a id="show-shapetransform"></a>
2855
+ #### `ShapeTransform`
2856
+
2857
+ | 항목 | 형식 | 설명 |
2858
+ |---|---|---|
2859
+ | `x` | 숫자 | 좌상단 X 좌표 (px 단위, 반전·회전과 무관한 모델 기준) |
2860
+ | `y` | 숫자 | 좌상단 Y 좌표 (px 단위, 반전·회전과 무관한 모델 기준) |
2861
+ | `width` | 숫자 | 너비 (px 단위) |
2862
+ | `height` | 숫자 | 높이 (px 단위) |
2863
+ | `angle` | 숫자 | 회전 각도 (degree) |
2864
+
2865
+ <a id="show-hyperlink"></a>
2866
+ #### `Hyperlink`
2867
+
2868
+ | 항목 | 형식 | 설명 |
2869
+ |---|---|---|
2870
+ | `type` | [`HyperlinkType`](#show-hyperlinktype) | 하이퍼링크 타입 (url/email/slideJump/showJump/file) |
2871
+ | `urlOrEmail` (선택) | 문자열 | url/email 일 때의 대상 (email 은 mailto 접두어 제거) |
2872
+ | `slide` (선택) | [`Slide`](#show-slide) | slideJump 일 때 대상 슬라이드 |
2873
+ | `showJumpType` (선택) | [`ShowJumpType`](#show-showjumptype) | showJump 일 때 쇼 점프 유형 |
2874
+ | `path` (선택) | 문자열 | file 일 때 파일 경로 |
2875
+
2876
+ <a id="show-shapemovedistance"></a>
2877
+ #### `ShapeMoveDistance`
2878
+
2879
+ | 항목 | 형식 | 설명 |
2880
+ |---|---|---|
2881
+ | `x` (선택) | 숫자 | X 이동량 (px 단위, 양수 = 오른쪽). 생략하면 X 는 이동하지 않음 |
2882
+ | `y` (선택) | 숫자 | Y 이동량 (px 단위, 양수 = 아래). 생략하면 Y 는 이동하지 않음 |
2883
+
2884
+ <a id="show-fill"></a>
2885
+ #### `Fill`
2886
+
2887
+ | 항목 | 형식 | 설명 |
2888
+ |---|---|---|
2889
+ | `type` | [`FillType`](#show-filltype) | 채우기 종류 (apiConstants.FillType). getFill 출력과 findShapes({fillType}) 필터가 같은 어휘를 쓴다 |
2890
+ | `color` (선택) | 문자열 | solid: hex "#RRGGBB" 또는 scheme color |
2891
+ | `alpha` (선택) | 숫자 | solid/image: 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2892
+ | `gradientType` (선택) | [`GradientType`](#show-gradienttype) | gradient: 그라데이션 유형(lin/circle/rect/shape) |
2893
+ | `angle` (선택) | 숫자 | gradient: 각도(degree). 조회값은 0.1도 단위이며 [0, 360) 으로 정규화된다(360 은 0) |
2894
+ | `stops` (선택) | `{ color: string; pos?: number; alpha?: number }[]` | gradient: 색상 변화점 |
2895
+ | `fillMode` (선택) | [`ImageFillMode`](#show-imagefillmode) | image: 이미지 채우기 방식 |
2896
+ | `embed` (선택) | 문자열 | image: 같은 문서 안 setFill 왕복용 업로드 리소스 id |
2897
+ | `width` (선택) | 숫자 | image: 원본 이미지 너비 (px) |
2898
+ | `height` (선택) | 숫자 | image: 원본 이미지 높이 (px) |
2899
+ | `offset` (선택) | `{ x: number; y: number }` | image: 바둑판 오프셋 (pt). fillMode=ImageFillMode.TILE 일 때만 존재 |
2900
+ | `scale` (선택) | `{ x: number; y: number }` | image: 바둑판 배율 (%). fillMode=ImageFillMode.TILE 일 때만 존재 |
2901
+ | `mirror` (선택) | [`ImageTileFlip`](#show-imagetileflip) | image: 바둑판 대칭. fillMode=ImageFillMode.TILE 일 때만 존재 |
2902
+ | `align` (선택) | [`RectAlign`](#show-rectalign) | image: 바둑판 정렬 기준점. fillMode=ImageFillMode.TILE 일 때만 존재 |
2903
+ | `rotateWithShape` (선택) | 참/거짓 | image: 도형과 함께 회전 여부 (tile/stretch 공통) |
2904
+ | `preset` (선택) | [`PatternPreset`](#show-patternpreset) | pattern: 무늬 프리셋 (apiConstants.PatternPreset) |
2905
+ | `foreColor` (선택) | 문자열 | pattern: 전경색 (hex "#RRGGBB"/scheme) |
2906
+ | `backColor` (선택) | 문자열 | pattern: 배경색 (hex "#RRGGBB"/scheme) |
2907
+ | `foreAlpha` (선택) | 숫자 | pattern: 전경색 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2908
+ | `backAlpha` (선택) | 숫자 | pattern: 배경색 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2909
+
2910
+ <a id="show-linestyle"></a>
2911
+ #### `LineStyle`
2912
+
2913
+ | 항목 | 형식 | 설명 |
2914
+ |---|---|---|
2915
+ | `type` | [`FillType`](#show-filltype) | 선 채우기 종류 (apiConstants.FillType). getFill 출력과 같은 어휘 |
2916
+ | `color` (선택) | 문자열 (없을 수 있음) | solid: 선 색상 (hex "#RRGGBB"/scheme) |
2917
+ | `alpha` (선택) | 숫자 | solid: 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2918
+ | `gradientType` (선택) | [`GradientType`](#show-gradienttype) | gradient: 그라데이션 유형(lin/circle/rect/shape) |
2919
+ | `stops` (선택) | `{ color: string; pos?: number; alpha?: number }[]` | gradient: 색상 변화점 |
2920
+ | `angle` (선택) | 숫자 | gradient: 각도(degree). 조회값은 0.1도 단위이며 [0, 360) 으로 정규화된다(360 은 0) |
2921
+ | `width` | 숫자 (없을 수 있음) | 선 두께 (pt). 선 없음(noFill)이어도 두께는 그대로 담긴다 |
2922
+ | `dash` | [`LineDash`](#common-linedash) (없을 수 있음) | 선 대시 유형 |
2923
+ | `cap` | [`LineCap`](#show-linecap) (없을 수 있음) | 선 끝 모양 |
2924
+ | `join` | [`LineJoin`](#show-linejoin) (없을 수 있음) | 선 연결(모서리) 유형 |
2925
+
2926
+ <a id="show-lineend"></a>
2927
+ #### `LineEnd`
2928
+
2929
+ | 항목 | 형식 | 설명 |
2930
+ |---|---|---|
2931
+ | `type` | [`LineEndType`](#show-lineendtype) | 화살표 타입 |
2932
+ | `width` | [`LineEndSize`](#show-lineendsize) | 화살표 너비 |
2933
+ | `length` | [`LineEndSize`](#show-lineendsize) | 화살표 길이 |
2934
+
2935
+ <a id="show-imagecrop"></a>
2936
+ #### `ImageCrop`
2937
+
2938
+ | 항목 | 형식 | 설명 |
2939
+ |---|---|---|
2940
+ | `left` | 숫자 | 왼쪽 crop 퍼센트 |
2941
+ | `top` | 숫자 | 위쪽 crop 퍼센트 |
2942
+ | `right` | 숫자 | 오른쪽 crop 퍼센트 |
2943
+ | `bottom` | 숫자 | 아래쪽 crop 퍼센트 |
2944
+
2945
+ <a id="show-bulletstyle"></a>
2946
+ #### `BulletStyle`
2947
+
2948
+ | 항목 | 형식 | 설명 |
2949
+ |---|---|---|
2950
+ | `type` | [`BulletType`](#show-bullettype) | 글머리 기호 유형 |
2951
+ | `subType` (선택) | `NumberedType \| CharType` | BulletType.AUTO_NUM: 번호 매기기 유형, BulletType.CHAR: 글머리 문자 유형 (CharType 7종 프리셋의 문자와 글꼴이 모두 일치할 때만 포함) |
2952
+ | `startAt` (선택) | 숫자 | 시작 번호 (BulletType.AUTO_NUM 일 때만 포함) |
2953
+ | `char` (선택) | 문자열 | 글머리 문자 원문 (BulletType.CHAR 일 때만 포함. 프리셋 밖의 문자도 그대로 반환) |
2954
+
2955
+ <a id="show-outershadow"></a>
2956
+ #### `OuterShadow`
2957
+
2958
+ | 항목 | 형식 | 설명 |
2959
+ |---|---|---|
2960
+ | `color` (선택) | 문자열 | hex (#RRGGBB) 또는 scheme color (기본값: "#000000") |
2961
+ | `alpha` (선택) | 숫자 | 투명도 (0~100, 0=불투명) (기본값: 50) |
2962
+ | `blur` (선택) | 숫자 | 흐림 반경 (pt) (기본값: 6) |
2963
+ | `dist` (선택) | 숫자 | 거리 (pt) (기본값: 6) |
2964
+ | `dir` (선택) | 숫자 | 방향 (degree) (기본값: 90) |
2965
+ | `sx` (선택) | 숫자 | 가로 배율 (%) (기본값: 100) |
2966
+ | `sy` (선택) | 숫자 | 세로 배율 (%) (기본값: 100) |
2967
+ | `kx` (선택) | 숫자 | 가로 기울임 (degree) (기본값: 0) |
2968
+ | `ky` (선택) | 숫자 | 세로 기울임 (degree) (기본값: 0) |
2969
+ | `algn` (선택) | [`RectAlign`](#show-rectalign) | 정렬 기준 (기본값: RectAlign.CENTER) |
2970
+ | `rotWithShape` (선택) | 참/거짓 | 도형 회전 연동 (기본값: false) |
2971
+
2972
+ <a id="show-innershadow"></a>
2973
+ #### `InnerShadow`
2974
+
2975
+ | 항목 | 형식 | 설명 |
2976
+ |---|---|---|
2977
+ | `color` (선택) | 문자열 | hex (#RRGGBB) 또는 scheme color (기본값: "#000000") |
2978
+ | `alpha` (선택) | 숫자 | 투명도 (0~100, 0=불투명) (기본값: 50) |
2979
+ | `blur` (선택) | 숫자 | 흐림 반경 (pt) (기본값: 6) |
2980
+ | `dist` (선택) | 숫자 | 거리 (pt) (기본값: 6) |
2981
+ | `dir` (선택) | 숫자 | 방향 (degree) (기본값: 90) |
2982
+
2983
+ <a id="show-glow"></a>
2984
+ #### `Glow`
2985
+
2986
+ | 항목 | 형식 | 설명 |
2987
+ |---|---|---|
2988
+ | `color` (선택) | 문자열 | hex (#RRGGBB) 또는 scheme color (기본값: "#356FFF") |
2989
+ | `alpha` (선택) | 숫자 | 투명도 (0~100, 0=불투명) (기본값: 50) |
2990
+ | `rad` (선택) | 숫자 | 광선 반경 (pt) (기본값: 10) |
2991
+
2992
+ <a id="show-softedge"></a>
2993
+ #### `SoftEdge`
2994
+
2995
+ | 항목 | 형식 | 설명 |
2996
+ |---|---|---|
2997
+ | `rad` (선택) | 숫자 | 반경 (pt) (기본값: 5) |
2998
+
2999
+ <a id="show-reflection"></a>
3000
+ #### `Reflection`
3001
+
3002
+ | 항목 | 형식 | 설명 |
3003
+ |---|---|---|
3004
+ | `blur` (선택) | 숫자 | 흐림 반경 (pt) (기본값: 0.5) |
3005
+ | `dist` (선택) | 숫자 | 거리 (pt) (기본값: 0) |
3006
+ | `stPos` (선택) | 숫자 | 시작 위치 (0~100). 렌더링에는 반영되지 않는다 (기본값: 0) |
3007
+ | `endPos` (선택) | 숫자 | 반사 크기 (0~100) (기본값: 50) |
3008
+ | `startAlpha` (선택) | 숫자 | 시작 투명도 (0~100, 0=불투명) (기본값: 50) |
3009
+ | `endAlpha` (선택) | 숫자 | 끝 투명도 (0~100, 0=불투명) (기본값: 99.7) |
3010
+ | `dir` (선택) | 숫자 | 방향 (degree). 렌더링에는 반영되지 않는다 (기본값: 90) |
3011
+ | `fadeDir` (선택) | 숫자 | 페이드 방향 (degree). 렌더링에는 반영되지 않는다 (기본값: 90) |
3012
+ | `sx` (선택) | 숫자 | 가로 배율 (%) (기본값: 100) |
3013
+ | `sy` (선택) | 숫자 | 세로 배율 (%) (기본값: -100) |
3014
+ | `kx` (선택) | 숫자 | 가로 기울임 (degree) (기본값: 0) |
3015
+ | `ky` (선택) | 숫자 | 세로 기울임 (degree) (기본값: 0) |
3016
+ | `algn` (선택) | [`RectAlign`](#show-rectalign) | 정렬 기준 (기본값: RectAlign.BOTTOM_LEFT) |
3017
+ | `rotWithShape` (선택) | 참/거짓 | 도형 회전 연동 (기본값: false) |
3018
+
3019
+ <a id="show-effects"></a>
3020
+ #### `Effects`
3021
+
3022
+ | 항목 | 형식 | 설명 |
3023
+ |---|---|---|
3024
+ | `outerShadow` (선택) | [`OuterShadow`](#show-outershadow) | 외부 그림자 |
3025
+ | `innerShadow` (선택) | [`InnerShadow`](#show-innershadow) | 내부 그림자 |
3026
+ | `glow` (선택) | [`Glow`](#show-glow) | 네온(광선) |
3027
+ | `softEdge` (선택) | [`SoftEdge`](#show-softedge) | 옅은 테두리 |
3028
+ | `reflection` (선택) | [`Reflection`](#show-reflection) | 반사 |
3029
+ | `scene3d` (선택) | [`Scene3d`](#show-scene3d) | 카메라(회전) 3D |
3030
+ | `sp3d` (선택) | [`Sp3d`](#show-sp3d) | 입체(깊이) 3D |
3031
+
3032
+ <a id="show-imagefilldetail"></a>
3033
+ #### `ImageFillDetail`
3034
+
3035
+ | 항목 | 형식 | 설명 |
3036
+ |---|---|---|
3037
+ | `offset` (선택) | `{ x?: number; y?: number }` | 바둑판 오프셋 (pt) (기본값: {x: 0, y: 0}) |
3038
+ | `scale` (선택) | `{ x?: number; y?: number }` | 바둑판 배율 (%) (기본값: {x: 100, y: 100}) |
3039
+ | `mirror` (선택) | [`ImageTileFlip`](#show-imagetileflip) | 바둑판 대칭 (기본값: ImageTileFlip.NONE) |
3040
+ | `align` (선택) | [`RectAlign`](#show-rectalign) | 바둑판 정렬 기준점 (기본값: RectAlign.TOP_LEFT) |
3041
+ | `rotateWithShape` (선택) | 참/거짓 | 도형과 함께 회전 여부. 생략하면 기존 동작 유지 (모델 기본 true) |
3042
+
3043
+ <a id="show-scene3d"></a>
3044
+ #### `Scene3d`
3045
+
3046
+ | 항목 | 형식 | 설명 |
3047
+ |---|---|---|
3048
+ | `prst` (선택) | 문자열 | camera 프리셋 (orthographicFront, isometricLeftDown 등) |
3049
+ | `x` (선택) | 숫자 | longitude (degree) |
3050
+ | `y` (선택) | 숫자 | latitude (degree) |
3051
+ | `z` (선택) | 숫자 | revolution (degree) |
3052
+
3053
+ <a id="show-sp3d"></a>
3054
+ #### `Sp3d`
3055
+
3056
+ | 항목 | 형식 | 설명 |
3057
+ |---|---|---|
3058
+ | `z` (선택) | 숫자 | z 값 (pt 단위) |
3059
+
3060
+ <a id="show-adjustvalue"></a>
3061
+ #### `AdjustValue`
3062
+
3063
+ | 항목 | 형식 | 설명 |
3064
+ |---|---|---|
3065
+ | `name` | 문자열 | 조절값 이름 |
3066
+ | `value` | 숫자 | 현재 조절값(단위 기준 정수) |
3067
+ | `min` | 숫자 (없을 수 있음) | 설정 가능한 최솟값, 범위를 알 수 없으면 null |
3068
+ | `max` | 숫자 (없을 수 있음) | 설정 가능한 최댓값, 범위를 알 수 없으면 null |
3069
+ | `unit` | 문자열 (없을 수 있음) | 값의 단위 (pct 는 1/1000%, ang 는 1/60000도). 범위를 알 수 없으면 null |
3070
+
3071
+ <a id="show-adjustvalueupdate"></a>
3072
+ #### `AdjustValueUpdate`
3073
+
3074
+ | 항목 | 형식 | 설명 |
3075
+ |---|---|---|
3076
+ | `name` | 문자열 | 조절값 이름(getAdjustValues 결과) |
3077
+ | `value` | 숫자 | 조절값. 정수로 반올림되며 허용 범위를 벗어나면 최솟값 또는 최댓값으로 제한됨 |
3078
+
3079
+ <a id="show-cellfilter"></a>
3080
+ #### `CellFilter`
3081
+
3082
+ | 항목 | 형식 | 설명 |
3083
+ |---|---|---|
3084
+ | `range` (선택) | `{ startRow: number; startCol: number; endRow: number; endCol: number }` | 셀 범위 (0-based, inclusive) |
3085
+ | `rowIndex` (선택) | 숫자 | 특정 행만 (0-based, 대표 셀 기준) |
3086
+ | `colIndex` (선택) | 숫자 | 특정 열만 (0-based, 대표 셀 기준) |
3087
+ | `isEmpty` (선택) | 참/거짓 | true: 텍스트가 비어 있는 셀, false: 텍스트가 있는 셀 |
3088
+ | `isMerged` (선택) | 참/거짓 | true: 병합 대표 셀, false: 단일 셀 |
3089
+ | `textContains` (선택) | 문자열 | 셀 텍스트에 포함된 문자열 |
3090
+ | `fillColor` (선택) | 문자열 | 셀 배경색 일치 (hex "#RRGGBB", 대소문자 무시, 스타일 상속분 미포함) |
3091
+ | `hasFill` (선택) | 참/거짓 | tcPr 에 fill 이 명시적으로 설정됐는지 (스타일 상속분 미포함) |
3092
+ | `hasBorder` (선택) | 참/거짓 | tcPr 에 상하좌우 테두리 1개 이상 명시적으로 설정됐는지 (스타일 상속분 미포함) |
3093
+
3094
+ <a id="show-borderstyle"></a>
3095
+ #### `BorderStyle`
3096
+
3097
+ | 항목 | 형식 | 설명 |
3098
+ |---|---|---|
3099
+ | `color` | 문자열 (없을 수 있음) | 테두리 색상 (hex "#RRGGBB"). 색 없음이면 null |
3100
+ | `width` | 숫자 (없을 수 있음) | 선 두께 (pt) |
3101
+ | `dash` | [`LineDash`](#common-linedash) (없을 수 있음) | 선 대시 유형 |
3102
+
3103
+ <a id="show-textrange"></a>
3104
+ #### `TextRange`
3105
+
3106
+ | 항목 | 형식 | 설명 |
3107
+ |---|---|---|
3108
+ | `from` | 숫자 | 시작 글자 offset (0-based) |
3109
+ | `to` | 숫자 | 끝 글자 offset (포함) |
3110
+
3111
+ <a id="show-fontstyle"></a>
3112
+ #### `FontStyle`
3113
+
3114
+ | 항목 | 형식 | 설명 |
3115
+ |---|---|---|
3116
+ | `fontSize` (선택) | 숫자 | 글자 크기 (pt) |
3117
+ | `bold` (선택) | 참/거짓 | 굵게 여부 |
3118
+ | `italic` (선택) | 참/거짓 | 기울임 여부 |
3119
+ | `underline` (선택) | [`Underline`](#show-underline) | 밑줄 유형 |
3120
+ | `strike` (선택) | [`Strike`](#show-strike) | 취소선 유형 |
3121
+ | `textColor` (선택) | 문자열 | 글자 색상 (hex #RRGGBB 또는 scheme color) |
3122
+ | `fontFamily` (선택) | 문자열 | 글꼴 이름 |
3123
+ | `baselineShift` (선택) | 숫자 | 기준선 이동 (양수: 위 첨자, 음수: 아래 첨자) |
3124
+
3125
+ <a id="show-paragraphstyle"></a>
3126
+ #### `ParagraphStyle`
3127
+
3128
+ | 항목 | 형식 | 설명 |
3129
+ |---|---|---|
3130
+ | `alignH` (선택) | [`TextAlignH`](#show-textalignh) | 가로 정렬 |
3131
+ | `lineSpacing` (선택) | 숫자 | 줄 간격 값. MULTIPLE 이면 배수 백분율(150=1.5배), EXACT 이면 pt |
3132
+ | `lineSpacingType` (선택) | [`LineSpacingType`](#show-linespacingtype) | 줄 간격 유형 (기본값: LineSpacingType.MULTIPLE) |
3133
+ | `marginLeft` (선택) | 숫자 | 단락 전체의 왼쪽 여백 (pt) |
3134
+ | `firstLineIndent` (선택) | 숫자 | 첫 줄에만 적용되는 들여쓰기 (pt). 양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음 |
3135
+ | `spaceBefore` (선택) | 숫자 | 단락 앞 간격 (pt) |
3136
+ | `spaceAfter` (선택) | 숫자 | 단락 뒤 간격 (pt) |
3137
+
3138
+ ### 부록 — 상수 목록 (Presentation)
3139
+
3140
+ <a id="show-shapetype"></a>
3141
+ #### `ShapeType`
3142
+
3143
+ 도형 종류 (모델 shape type 값). 도형 조회·판별에서 도형의 유형을 구분하는 값으로 사용한다.
3144
+
3145
+ | 상수 | 설명 |
3146
+ |---|---|
3147
+ | `SHAPE` | 일반 도형 |
3148
+ | `IMAGE` | 이미지(그림) |
3149
+ | `CONNECTOR` | 연결선 |
3150
+ | `GROUP` | 그룹 |
3151
+ | `CHART` | 차트 |
3152
+ | `TABLE` | 표 |
3153
+ | `DIAGRAM` | 다이어그램 |
3154
+ | `OLE_OBJECT` | OLE 개체 |
3155
+ | `CONTROL` | 컨트롤 개체 |
3156
+
3157
+ <a id="show-placeholdertype"></a>
3158
+ #### `PlaceholderType`
3159
+
3160
+ 슬라이드 레이아웃의 개체 틀(placeholder) 종류 (OOXML ST_PlaceholderType).
3161
+
3162
+ | 상수 | 설명 |
3163
+ |---|---|
3164
+ | `TITLE` | 제목 |
3165
+ | `CTR_TITLE` | 가운데 제목 (제목 슬라이드용) |
3166
+ | `SUB_TITLE` | 부제목 |
3167
+ | `BODY` | 본문 |
3168
+ | `OBJECT` | 개체(내용) |
3169
+ | `CHART` | 차트 |
3170
+ | `TABLE` | 표 |
3171
+ | `CLIP_ART` | 클립아트 |
3172
+ | `DIAGRAM` | 다이어그램 |
3173
+ | `MEDIA` | 미디어 |
3174
+ | `DATE` | 날짜 |
3175
+ | `SLIDE_NUM` | 슬라이드 번호 |
3176
+ | `FOOTER` | 바닥글 |
3177
+ | `HEADER` | 머리글 (유인물·슬라이드 노트용) |
3178
+ | `PICTURE` | 그림 |
3179
+ | `SLIDE_IMAGE` | 슬라이드 이미지 (슬라이드 노트용) |
3180
+
3181
+ <a id="show-slidelayouttype"></a>
3182
+ #### `SlideLayoutType`
3183
+
3184
+ 슬라이드 레이아웃 종류 (OOXML ST_SlideLayoutType).
3185
+ setLayout/insertSlide/findSlides 에서 레이아웃을 지정·필터하는 값으로 사용한다.
3186
+ 한 마스터에 같은 type 이 여럿일 수 있으며, 이때는 순서상 첫 번째가 선택된다.
3187
+
3188
+ | 상수 | 설명 |
3189
+ |---|---|
3190
+ | `TITLE` | 제목 슬라이드 |
3191
+ | `TX` | 제목과 텍스트 |
3192
+ | `TWO_COL_TX` | 제목과 2단 텍스트 |
3193
+ | `TBL` | 제목과 표 |
3194
+ | `TX_AND_CHART` | 텍스트(왼쪽)와 차트(오른쪽) |
3195
+ | `CHART_AND_TX` | 차트(왼쪽)와 텍스트(오른쪽) |
3196
+ | `DGM` | 다이어그램 |
3197
+ | `CHART` | 차트 |
3198
+ | `TX_AND_CLIP_ART` | 텍스트와 클립아트 |
3199
+ | `CLIP_ART_AND_TX` | 클립아트와 텍스트 |
3200
+ | `TITLE_ONLY` | 제목만 |
3201
+ | `BLANK` | 빈 화면 |
3202
+ | `TX_AND_OBJ` | 텍스트와 개체 |
3203
+ | `OBJ_AND_TX` | 개체와 텍스트 |
3204
+ | `OBJ_ONLY` | 개체만 |
3205
+ | `OBJ` | 제목과 개체 |
3206
+ | `TX_AND_MEDIA` | 텍스트와 미디어 |
3207
+ | `MEDIA_AND_TX` | 미디어와 텍스트 |
3208
+ | `OBJ_OVER_TX` | 텍스트 위에 개체 |
3209
+ | `TX_OVER_OBJ` | 개체 위에 텍스트 |
3210
+ | `TX_AND_TWO_OBJ` | 텍스트와 개체 2개 |
3211
+ | `TWO_OBJ_AND_TX` | 개체 2개와 텍스트 |
3212
+ | `TWO_OBJ_OVER_TX` | 텍스트 위에 개체 2개 |
3213
+ | `FOUR_OBJ` | 개체 4개 |
3214
+ | `VERT_TX` | 세로 텍스트 |
3215
+ | `CLIP_ART_AND_VERT_TX` | 클립아트와 세로 텍스트 |
3216
+ | `VERT_TITLE_AND_TX` | 세로 제목과 텍스트 |
3217
+ | `VERT_TITLE_AND_TX_OVER_CHART` | 세로 제목과 차트 위 텍스트 |
3218
+ | `TWO_OBJ` | 개체 2개 |
3219
+ | `OBJ_AND_TWO_OBJ` | 개체 1개와 개체 2개 |
3220
+ | `TWO_OBJ_AND_OBJ` | 개체 2개와 개체 1개 |
3221
+ | `CUST` | 사용자 정의 |
3222
+ | `SEC_HEAD` | 구역 머리글 |
3223
+ | `TWO_TX_TWO_OBJ` | 텍스트 2개와 개체 2개 |
3224
+ | `OBJ_TX` | 제목, 개체, 캡션 텍스트 |
3225
+ | `PIC_TX` | 그림과 캡션 텍스트 |
3226
+
3227
+ <a id="show-viewmode"></a>
3228
+ #### `ViewMode`
3229
+
3230
+ 보기 배율/맞춤.
3231
+
3232
+ | 상수 | 설명 |
3233
+ |---|---|
3234
+ | `FIT_IN_WINDOW` | 창 크기에 맞춤 |
3235
+ | `ZOOM_50` | 50% |
3236
+ | `ZOOM_75` | 75% |
3237
+ | `ZOOM_100` | 100% |
3238
+ | `ZOOM_150` | 150% |
3239
+ | `ZOOM_200` | 200% |
3240
+ | `ZOOM_300` | 300% |
3241
+ | `ZOOM_400` | 400% |
3242
+
3243
+ <a id="show-selectscope"></a>
3244
+ #### `SelectScope`
3245
+
3246
+ 모두 선택(select_all) 범위.
3247
+
3248
+ | 상수 | 설명 |
3249
+ |---|---|
3250
+ | `SHAPE` | 현재 슬라이드의 모든 도형 |
3251
+ | `SLIDE` | 모든 슬라이드 |
3252
+ | `TEXT` | 편집 중인 텍스트 전체 |
3253
+
3254
+ <a id="show-runproperty"></a>
3255
+ #### `RunProperty`
3256
+
3257
+ 텍스트 런(run) 서식 속성 이름. 서식 조회·적용 시 대상 속성을 지정하는 키로 사용한다.
3258
+
3259
+ | 상수 | 설명 |
3260
+ |---|---|
3261
+ | `FONT_SIZE` | 글자 크기 |
3262
+ | `BOLD` | 굵게 |
3263
+ | `ITALIC` | 기울임꼴 |
3264
+ | `UNDERLINE` | 밑줄 |
3265
+ | `STRIKE` | 취소선 |
3266
+ | `FONT_FAMILY` | 글꼴 |
3267
+ | `BASELINE_SHIFT` | 기준선 이동(위/아래 첨자) |
3268
+
3269
+ <a id="show-flipdirection"></a>
3270
+ #### `FlipDirection`
3271
+
3272
+ 도형 대칭(뒤집기) 방향.
3273
+
3274
+ | 상수 | 설명 |
3275
+ |---|---|
3276
+ | `HORIZONTAL` | 좌우 대칭 |
3277
+ | `VERTICAL` | 상하 대칭 |
3278
+
3279
+ <a id="show-effecttype"></a>
3280
+ #### `EffectType`
3281
+
3282
+ 도형 효과 종류 — 그림자·반사·네온·부드러운 가장자리.
3283
+
3284
+ | 상수 | 설명 |
3285
+ |---|---|
3286
+ | `OUTER_SHADOW` | 바깥쪽 그림자 |
3287
+ | `INNER_SHADOW` | 안쪽 그림자 |
3288
+ | `REFLECTION` | 반사 |
3289
+ | `GLOW` | 네온 |
3290
+ | `SOFT_EDGE` | 부드러운 가장자리 |
3291
+
3292
+ <a id="show-linecap"></a>
3293
+ #### `LineCap`
3294
+
3295
+ 선 끝 모양 (OOXML ST_LineCap).
3296
+
3297
+ | 상수 | 설명 |
3298
+ |---|---|
3299
+ | `FLAT` | 평면 끝 |
3300
+ | `ROUND` | 둥근 끝 |
3301
+ | `SQUARE` | 사각형 끝 |
3302
+
3303
+ <a id="show-linejoin"></a>
3304
+ #### `LineJoin`
3305
+
3306
+ 선 연결(모서리) 모양.
3307
+
3308
+ | 상수 | 설명 |
3309
+ |---|---|
3310
+ | `ROUND` | 둥근 모서리 |
3311
+ | `BEVEL` | 빗면(경사) 모서리 |
3312
+ | `MITER` | 각진 모서리 |
3313
+
3314
+ <a id="show-lineendtype"></a>
3315
+ #### `LineEndType`
3316
+
3317
+ 선 끝 화살표 머리 모양 (OOXML ST_LineEndType).
3318
+
3319
+ | 상수 | 설명 |
3320
+ |---|---|
3321
+ | `NONE` | 없음 |
3322
+ | `TRIANGLE` | 삼각형 화살표 |
3323
+ | `STEALTH` | 스텔스(오목한) 화살표 |
3324
+ | `DIAMOND` | 마름모 |
3325
+ | `OVAL` | 원형 |
3326
+ | `ARROW` | 열린 화살표 |
3327
+
3328
+ <a id="show-lineendsize"></a>
3329
+ #### `LineEndSize`
3330
+
3331
+ 선 끝 화살표 머리 크기.
3332
+
3333
+ | 상수 | 설명 |
3334
+ |---|---|
3335
+ | `SMALL` | 작게 |
3336
+ | `MEDIUM` | 보통 |
3337
+ | `LARGE` | 크게 |
3338
+
3339
+ <a id="show-textalignh"></a>
3340
+ #### `TextAlignH`
3341
+
3342
+ 텍스트 가로 정렬 (OOXML ST_TextAlignType).
3343
+
3344
+ | 상수 | 설명 |
3345
+ |---|---|
3346
+ | `LEFT` | 왼쪽 정렬 |
3347
+ | `CENTER` | 가운데 정렬 |
3348
+ | `RIGHT` | 오른쪽 정렬 |
3349
+ | `JUSTIFY` | 양쪽 맞춤 |
3350
+ | `DISTRIBUTE` | 균등 분할 |
3351
+
3352
+ <a id="show-linespacingtype"></a>
3353
+ #### `LineSpacingType`
3354
+
3355
+ 줄 간격 지정 방식.
3356
+
3357
+ | 상수 | 설명 |
3358
+ |---|---|
3359
+ | `MULTIPLE` | 줄 높이의 배수 |
3360
+ | `EXACT` | 고정 값(포인트) |
3361
+
3362
+ <a id="show-speedtype"></a>
3363
+ #### `SpeedType`
3364
+
3365
+ 슬라이드 전환 속도 (모델 spd 값).
3366
+
3367
+ | 상수 | 설명 |
3368
+ |---|---|
3369
+ | `SLOW` | 느리게 |
3370
+ | `MED` | 보통 |
3371
+ | `FAST` | 빠르게 |
3372
+
3373
+ <a id="show-transitiontype"></a>
3374
+ #### `TransitionType`
3375
+
3376
+ 슬라이드 전환 효과 종류 (setTransition 의 type).
3377
+
3378
+ | 상수 | 설명 |
3379
+ |---|---|
3380
+ | `NONE` | 없음 |
3381
+ | `RANDOM` | 임의(무작위 전환) |
3382
+ | `FADE` | 밝기 변화 |
3383
+ | `PUSH` | 밀어내기 |
3384
+ | `COVER` | 덮기 |
3385
+ | `CUT` | 자르기 |
3386
+ | `SPLIT` | 나누기 |
3387
+ | `WIPE` | 닦아내기 |
3388
+ | `STRIPS` | 대각선 닦아내기 |
3389
+ | `PULL` | 당기기(벗기기) |
3390
+ | `COMB` | 빗질 |
3391
+ | `CIRCLE` | 원형 |
3392
+ | `DIAMOND` | 마름모형 |
3393
+ | `PLUS` | 십자형 |
3394
+ | `ZOOM` | 확대/축소 |
3395
+ | `WHEEL` | 시계 방향 회전 |
3396
+ | `WHEEL_REVERSE` | 시계 반대 방향 회전 |
3397
+ | `WEDGE` | 쐐기형 |
3398
+ | `FLIP` | 넘기기(뒤집기) |
3399
+
3400
+ <a id="show-transitioneffectdir"></a>
3401
+ #### `TransitionEffectDir`
3402
+
3403
+ 슬라이드 전환 방향 / 분할 방향 (setTransition 의 dir·orient).
3404
+
3405
+ | 상수 | 설명 |
3406
+ |---|---|
3407
+ | `DOWN` | 아래로 |
3408
+ | `LEFT` | 왼쪽으로 |
3409
+ | `RIGHT` | 오른쪽으로 |
3410
+ | `UP` | 위로 |
3411
+ | `LEFT_DOWN` | 왼쪽 아래로 |
3412
+ | `LEFT_UP` | 왼쪽 위로 |
3413
+ | `RIGHT_DOWN` | 오른쪽 아래로 |
3414
+ | `RIGHT_UP` | 오른쪽 위로 |
3415
+ | `IN` | 안쪽으로 |
3416
+ | `OUT` | 바깥쪽으로 |
3417
+ | `HORIZONTAL` | 가로 (분할 방향) |
3418
+ | `VERTICAL` | 세로 (분할 방향) |
3419
+
3420
+ <a id="show-dateformat"></a>
3421
+ #### `DateFormat`
3422
+
3423
+ 머리글/바닥글 날짜 자동갱신(update) 모드의 날짜 표시 형식 (모델 fldType 값).
3424
+ 실제 출력 문자열은 언어(DateLanguage)에 따라 달라진다.
3425
+ 값은 Const.FldType 에서 파생하며, 날짜 형식이 아닌 SlideNum 과
3426
+ datetime1 과 동일한 기본 sentinel 인 DatetimeFigureOut 은 제외한다.
3427
+
3428
+ 형식 참고(기본 언어): datetime1=2026-06-30, datetime2=전체 날짜+요일, datetime3=특수 연호,
3429
+ datetime4=년 월 일, datetime5=2026/6/30, datetime6=년 월, datetime7=특수 연호 년 월,
3430
+ datetime8=날짜+시:분:초, datetime9=날짜+오전/오후 시:분, datetime10=시:분,
3431
+ datetime11=시:분:초, datetime12=오전/오후 시:분, datetime13=오전/오후 시:분:초
3432
+
3433
+ | 상수 | 설명 |
3434
+ |---|---|
3435
+ | `Datetime1` | 년-월-일 (예: 2026-06-30) |
3436
+ | `Datetime2` | 전체 날짜와 요일 (예: 2026년 6월 30일 화요일) |
3437
+ | `Datetime3` | 연호 날짜 (한국어·일본어 전용) |
3438
+ | `Datetime4` | 년 월 일 |
3439
+ | `Datetime5` | 년/월/일 (예: 2026/6/30) |
3440
+ | `Datetime6` | 년 월 |
3441
+ | `Datetime7` | 연호 년 월 (한국어·일본어 전용) |
3442
+ | `Datetime8` | 날짜 + 시:분:초 |
3443
+ | `Datetime9` | 날짜 + 오전/오후 시:분 |
3444
+ | `Datetime10` | 시:분 |
3445
+ | `Datetime11` | 시:분:초 |
3446
+ | `Datetime12` | 오전/오후 시:분 |
3447
+ | `Datetime13` | 오전/오후 시:분:초 |
3448
+
3449
+ <a id="show-datelanguage"></a>
3450
+ #### `DateLanguage`
3451
+
3452
+ 머리글/바닥글 날짜의 언어 (모델 fontScript 값).
3453
+
3454
+ | 상수 | 설명 |
3455
+ |---|---|
3456
+ | `ENGLISH` | 영어(미국) |
3457
+ | `KOREAN` | 한국어 |
3458
+ | `JAPANESE` | 일본어 |
3459
+ | `RUSSIAN` | 러시아어 |
3460
+
3461
+ <a id="show-bullettype"></a>
3462
+ #### `BulletType`
3463
+
3464
+ 글머리 기호 종류 (모델 bullet type 값).
3465
+
3466
+ | 상수 | 설명 |
3467
+ |---|---|
3468
+ | `NONE` | 글머리 없음 |
3469
+ | `CHAR` | 문자 글머리 기호 |
3470
+ | `AUTO_NUM` | 자동 번호 매기기 |
3471
+ | `BLIP` | 그림 글머리 기호 |
3472
+
3473
+ <a id="show-underline"></a>
3474
+ #### `Underline`
3475
+
3476
+ 밑줄 스타일 (OOXML ST_TextUnderlineType).
3477
+
3478
+ | 상수 | 설명 |
3479
+ |---|---|
3480
+ | `NONE` | 없음 |
3481
+ | `WORDS` | 단어에만(공백 제외) |
3482
+ | `SINGLE` | 실선 |
3483
+ | `DOUBLE` | 이중선 |
3484
+ | `HEAVY` | 굵은 실선 |
3485
+ | `DOTTED` | 점선 |
3486
+ | `DOTTED_HEAVY` | 굵은 점선 |
3487
+ | `DASH` | 파선 |
3488
+ | `DASH_HEAVY` | 굵은 파선 |
3489
+ | `DASH_LONG` | 긴 파선 |
3490
+ | `DASH_LONG_HEAVY` | 굵은 긴 파선 |
3491
+ | `DOT_DASH` | 일점쇄선(점·파선) |
3492
+ | `DOT_DASH_HEAVY` | 굵은 일점쇄선 |
3493
+ | `DOT_DOT_DASH` | 이점쇄선(점·점·파선) |
3494
+ | `DOT_DOT_DASH_HEAVY` | 굵은 이점쇄선 |
3495
+ | `WAVY` | 물결선 |
3496
+ | `WAVY_HEAVY` | 굵은 물결선 |
3497
+ | `WAVY_DOUBLE` | 이중 물결선 |
3498
+
3499
+ <a id="show-strike"></a>
3500
+ #### `Strike`
3501
+
3502
+ 취소선 스타일 (OOXML ST_TextStrikeType).
3503
+
3504
+ | 상수 | 설명 |
3505
+ |---|---|
3506
+ | `NONE` | 없음 |
3507
+ | `SINGLE` | 한 줄 취소선 |
3508
+ | `DOUBLE` | 두 줄 취소선 |
3509
+
3510
+ <a id="show-autofittype"></a>
3511
+ #### `AutoFitType`
3512
+
3513
+ 텍스트 자동 맞춤 방식 (OOXML bodyPr autofit).
3514
+
3515
+ | 상수 | 설명 |
3516
+ |---|---|
3517
+ | `NO_AUTOFIT` | 자동 맞춤 안 함 |
3518
+ | `NORMAL` | 넘치면 텍스트 크기 축소 |
3519
+ | `SHAPE_AUTOFIT` | 텍스트에 맞춰 도형 크기 조정 |
3520
+
3521
+ <a id="show-writemode"></a>
3522
+ #### `WriteMode`
3523
+
3524
+ 텍스트 쓰기 방향 (OOXML ST_TextVerticalType).
3525
+
3526
+ | 상수 | 설명 |
3527
+ |---|---|
3528
+ | `HORIZONTAL` | 가로쓰기 |
3529
+ | `VERTICAL_EAST` | 세로쓰기(동아시아 글자는 세워서 표시) |
3530
+ | `VERTICAL` | 세로쓰기(전체 90° 회전) |
3531
+ | `VERTICAL_270` | 세로쓰기(270° 회전) |
3532
+ | `WORDART_VERTICAL_RTL` | 워드아트 세로쓰기(오른쪽에서 왼쪽) |
3533
+ | `WORDART_VERTICAL` | 워드아트 세로쓰기(글자를 세로로 쌓음) |
3534
+ | `MONGOLIAN_VERTICAL` | 몽골식 세로쓰기(위에서 아래, 줄은 왼쪽에서 오른쪽) |
3535
+
3536
+ <a id="show-commentstyle"></a>
3537
+ #### `CommentStyle`
3538
+
3539
+ 댓글 메모 스타일(색 프리셋). 값 순서는 메모 스타일 목록 1~10 과 같다.
3540
+
3541
+ | 상수 | 설명 |
3542
+ |---|---|
3543
+ | `PINK` | 분홍 |
3544
+ | `ORANGE` | 주황 |
3545
+ | `YELLOW` | 노랑 |
3546
+ | `LIGHT_GREEN` | 연두 |
3547
+ | `GREEN` | 초록 |
3548
+ | `SKY_BLUE` | 하늘 |
3549
+ | `BLUE` | 파랑 |
3550
+ | `NAVY` | 남색 |
3551
+ | `PURPLE` | 보라 |
3552
+ | `GRAY` | 회색 |
3553
+
3554
+ <a id="show-textalignv"></a>
3555
+ #### `TextAlignV`
3556
+
3557
+ 텍스트 세로 정렬 — 세로 위치와 가로 가운데 배치 여부의 조합 (모델 anchor·anchorCtr).
3558
+
3559
+ | 상수 | 설명 |
3560
+ |---|---|
3561
+ | `TOP` | 위쪽 |
3562
+ | `MIDDLE` | 세로 가운데 |
3563
+ | `BOTTOM` | 아래쪽 |
3564
+ | `TOP_CENTER` | 위쪽 + 가로 가운데 |
3565
+ | `MIDDLE_CENTER` | 세로 가운데 + 가로 가운데 |
3566
+ | `BOTTOM_CENTER` | 아래쪽 + 가로 가운데 |
3567
+
3568
+ <a id="show-numberedtype"></a>
3569
+ #### `NumberedType`
3570
+
3571
+ 번호 매기기 유형 (BulletType.AUTO_NUM 용).
3572
+ 값은 Const.Bullet.Numbered.Type 에서 파생하며, 내부 sentinel 인 NOT_SUPPORTED 는 제외한다.
3573
+
3574
+ | 상수 | 설명 |
3575
+ |---|---|
3576
+ | `NUMBER_WITH_DOT` | 1. 2. 3. |
3577
+ | `CIRCLE_NUMBER` | ① ② ③ |
3578
+ | `ROMAN_NUMERAL_UPPERCASE` | I. II. III. |
3579
+ | `UPPERCASE_ALPHABET` | A. B. C. |
3580
+ | `NUMBER_WITH_ROUND_BRACKET` | 1) 2) 3) |
3581
+ | `LOWERCASE_ALPHABET` | a. b. c. |
3582
+ | `CHINESE` | 一. 二. 三. (한자 숫자) |
3583
+ | `ROMAN_NUMERAL_LOWERCASE` | i. ii. iii. |
3584
+ | `LOWERCASE_ALPHABET_WITH_ROUND_BRACKET` | a) b) c) |
3585
+
3586
+ <a id="show-chartype"></a>
3587
+ #### `CharType`
3588
+
3589
+ 글머리 문자 스타일 (BulletType.CHAR 용, Const.Bullet.Char.InfoMap 의 키와 동일)
3590
+
3591
+ | 상수 | 설명 |
3592
+ |---|---|
3593
+ | `DOT` | • (Arial) |
3594
+ | `DIAMOND` | ◆ (Wingdings) |
3595
+ | `SQUARE` | ▪ (Wingdings) |
3596
+ | `CIRCLE` | ● (Wingdings) |
3597
+ | `FOUR_DIAMONDS` | ❖ (Wingdings) |
3598
+ | `ARROW` | ➢ (Wingdings) |
3599
+ | `CHECK` | ✓ (Wingdings) |
3600
+
3601
+ <a id="show-hyperlinktype"></a>
3602
+ #### `HyperlinkType`
3603
+
3604
+ 하이퍼링크 종류.
3605
+
3606
+ | 상수 | 설명 |
3607
+ |---|---|
3608
+ | `URL` | 웹 주소 |
3609
+ | `EMAIL` | 이메일 주소 |
3610
+ | `SLIDE_JUMP` | 문서 안 슬라이드로 이동 |
3611
+ | `SHOW_JUMP` | 쇼 진행 이동(다음/이전 슬라이드 등) |
3612
+ | `FILE` | 파일 링크 |
3613
+
3614
+ <a id="show-showjumptype"></a>
3615
+ #### `ShowJumpType`
3616
+
3617
+ 쇼 점프(showJump) 대상. 쇼 모드 액션 맵(actionHandlerShowMode 의 _showJumpMap)이
3618
+ 참조하는 상수를 그대로 쓴다.
3619
+
3620
+ | 상수 | 설명 |
3621
+ |---|---|
3622
+ | `FIRST` | 첫 슬라이드로 |
3623
+ | `LAST` | 마지막 슬라이드로 |
3624
+ | `NEXT` | 다음 슬라이드로 |
3625
+ | `PREV` | 이전 슬라이드로 |
3626
+ | `EXIT` | 쇼 마침 |
3627
+ | `LAST_VIEWED` | 마지막으로 본 슬라이드로 |
3628
+
3629
+ <a id="show-gradienttype"></a>
3630
+ #### `GradientType`
3631
+
3632
+ 그라데이션 채우기 모양.
3633
+
3634
+ | 상수 | 설명 |
3635
+ |---|---|
3636
+ | `LINEAR` | 선형 |
3637
+ | `CIRCLE` | 원형(방사형) |
3638
+ | `RECT` | 사각형 |
3639
+ | `SHAPE` | 도형 모양 따라 |
3640
+
3641
+ <a id="show-filltype"></a>
3642
+ #### `FillType`
3643
+
3644
+ 채우기 유형 (모델 fill type 값, ShapeConst 와 동일).
3645
+
3646
+ | 상수 | 설명 |
3647
+ |---|---|
3648
+ | `SOLID` | 단색 채우기 |
3649
+ | `GRADIENT` | 그라데이션 채우기 |
3650
+ | `NONE` | 채우기 없음 |
3651
+ | `IMAGE` | 그림 채우기 |
3652
+ | `PATTERN` | 패턴(무늬) 채우기 |
3653
+
3654
+ <a id="show-imagefillmode"></a>
3655
+ #### `ImageFillMode`
3656
+
3657
+ 이미지 채우기 방식.
3658
+
3659
+ | 상수 | 설명 |
3660
+ |---|---|
3661
+ | `STRETCH` | 늘이기 |
3662
+ | `TILE` | 바둑판식 배열 |
3663
+
3664
+ <a id="show-imagetileflip"></a>
3665
+ #### `ImageTileFlip`
3666
+
3667
+ 이미지 채우기 바둑판(tile) 대칭.
3668
+
3669
+ | 상수 | 설명 |
3670
+ |---|---|
3671
+ | `NONE` | 대칭 없음 |
3672
+ | `HORIZONTAL` | 가로 대칭 |
3673
+ | `VERTICAL` | 세로 대칭 |
3674
+ | `BOTH` | 가로·세로 대칭 |
3675
+
3676
+ <a id="show-rectalign"></a>
3677
+ #### `RectAlign`
3678
+
3679
+ 사각 영역 기준 정렬점 (OOXML ST_RectAlignment).
3680
+ 바둑판 채우기 정렬·그림자/반사 배치(algn)가 같은 값 집합을 쓴다.
3681
+
3682
+ | 상수 | 설명 |
3683
+ |---|---|
3684
+ | `TOP_LEFT` | 왼쪽 위 |
3685
+ | `TOP` | 위쪽 |
3686
+ | `TOP_RIGHT` | 오른쪽 위 |
3687
+ | `LEFT` | 왼쪽 |
3688
+ | `CENTER` | 가운데 |
3689
+ | `RIGHT` | 오른쪽 |
3690
+ | `BOTTOM_LEFT` | 왼쪽 아래 |
3691
+ | `BOTTOM` | 아래쪽 |
3692
+ | `BOTTOM_RIGHT` | 오른쪽 아래 |
3693
+
3694
+ <a id="show-patternpreset"></a>
3695
+ #### `PatternPreset`
3696
+
3697
+ 패턴(무늬) 채우기 프리셋 (OOXML ST_PresetPatternVal 전체 54종).
3698
+
3699
+ | 상수 | 설명 |
3700
+ |---|---|
3701
+ | `PERCENT_5` | 5% 음영 |
3702
+ | `PERCENT_10` | 10% 음영 |
3703
+ | `PERCENT_20` | 20% 음영 |
3704
+ | `PERCENT_25` | 25% 음영 |
3705
+ | `PERCENT_30` | 30% 음영 |
3706
+ | `PERCENT_40` | 40% 음영 |
3707
+ | `PERCENT_50` | 50% 음영 |
3708
+ | `PERCENT_60` | 60% 음영 |
3709
+ | `PERCENT_70` | 70% 음영 |
3710
+ | `PERCENT_75` | 75% 음영 |
3711
+ | `PERCENT_80` | 80% 음영 |
3712
+ | `PERCENT_90` | 90% 음영 |
3713
+ | `LIGHT_DOWNWARD_DIAGONAL` | 밝은 하향 대각선 |
3714
+ | `LIGHT_UPWARD_DIAGONAL` | 밝은 상향 대각선 |
3715
+ | `DARK_DOWNWARD_DIAGONAL` | 어두운 하향 대각선 |
3716
+ | `DARK_UPWARD_DIAGONAL` | 어두운 상향 대각선 |
3717
+ | `WIDE_DOWNWARD_DIAGONAL` | 넓은 하향 대각선 |
3718
+ | `WIDE_UPWARD_DIAGONAL` | 넓은 상향 대각선 |
3719
+ | `LIGHT_VERTICAL` | 밝은 세로선 |
3720
+ | `LIGHT_HORIZONTAL` | 밝은 가로선 |
3721
+ | `NARROW_VERTICAL` | 좁은 세로선 |
3722
+ | `NARROW_HORIZONTAL` | 좁은 가로선 |
3723
+ | `DARK_VERTICAL` | 어두운 세로선 |
3724
+ | `DARK_HORIZONTAL` | 어두운 가로선 |
3725
+ | `DASHED_DOWNWARD_DIAGONAL` | 파선 하향 대각선 |
3726
+ | `DASHED_UPWARD_DIAGONAL` | 파선 상향 대각선 |
3727
+ | `DASHED_HORIZONTAL` | 파선 가로선 |
3728
+ | `DASHED_VERTICAL` | 파선 세로선 |
3729
+ | `SMALL_CONFETTI` | 작은 색종이 |
3730
+ | `LARGE_CONFETTI` | 큰 색종이 |
3731
+ | `ZIGZAG` | 지그재그 |
3732
+ | `WAVE` | 물결 |
3733
+ | `DIAGONAL_BRICK` | 대각선 벽돌 |
3734
+ | `HORIZONTAL_BRICK` | 가로 벽돌 |
3735
+ | `WEAVE` | 짜임 |
3736
+ | `PLAID` | 격자 무늬(체크) |
3737
+ | `DIVOT` | 잔디 |
3738
+ | `DOTTED_GRID` | 점선 격자 |
3739
+ | `DOTTED_DIAMOND` | 점선 마름모 |
3740
+ | `SHINGLE` | 지붕널 |
3741
+ | `TRELLIS` | 격자 울타리 |
3742
+ | `SPHERE` | 구 모양 |
3743
+ | `SMALL_GRID` | 작은 격자 |
3744
+ | `LARGE_GRID` | 큰 격자 |
3745
+ | `SMALL_CHECKER_BOARD` | 작은 바둑판 |
3746
+ | `LARGE_CHECKER_BOARD` | 큰 바둑판 |
3747
+ | `OUTLINED_DIAMOND` | 윤곽선 마름모 |
3748
+ | `SOLID_DIAMOND` | 단색 마름모 |
3749
+ | `HORIZONTAL` | 가로선 |
3750
+ | `VERTICAL` | 세로선 |
3751
+ | `CROSS` | 십자 |
3752
+ | `DOWNWARD_DIAGONAL` | 하향 대각선 |
3753
+ | `UPWARD_DIAGONAL` | 상향 대각선 |
3754
+ | `DIAGONAL_CROSS` | 대각선 십자 |
3755
+
3756
+ <a id="show-aligntype"></a>
3757
+ #### `AlignType`
3758
+
3759
+ 도형 정렬 기준 (슬라이드 영역 기준 개별 정렬).
3760
+
3761
+ | 상수 | 설명 |
3762
+ |---|---|
3763
+ | `LEFT` | 왼쪽 맞춤 |
3764
+ | `CENTER` | 가운데 맞춤(가로) |
3765
+ | `RIGHT` | 오른쪽 맞춤 |
3766
+ | `TOP` | 위쪽 맞춤 |
3767
+ | `MIDDLE` | 중간 맞춤(세로) |
3768
+ | `BOTTOM` | 아래쪽 맞춤 |
3769
+
3770
+ <a id="show-distributedirection"></a>
3771
+ #### `DistributeDirection`
3772
+
3773
+ 도형 균등 분배(distribute) 방향 - 여러 도형 사이 간격을 동일하게 재배치.
3774
+
3775
+ | 상수 | 설명 |
3776
+ |---|---|
3777
+ | `HORIZONTAL` | 가로 균등 분배 |
3778
+ | `VERTICAL` | 세로 균등 분배 |
3779
+
3780
+ <a id="show-gridposition"></a>
3781
+ #### `GridPosition`
3782
+
3783
+ 슬라이드 9등분 기준 위치 (도형 center 기준).
3784
+
3785
+ | 상수 | 설명 |
3786
+ |---|---|
3787
+ | `TOP_LEFT` | 왼쪽 위 |
3788
+ | `TOP_CENTER` | 위 가운데 |
3789
+ | `TOP_RIGHT` | 오른쪽 위 |
3790
+ | `CENTER_LEFT` | 왼쪽 가운데 |
3791
+ | `CENTER` | 정중앙 |
3792
+ | `CENTER_RIGHT` | 오른쪽 가운데 |
3793
+ | `BOTTOM_LEFT` | 왼쪽 아래 |
3794
+ | `BOTTOM_CENTER` | 아래 가운데 |
3795
+ | `BOTTOM_RIGHT` | 오른쪽 아래 |
3796
+
3797
+ <a id="show-sizecategory"></a>
3798
+ #### `SizeCategory`
3799
+
3800
+ 슬라이드 면적 대비 상대 크기 (small ~10%↓ / medium ~10~40% / large ~40%↑).
3801
+
3802
+ | 상수 | 설명 |
3803
+ |---|---|
3804
+ | `SMALL` | 작게(슬라이드 면적의 약 10% 미만) |
3805
+ | `MEDIUM` | 보통(약 10~40%) |
3806
+ | `LARGE` | 크게(약 40% 이상) |
3807
+
3808
+ <a id="show-borderposition"></a>
3809
+ #### `BorderPosition`
3810
+
3811
+ 표 셀 테두리 위치.
3812
+
3813
+ | 상수 | 설명 |
3814
+ |---|---|
3815
+ | `TOP` | 위쪽 테두리 |
3816
+ | `BOTTOM` | 아래쪽 테두리 |
3817
+ | `LEFT` | 왼쪽 테두리 |
3818
+ | `RIGHT` | 오른쪽 테두리 |
3819
+ | `DIAGONAL_DOWN` | 하향 대각선(↘) |
3820
+ | `DIAGONAL_UP` | 상향 대각선(↗) |
3821
+ | `ALL` | 모든 테두리 |
3822
+
3823
+ <a id="show-insertposition"></a>
3824
+ #### `InsertPosition`
3825
+
3826
+ 표 행/열 삽입 위치 — 기준 셀을 기준으로 어느 쪽에 넣을지.
3827
+
3828
+ | 상수 | 설명 |
3829
+ |---|---|
3830
+ | `ABOVE` | 기준 행의 위 |
3831
+ | `BELOW` | 기준 행의 아래 |
3832
+ | `LEFT` | 기준 열의 왼쪽 |
3833
+ | `RIGHT` | 기준 열의 오른쪽 |
3834
+
3835
+ <a id="show-tablestyleoption"></a>
3836
+ #### `TableStyleOption`
3837
+
3838
+ 표 스타일 강조 옵션 — 머리글 행·줄무늬 행처럼 켜고 끄는 강조 영역.
3839
+
3840
+ | 상수 | 설명 |
3841
+ |---|---|
3842
+ | `FIRST_ROW` | 머리글 행 |
3843
+ | `LAST_ROW` | 요약 행(마지막 행) |
3844
+ | `BAND_ROW` | 줄무늬 행 |
3845
+ | `FIRST_COL` | 첫째 열 |
3846
+ | `LAST_COL` | 마지막 열 |
3847
+ | `BAND_COL` | 줄무늬 열 |
3848
+
3849
+ <a id="show-tablestylecolor"></a>
3850
+ #### `TableStyleColor`
3851
+
3852
+ 표 프리셋 스타일 색상 그룹.
3853
+
3854
+ | 상수 | 설명 |
3855
+ |---|---|
3856
+ | `TX1` | 테마 텍스트 1 색 |
3857
+ | `ACCENT1` | 테마 강조 1 색 |
3858
+ | `ACCENT2` | 테마 강조 2 색 |
3859
+ | `ACCENT3` | 테마 강조 3 색 |
3860
+ | `ACCENT4` | 테마 강조 4 색 |
3861
+ | `ACCENT5` | 테마 강조 5 색 |
3862
+ | `ACCENT6` | 테마 강조 6 색 |
3863
+
3864
+ <a id="show-tablestyletype"></a>
3865
+ #### `TableStyleType`
3866
+
3867
+ 표 프리셋 스타일 명도 타입.
3868
+
3869
+ | 상수 | 설명 |
3870
+ |---|---|
3871
+ | `GENERIC1` | 일반 스타일 1 |
3872
+ | `GENERIC2` | 일반 스타일 2 |
3873
+ | `LIGHT1` | 밝은 스타일 1 |
3874
+ | `LIGHT2` | 밝은 스타일 2 |
3875
+ | `LIGHT3` | 밝은 스타일 3 |
3876
+ | `NORMAL1` | 중간 스타일 1 |
3877
+ | `NORMAL2` | 중간 스타일 2 |
3878
+ | `NORMAL3` | 중간 스타일 3 |
3879
+ | `NORMAL4` | 중간 스타일 4 |
3880
+ | `DARK1` | 어두운 스타일 1 |
3881
+ | `DARK2` | 어두운 스타일 2 |
3882
+
3883
+ <a id="show-shapepresetfamily"></a>
3884
+ #### `ShapePresetFamily`
3885
+
3886
+ ShapePreset family 정의 (family ID → preset 목록).
3887
+ findShapes 의 presetId 에 family 키("rectangle" 등)를 전달하면 해당 계열 전체를, ShapePreset 값("rect" 등)을 전달하면 그 도형만 매칭한다.
3888
+
3889
+ | 상수 | 설명 |
3890
+ |---|---|
3891
+ | `rectangle` | 사각형 계열 — 기본·둥근/잘린 모서리 사각형 |
3892
+ | `arrow` | 화살표 계열 — 블록 화살표·화살표 설명선 |
3893
+ | `basicShape` | 기본 도형 계열 — 원·다각형·괄호·기호 등 |
3894
+ | `star` | 별 계열 — 별·폭발 |
3895
+ | `banner` | 현수막 계열 — 리본·두루마리·물결 |
3896
+ | `callout` | 설명선 계열 — 말풍선·선 설명선 |
3897
+ | `flowchart` | 순서도 계열 — 프로세스·판단·저장소 등 |
3898
+ | `actionButton` | 실행 단추 계열 — 앞으로/뒤로·홈·도움말 등 |
3899
+ | `equation` | 수식 기호 계열 — 더하기·빼기·곱하기·나누기·등호·부등호 |
3900
+ | `line` | 선 계열 — 직선·꺾인 연결선·곡선 연결선 |
3901
+
3902
+ <a id="mod-common"></a>
3903
+ ## Common — 모듈 공통 상수
3904
+
3905
+ 모든 모듈(Word·Cell·Show)에서 동일하게 쓰는 공통 상수입니다. SDK 에서 모듈 구분 없이 flat 이름 하나로 import 해서 사용합니다.
3906
+
3907
+ ### 부록 — 상수 목록 (Common)
3908
+
3909
+ <a id="common-linedash"></a>
3910
+ #### `LineDash`
3911
+
3912
+ 선 대시(점선) 스타일 (OOXML a:prstDash).
3913
+
3914
+ | 상수 | 설명 |
3915
+ |---|---|
3916
+ | `SOLID` | 실선 |
3917
+ | `DOT` | 점선 |
3918
+ | `DASH` | 파선 |
3919
+ | `LG_DASH` | 긴 파선 |
3920
+ | `DASH_DOT` | 파선-점선 |
3921
+ | `LG_DASH_DOT` | 긴 파선-점선 |
3922
+ | `LG_DASH_DOT_DOT` | 긴 파선-점선-점선 |
3923
+ | `SYS_DASH` | 사각 점선 |
3924
+ | `SYS_DOT` | 둥근 점선 |
3925
+ | `SYS_DASH_DOT` | 사각 점선-점선 |
3926
+ | `SYS_DASH_DOT_DOT` | 사각 점선-점선-점선 |
3927
+
3928
+ <a id="common-shapepreset"></a>
3929
+ #### `ShapePreset`
3930
+
3931
+ 클라이언트가 지원하는 OOXML preset geometry 전체 목록.
3932
+ insertShape 의 preset 에 전달해 해당 모양의 도형을 만든다.
3933
+
3934
+ | 상수 | 설명 |
3935
+ |---|---|
3936
+ | `LINE` | 직선 |
3937
+ | `BENT_CONNECTOR` | 꺾인 연결선 |
3938
+ | `CURVED_CONNECTOR` | 곡선 연결선 |
3939
+ | `RECT` | 직사각형 |
3940
+ | `ROUND_RECT` | 둥근 모서리 직사각형 |
3941
+ | `SNIP_1_RECT` | 한쪽 모서리가 잘린 직사각형 |
3942
+ | `SNIP_2_SAME_RECT` | 양쪽 모서리가 잘린 직사각형 |
3943
+ | `SNIP_2_DIAG_RECT` | 대각선 모서리가 잘린 직사각형 |
3944
+ | `SNIP_ROUND_RECT` | 한쪽 모서리는 잘리고 다른 쪽은 둥근 직사각형 |
3945
+ | `ROUND_1_RECT` | 한쪽 모서리가 둥근 직사각형 |
3946
+ | `ROUND_2_SAME_RECT` | 양쪽 모서리가 둥근 직사각형 |
3947
+ | `ROUND_2_DIAG_RECT` | 대각선 모서리가 둥근 직사각형 |
3948
+ | `ELLIPSE` | 타원 |
3949
+ | `TRIANGLE` | 이등변 삼각형 |
3950
+ | `RT_TRIANGLE` | 직각 삼각형 |
3951
+ | `PARALLELOGRAM` | 평행 사변형 |
3952
+ | `TRAPEZOID` | 사다리꼴 |
3953
+ | `DIAMOND` | 다이아몬드(마름모) |
3954
+ | `PENTAGON` | 정오각형 |
3955
+ | `HEXAGON` | 육각형 |
3956
+ | `HEPTAGON` | 칠각형 |
3957
+ | `OCTAGON` | 팔각형 |
3958
+ | `DECAGON` | 십각형 |
3959
+ | `DODECAGON` | 십이각형 |
3960
+ | `PIE_WEDGE` | 1/4 원(파이 조각) |
3961
+ | `PIE` | 부분 원형 |
3962
+ | `CHORD` | 현 |
3963
+ | `TEARDROP` | 눈물 방울 |
3964
+ | `FRAME` | 액자 |
3965
+ | `HALF_FRAME` | 반액자 |
3966
+ | `CORNER` | 모서리 |
3967
+ | `DIAG_STRIPE` | 대각선 줄무늬 |
3968
+ | `PLUS` | 십자형 |
3969
+ | `PLAQUE` | 명판 |
3970
+ | `CAN` | 원통형 |
3971
+ | `CUBE` | 정육면체 |
3972
+ | `BEVEL` | 빗면 |
3973
+ | `DONUT` | 도넛 |
3974
+ | `NO_SMOKING` | 금지 기호 |
3975
+ | `BLOCK_ARC` | 아치형 |
3976
+ | `FOLDED_CORNER` | 접힌 모서리 |
3977
+ | `SMILEY_FACE` | 웃는 얼굴 |
3978
+ | `HEART` | 하트 |
3979
+ | `FUNNEL` | 깔때기 |
3980
+ | `GEAR_6` | 톱니바퀴(6개) |
3981
+ | `GEAR_9` | 톱니바퀴(9개) |
3982
+ | `LIGHTNING_BOLT` | 번개 |
3983
+ | `SUN` | 해 |
3984
+ | `MOON` | 달 |
3985
+ | `CLOUD` | 구름 |
3986
+ | `ARC` | 호 |
3987
+ | `BRACKET_PAIR` | 대괄호 쌍 |
3988
+ | `BRACE_PAIR` | 중괄호 쌍 |
3989
+ | `LEFT_BRACKET` | 왼쪽 대괄호 |
3990
+ | `RIGHT_BRACKET` | 오른쪽 대괄호 |
3991
+ | `LEFT_BRACE` | 왼쪽 중괄호 |
3992
+ | `RIGHT_BRACE` | 오른쪽 중괄호 |
3993
+ | `RIGHT_ARROW` | 오른쪽 화살표 |
3994
+ | `LEFT_ARROW` | 왼쪽 화살표 |
3995
+ | `UP_ARROW` | 위쪽 화살표 |
3996
+ | `DOWN_ARROW` | 아래쪽 화살표 |
3997
+ | `LEFT_RIGHT_ARROW` | 왼쪽/오른쪽 화살표 |
3998
+ | `UP_DOWN_ARROW` | 위쪽/아래쪽 화살표 |
3999
+ | `QUAD_ARROW` | 십자형 화살표 |
4000
+ | `LEFT_RIGHT_UP_ARROW` | 왼쪽/오른쪽/위쪽 화살표 |
4001
+ | `BENT_ARROW` | 굽은 화살표 |
4002
+ | `UTURN_ARROW` | U턴 화살표 |
4003
+ | `LEFT_UP_ARROW` | 왼쪽/위쪽 화살표 |
4004
+ | `BENT_UP_ARROW` | 위로 굽은 화살표 |
4005
+ | `CURVED_RIGHT_ARROW` | 오른쪽으로 구부러진 화살표 |
4006
+ | `CURVED_LEFT_ARROW` | 왼쪽으로 구부러진 화살표 |
4007
+ | `CURVED_UP_ARROW` | 위로 구부러진 화살표 |
4008
+ | `CURVED_DOWN_ARROW` | 아래로 구부러진 화살표 |
4009
+ | `STRIPED_RIGHT_ARROW` | 줄무늬 오른쪽 화살표 |
4010
+ | `NOTCHED_RIGHT_ARROW` | 톱니 모양 오른쪽 화살표 |
4011
+ | `HOME_PLATE` | 오각형(홈플레이트) |
4012
+ | `CHEVRON` | 갈매기형 수장 |
4013
+ | `RIGHT_ARROW_CALLOUT` | 오른쪽 화살표 설명선 |
4014
+ | `LEFT_ARROW_CALLOUT` | 왼쪽 화살표 설명선 |
4015
+ | `UP_ARROW_CALLOUT` | 위쪽 화살표 설명선 |
4016
+ | `DOWN_ARROW_CALLOUT` | 아래쪽 화살표 설명선 |
4017
+ | `LEFT_RIGHT_ARROW_CALLOUT` | 왼쪽/오른쪽 화살표 설명선 |
4018
+ | `UP_DOWN_ARROW_CALLOUT` | 위쪽/아래쪽 화살표 설명선 |
4019
+ | `QUAD_ARROW_CALLOUT` | 십자형 화살표 설명선 |
4020
+ | `CIRCULAR_ARROW` | 원형 화살표 |
4021
+ | `LEFT_CIRCULAR_ARROW` | 왼쪽 원형 화살표 |
4022
+ | `SWOOSH_ARROW` | 곡선 화살표(스우시) |
4023
+ | `LEFT_RIGHT_RIBBON` | 왼쪽/오른쪽 리본 |
4024
+ | `IRREGULAR_SEAL_1` | 폭발: 8pt |
4025
+ | `IRREGULAR_SEAL_2` | 폭발: 14pt |
4026
+ | `STAR_4` | 포인트가 4개인 별 |
4027
+ | `STAR_5` | 포인트가 5개인 별 |
4028
+ | `STAR_6` | 포인트가 6개인 별 |
4029
+ | `STAR_7` | 포인트가 7개인 별 |
4030
+ | `STAR_8` | 포인트가 8개인 별 |
4031
+ | `STAR_10` | 포인트가 10개인 별 |
4032
+ | `STAR_12` | 포인트가 12개인 별 |
4033
+ | `STAR_16` | 포인트가 16개인 별 |
4034
+ | `STAR_24` | 포인트가 24개인 별 |
4035
+ | `STAR_32` | 포인트가 32개인 별 |
4036
+ | `RIBBON_2` | 리본: 위로 기울어짐 |
4037
+ | `RIBBON` | 리본: 아래로 기울어짐 |
4038
+ | `ELLIPSE_RIBBON_2` | 구부러진 리본: 위로 |
4039
+ | `ELLIPSE_RIBBON` | 구부러진 리본: 아래로 |
4040
+ | `VERTICAL_SCROLL` | 세로 두루마리 |
4041
+ | `HORIZONTAL_SCROLL` | 가로 두루마리 |
4042
+ | `WAVE` | 물결 |
4043
+ | `DOUBLE_WAVE` | 이중 물결 |
4044
+ | `WEDGE_RECT_CALLOUT` | 사각형 설명선 |
4045
+ | `WEDGE_ROUND_RECT_CALLOUT` | 둥근 사각형 설명선 |
4046
+ | `WEDGE_ELLIPSE_CALLOUT` | 타원형 설명선 |
4047
+ | `CLOUD_CALLOUT` | 구름 설명선 |
4048
+ | `CALLOUT_1` | 선 설명선 1 |
4049
+ | `CALLOUT_2` | 선 설명선 2 |
4050
+ | `CALLOUT_3` | 선 설명선 3 |
4051
+ | `ACCENT_CALLOUT_1` | 선 설명선 1 (강조선) |
4052
+ | `ACCENT_CALLOUT_2` | 선 설명선 2 (강조선) |
4053
+ | `ACCENT_CALLOUT_3` | 선 설명선 3 (강조선) |
4054
+ | `BORDER_CALLOUT_1` | 선 설명선 1 (테두리) |
4055
+ | `BORDER_CALLOUT_2` | 선 설명선 2 (테두리) |
4056
+ | `BORDER_CALLOUT_3` | 선 설명선 3 (테두리) |
4057
+ | `ACCENT_BORDER_CALLOUT_1` | 선 설명선 1 (강조선+테두리) |
4058
+ | `ACCENT_BORDER_CALLOUT_2` | 선 설명선 2 (강조선+테두리) |
4059
+ | `ACCENT_BORDER_CALLOUT_3` | 선 설명선 3 (강조선+테두리) |
4060
+ | `FLOW_CHART_PROCESS` | 순서도: 처리 |
4061
+ | `FLOW_CHART_ALTERNATE_PROCESS` | 순서도: 대체 처리 |
4062
+ | `FLOW_CHART_DECISION` | 순서도: 판단 |
4063
+ | `FLOW_CHART_INPUT_OUTPUT` | 순서도: 데이터 |
4064
+ | `FLOW_CHART_PREDEFINED_PROCESS` | 순서도: 미리 정의된 처리 |
4065
+ | `FLOW_CHART_INTERNAL_STORAGE` | 순서도: 내부 저장소 |
4066
+ | `FLOW_CHART_DOCUMENT` | 순서도: 문서 |
4067
+ | `FLOW_CHART_MULTIDOCUMENT` | 순서도: 다중 문서 |
4068
+ | `FLOW_CHART_TERMINATOR` | 순서도: 종결 |
4069
+ | `FLOW_CHART_PREPARATION` | 순서도: 준비 |
4070
+ | `FLOW_CHART_MANUAL_INPUT` | 순서도: 수동 입력 |
4071
+ | `FLOW_CHART_MANUAL_OPERATION` | 순서도: 수동 연산 |
4072
+ | `FLOW_CHART_CONNECTOR` | 순서도: 연결자 |
4073
+ | `FLOW_CHART_OFFPAGE_CONNECTOR` | 순서도: 페이지 연결자 |
4074
+ | `FLOW_CHART_PUNCHED_CARD` | 순서도: 카드 |
4075
+ | `FLOW_CHART_PUNCHED_TAPE` | 순서도: 천공 테이프 |
4076
+ | `FLOW_CHART_SUMMING_JUNCTION` | 순서도: 합 접합 |
4077
+ | `FLOW_CHART_OR` | 순서도: 논리합 |
4078
+ | `FLOW_CHART_COLLATE` | 순서도: 대조 |
4079
+ | `FLOW_CHART_SORT` | 순서도: 정렬 |
4080
+ | `FLOW_CHART_EXTRACT` | 순서도: 추출 |
4081
+ | `FLOW_CHART_MERGE` | 순서도: 병합 |
4082
+ | `FLOW_CHART_ONLINE_STORAGE` | 순서도: 저장 데이터 |
4083
+ | `FLOW_CHART_DELAY` | 순서도: 지연 |
4084
+ | `FLOW_CHART_MAGNETIC_TAPE` | 순서도: 순차 액세스 저장소 |
4085
+ | `FLOW_CHART_MAGNETIC_DISK` | 순서도: 자기 디스크 |
4086
+ | `FLOW_CHART_MAGNETIC_DRUM` | 순서도: 직접 액세스 저장소 |
4087
+ | `FLOW_CHART_DISPLAY` | 순서도: 화면 표시 |
4088
+ | `ACTION_BUTTON_BACK_PREVIOUS` | 실행 단추: 뒤로 또는 이전 |
4089
+ | `ACTION_BUTTON_FORWARD_NEXT` | 실행 단추: 앞으로 또는 다음 |
4090
+ | `ACTION_BUTTON_BEGINNING` | 실행 단추: 처음으로 이동 |
4091
+ | `ACTION_BUTTON_END` | 실행 단추: 끝으로 이동 |
4092
+ | `ACTION_BUTTON_HOME` | 실행 단추: 홈으로 이동 |
4093
+ | `ACTION_BUTTON_INFORMATION` | 실행 단추: 정보 |
4094
+ | `ACTION_BUTTON_RETURN` | 실행 단추: 돌아가기 |
4095
+ | `ACTION_BUTTON_MOVIE` | 실행 단추: 비디오 |
4096
+ | `ACTION_BUTTON_DOCUMENT` | 실행 단추: 문서 |
4097
+ | `ACTION_BUTTON_SOUND` | 실행 단추: 소리 |
4098
+ | `ACTION_BUTTON_HELP` | 실행 단추: 도움말 |
4099
+ | `ACTION_BUTTON_BLANK` | 실행 단추: 빈 단추(사용자 지정) |
4100
+ | `MATH_PLUS` | 더하기 기호 |
4101
+ | `MATH_MINUS` | 빼기 기호 |
4102
+ | `MATH_MULTIPLY` | 곱하기 기호 |
4103
+ | `MATH_DIVIDE` | 나누기 기호 |
4104
+ | `MATH_EQUAL` | 등호 |
4105
+ | `MATH_NOT_EQUAL` | 부등호 |
4106
+
4107
+ <a id="common-shapezorder"></a>
4108
+ #### `ShapeZOrder`
4109
+
4110
+ 도형 z-order(앞뒤 순서) 변경 종류.
4111
+
4112
+ | 상수 | 설명 |
4113
+ |---|---|
4114
+ | `FRONT` | 맨 앞으로 |
4115
+ | `BACK` | 맨 뒤로 |
4116
+ | `FORWARD` | 앞으로 (한 단계) |
4117
+ | `BACKWARD` | 뒤로 (한 단계) |
4118
+
4119
+ <a id="common-charttype"></a>
4120
+ #### `ChartType`
4121
+
4122
+ addChart/setType 의 chartType. 단순 (type, range) 생성이 가능한 20종만 있으며,
4123
+ 그 밖의 종류는 CHART_TYPE_UNSUPPORTED 로 거부된다.
4124
+
4125
+ | 상수 | 설명 |
4126
+ |---|---|
4127
+ | `clusteredColumn` | — |
4128
+ | `stackedColumn` | — |
4129
+ | `_3dClusteredColumn` | — |
4130
+ | `_3dStackedColumn` | — |
4131
+ | `clusteredBar` | — |
4132
+ | `stackedBar` | — |
4133
+ | `_3dClusteredBar` | — |
4134
+ | `_3dStackedBar` | — |
4135
+ | `line` | — |
4136
+ | `pie` | — |
4137
+ | `_3dPie` | — |
4138
+ | `explodedPie` | — |
4139
+ | `_3dExplodedPie` | — |
4140
+ | `scatter` | — |
4141
+ | `area` | — |
4142
+ | `stackedArea` | — |
4143
+ | `_3dArea` | — |
4144
+ | `_3dStackedArea` | — |
4145
+ | `doughnut` | — |
4146
+ | `radar` | — |
4147
+
4148
+ <a id="common-chartgridlinetype"></a>
4149
+ #### `ChartGridLineType`
4150
+
4151
+ setGridLine 의 gridType. "none" 은 해당 축 눈금선 숨김.
4152
+
4153
+ | 상수 | 설명 |
4154
+ |---|---|
4155
+ | `none` | — |
4156
+ | `major` | — |
4157
+ | `minor` | — |
4158
+ | `majorMinor` | — |
4159
+
4160
+ <a id="common-chartaxis"></a>
4161
+ #### `ChartAxis`
4162
+
4163
+ setAxisTitle/setGridLine 의 axis — 대상 축을 가리킨다.
4164
+
4165
+ | 상수 | 설명 |
4166
+ |---|---|
4167
+ | `horizontal` | — |
4168
+ | `vertical` | — |
4169
+
4170
+ <a id="common-chartlegendposition"></a>
4171
+ #### `ChartLegendPosition`
4172
+
4173
+ setLegendPosition 의 position. "none" 은 범례 숨김.
4174
+
4175
+ | 상수 | 설명 |
4176
+ |---|---|
4177
+ | `none` | — |
4178
+ | `bottom` | — |
4179
+ | `topRight` | — |
4180
+ | `top` | — |
4181
+ | `right` | — |
4182
+ | `left` | — |
4183
+
4184
+ <a id="common-chartdatalabelposition"></a>
4185
+ #### `ChartDataLabelPosition`
4186
+
4187
+ setDataLabelPosition 의 position. "none" 은 숨김.
4188
+ 차트 타입별 유효 위치는 부분집합이며 위반 시 CHART_DATALABEL_POSITION_INVALID.
4189
+
4190
+ | 상수 | 설명 |
4191
+ |---|---|
4192
+ | `none` | — |
4193
+ | `center` | — |
4194
+ | `insideEnd` | — |
4195
+ | `insideBase` | — |
4196
+ | `outsideEnd` | — |
4197
+ | `bestFit` | — |
4198
+ | `left` | — |
4199
+ | `right` | — |
4200
+ | `top` | — |
4201
+ | `bottom` | — |