@thinkfree.dev/tfo-sdk 0.2.1 → 0.3.0

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.
@@ -1,3740 +0,0 @@
1
- # Thinkfree Office SDK — API 기능 명세
2
-
3
- > 기준일 2026-09-15 · SDK 빌드 시 자동 생성되는 문서입니다 (`npm run generate:doc`).
4
- > dist 안의 원본은 빌드마다 덮어써집니다 — 내용을 편집하려면 전달받은 사본에서 작업하세요.
5
-
6
- 외부 서비스에서 Thinkfree Office 문서(Word · Spreadsheet · Presentation)를 제어할 수 있는 기능 목록입니다.
7
-
8
- ## 목차
9
-
10
- - [**Word**](#mod-word) — 객체 18 · 기능 276
11
- - [Document](#word-worddocument) (문서) — 37
12
- - [Body](#word-wordbody) (본문) — 24
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 · 기능 162
30
- - [Workbook](#cell-workbook) (통합 문서) — 13
31
- - [Worksheet](#cell-worksheet) (워크시트) — 30
32
- - [Chart](#cell-chart) (차트) — 22
33
- - [Filter](#cell-filter) (자동 필터) — 6
34
- - [Name](#cell-name) (이름 정의) — 8
35
- - [Range](#cell-range) (셀 범위) — 74
36
- - [Table](#cell-table) (표) — 9
37
- - [**Presentation**](#mod-show) — 객체 15 · 기능 342
38
- - [Document](#show-document) (문서) — 54
39
- - [Slide](#show-slide) (슬라이드) — 56
40
- - [BasePathShape](#show-basepathshape) (도형 (패스)) — 31
41
- - [BaseShape](#show-baseshape) (도형 공통) — 35
42
- - [Chart](#show-chart) (차트) — 15
43
- - [Comment](#show-comment) (댓글) — 13
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
- The entry point to the document.
64
-
65
- | 기능 | 설명 | 입력 | 결과 |
66
- |---|---|---|---|
67
- | `getParagraph` | Returns the paragraph with the given ID.<br>- The area the paragraph belongs to (body/header/footer) is found and bound automatically, so header/footer paragraphs can be formatted and edited the same way as body paragraphs. | `paragraphId` 문자열 — paragraph ID | paragraph object (area bound automatically)<br>[`WordParagraph`](#word-wordparagraph) |
68
- | `getTable` | Returns the table with the given ID.<br>- The area the table belongs to (body/header/footer/text box) is found and bound automatically, so tables in those areas can be handled the same way. | `tableId` 문자열 — table ID | table object (area bound automatically)<br>[`WordTable`](#word-wordtable) |
69
- | `getRange` | Returns the range at the given coordinates (RangeData), or the whole body when called with no argument.<br>- The area the paragraph belongs to (body/header/footer) is found and bound automatically, so passing the paragraphId of a header/footer paragraph works the same as for the body.<br>- Calling it with no argument is a shortcut for `getBody().getRange(RangePosition.WHOLE)`. A range lives in one area, so this covers the body only, not headers, footers, or notes.<br>- Passing coordinates requires startParaId. An options object without it is rejected right away, so a mistyped key cannot turn into the whole body by accident.<br>- Use `getBody().getRange(RangePosition.START/END)` for the start/end of an area and `getSelection()` for the selection.<br><br><b>Example</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) — coordinate range information. Omit it for the whole body (기본값: whole body) | range object<br>[`WordRange`](#word-wordrange) |
70
- | `getSelection` | Returns the current selection.<br>- If nothing is selected, returns an empty (collapsed) range at the cursor position. | — | selection range<br>[`WordRange`](#word-wordrange) |
71
- | `getBody` | Returns the content area of the document body.<br>- Use it to get body text and structure and to insert paragraphs and tables.<br><br><b>Example</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> | — | document body<br>[`WordBody`](#word-wordbody) |
72
- | `getSection` | Returns the section at the given index.<br>- Use it to get the section's body, header, and footer and for page setup.<br><br><b>Example</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` (선택) 숫자 — section index (0-based, in document order; 0 = first section) (기본값: 0) | section object (the index is validated when header/footer/page setup is called)<br>[`WordSection`](#word-wordsection) |
73
- | `getSections` | Returns the list of sections in the document, in document order. | — | section list (empty array if none)<br>[`WordSection`](#word-wordsection) 목록 |
74
- | `setPageNumber` | Sets or removes the page number in the header or footer.<br>- Creates the area automatically if it does not exist, and replaces any existing page number.<br>- If remove is true, only the page number paragraph is removed. Nothing changes if the area or the number does not exist.<br><br><b>Example</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) — target area (header/footer)<br>`options` (선택) `{ align?: PageNumberAlign; variant?: HeaderFooterVariant; sectionIndex?: number; remove?: boolean }` — page number settings<br> · `align` alignment (left/center/right). Ignored when remove:true (기본값: PageNumberAlign.LEFT)<br> · `variant` header/footer variant (default/first/even) (기본값: HeaderFooterVariant.DEFAULT)<br> · `sectionIndex` 0-based section index (0 = first section) (기본값: 0)<br> · `remove` if true, removes the page number (align ignored) (기본값: false) | — |
75
- | `setChangeTracking` | Turns change tracking (track changes) on or off.<br>- When on, subsequent edits are tracked as insertions/deletions/format changes; when off, editing returns to normal (already recorded changes are kept).<br><br><b>Example</b><pre><code>doc.setChangeTracking(true); // track subsequent edits<br>doc.setChangeTracking(false); // stop tracking, keeping existing tracked changes</code></pre> | `enabled` 참/거짓 — true to turn on, false to turn off | — |
76
- | `isChangeTrackingEnabled` | Returns whether change tracking (track changes) is on. | — | true if on, false if off<br>참/거짓 |
77
- | `save` | Saves the document.<br>- Does nothing if there are no edits or a save is already in progress. | — | — |
78
- | `download` | Downloads the document in its original format. | — | — |
79
- | `print` | Prints the current document.<br>- Uses browser printing on desktop Chrome and Edge; in other environments, converts to PDF and downloads it.<br>- Does nothing if printing is disabled for the document. | — | — |
80
- | `setZoom` | Changes the view zoom.<br><br><b>Example</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) — zoom preset (50~200%), fit (fitWidth/fitInWindow), or step (zoomIn/zoomOut) | — |
81
- | `setFormattingMarks` | Shows or hides all formatting marks (paragraph marks, spaces, tabs, etc.).<br><br><b>Example</b><pre><code>doc.setFormattingMarks(true); // show formatting marks<br>doc.setFormattingMarks(false); // hide formatting marks</code></pre> | `visible` 참/거짓 — true to show, false to hide | — |
82
- | `setBackgroundColor` | Sets or removes the document (page) background color.<br><br><b>Example</b><pre><code>doc.setBackgroundColor("#FFF8DC"); // set page background color<br>doc.setBackgroundColor(null); // remove background color</code></pre> | `color` 문자열 (없을 수 있음) — background color ("#RRGGBB"). null or an empty string removes the background color. | — |
83
- | `setEvenAndOddHeaders` | Sets the whole document to use different headers and footers on odd and even pages.<br><br><b>Example</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 to turn on, false to turn off | — |
84
- | `getBookmark` | Returns the bookmark with the given name.<br>- Entry point for per-bookmark operations such as delete, go to, exists, and info. | `name` 문자열 — bookmark name | bookmark object<br>[`WordBookmark`](#word-wordbookmark) |
85
- | `getBookmarks` | Returns the list of bookmarks in the document.<br><br><b>Example</b><pre><code>doc.getBookmarks(); // get regular bookmarks<br>doc.getBookmarks(true); // include hidden bookmarks</code></pre> | `includeHidden` (선택) 참/거짓 — if true, also includes hidden bookmarks ("_" prefix) (기본값: false) | bookmark list (empty array if none)<br>[`WordBookmark`](#word-wordbookmark) 목록 |
86
- | `getComment` | Returns the comment with the given ID. | `commentId` 문자열 — comment ID | comment object<br>[`WordComment`](#word-wordcomment) |
87
- | `getComments` | Returns the list of comments in the document. | — | comment list<br>[`WordComment`](#word-wordcomment) 목록 |
88
- | `getChangeTrackings` | Returns the list of change tracking entries in the whole document, in document order. | — | change tracking list<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
89
- | `getChangeTracking` | Returns the change tracking entry with the given ID. | `id` 문자열 — change tracking entry ID | change tracking object<br>[`WordChangeTracking`](#word-wordchangetracking) |
90
- | `acceptChangeTrackings` | Accepts all change tracking entries in the whole document at once. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
91
- | `rejectChangeTrackings` | Rejects all change tracking entries in the whole document at once. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
92
- | `getNote` | Returns the footnote or endnote with the given ID. | `noteId` 문자열 — footnote/endnote area ID | note object<br>[`WordNote`](#word-wordnote) |
93
- | `getNotes` | Returns the list of footnotes and endnotes in the document, in document order.<br><br><b>Example</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> | — | footnote/endnote list<br>[`WordNote`](#word-wordnote) 목록 |
94
- | `getFootnotes` | Returns the list of footnotes in the document, in document order. | — | footnote list<br>[`WordNote`](#word-wordnote) 목록 |
95
- | `getEndnotes` | Returns the list of endnotes in the document, in document order. | — | endnote list<br>[`WordNote`](#word-wordnote) 목록 |
96
- | `getStyle` | Returns the style with the given key.<br>- Use it to get or modify style information and the defined formatting. | `style` `Style \| string` — Style enum for built-in styles (value = key); for custom document styles, the style value from getStyles() (e.g. "heading_1"/"strong") | style object<br>[`WordStyle`](#word-wordstyle) |
97
- | `getStyles` | Returns the list of styles defined in the document. | — | style list (empty array if none)<br>[`WordStyle`](#word-wordstyle) 목록 |
98
- | `getShape` | Returns the shape with the given ID.<br>- Returns an object matching the kind of shape: image, chart, or general shape. | `shapeId` 문자열 — shape ID (obtained from getShapes / insertShape) | shape object (picture → WordImage, chart → WordChart)<br>`WordShape \| WordImage \| WordChart` |
99
- | `getShapes` | Returns the list of shapes in the document.<br>- Includes both inline shapes (placed like text) and floating shapes (placed in front of or behind text).<br><br><b>Example</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 }` — list filter<br> · `storyId` target area ID (body if omitted) (기본값: "0")<br> · `type` shape type filter (기본값: all types)<br> · `anchorParagraphId` anchor paragraph filter (기본값: all) | shape list (pictures as WordImage, charts as WordChart; empty array if none)<br>`(WordShape \| WordImage \| WordChart)[]` |
100
- | `getChart` | Returns the chart with the given ID. | `shapeId` 문자열 — chart shape ID (obtained from getCharts / getShapes) | chart object<br>[`WordChart`](#word-wordchart) |
101
- | `getCharts` | Returns the list of charts in the document.<br><br><b>Example</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 }` — list filter<br> · `storyId` target area ID (body if omitted) (기본값: "0")<br> · `anchorParagraphId` anchor paragraph filter (기본값: all) | chart list (empty array if none)<br>[`WordChart`](#word-wordchart) 목록 |
102
- | `getHyperlink` | Returns the hyperlink with the given ID. | `hyperlinkId` 문자열 — hyperlink ID (obtained from range.insertHyperlink / getHyperlinks) | hyperlink object<br>[`WordHyperlink`](#word-wordhyperlink) |
103
- | `getHyperlinks` | Returns the list of hyperlinks in the document (or in a specific area).<br><br><b>Example</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 }` — list filter<br> · `storyId` target area ID (body if omitted) (기본값: "0")<br> · `anchorParagraphId` only links that start in the given paragraph (기본값: whole area) | hyperlink list (empty array if none)<br>[`WordHyperlink`](#word-wordhyperlink) 목록 |
104
-
105
- <a id="word-wordbody"></a>
106
- ### Body — 본문 (`WordBody`)
107
-
108
- Gets and edits a single content area such as the body, header, or footer.
109
-
110
- | 기능 | 설명 | 입력 | 결과 |
111
- |---|---|---|---|
112
- | `getStoryId` | Returns the identifier of this area. | — | ID of the content area<br>문자열 |
113
- | `exists` | Checks whether this content area actually exists.<br>- A header or footer that has not been created yet is created on the first content insertion. | — | true if the area exists, false if it has not been created yet<br>참/거짓 |
114
- | `getRange` | Returns the range for the given position or coordinates within this area.<br><br><b>Example</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)` — coordinate RangeData object, or an area position RangePosition ("whole"/"start"/"end"/"content"); omitted means the whole area (기본값: RangePosition.WHOLE) | range that can be inspected and edited within this area<br>[`WordRange`](#word-wordrange) |
115
- | `select` | Sets this whole area as the on-screen selection (does not change document content).<br><br><b>Example</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" (whole area) / "start" (cursor at the start of the area) / "end" (cursor at the end of the area) (기본값: SelectionMode.SELECT) | — |
116
- | `search` | Searches this area for text or a special character and returns a list of editable ranges.<br><br><b>Example</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 }` — a string searches for text; a `{ character }` object searches for a special character<br>`options` (선택) `{ caseSensitive?: boolean; wholeWord?: boolean }` — text search options (ignored for special character search)<br> · `caseSensitive` case-sensitive matching (기본값: false)<br> · `wholeWord` whole-word matching (기본값: false) | list of matched range proxies (empty array if none)<br>[`WordRange`](#word-wordrange) 목록 |
117
- | `getText` | Returns the entire content of this area as plain text.<br>- For footnotes/endnotes, the automatic number marker and separator space are excluded. | — | full text for reading. Empty string if the area does not exist<br>문자열 |
118
- | `getStructure` | Returns the paragraph/table structure of this area. Empty list if the area does not exist.<br>- The text of a paragraph entry includes the trailing boundary newline — the final "\n" is always the paragraph boundary, so the character count within that paragraph is `text.length - 1`,<br> and a "\n" in the middle is one line-break object (manual line break, page break, or column break).<br><br><b>Example</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 }` — lookup options. The target area is fixed to this body.<br> · `type` get only a specific type (table=tables only / list=list paragraphs only) (기본값: all) | list of paragraph/table entries (document order). id is a common identifier (type tells the kind); type="p" includes text, tables include rows/columns<br>`{ paragraphs: { index: number; type: string; id: string; storyId: string; text?: string; rows?: number; columns?: number }[] }` |
119
- | `getContentHtml` | Returns the entire content of this area as HTML with formatting.<br>- Paragraphs are represented as <p> elements. | — | HTML and paragraph count. Empty string and 0 if the area does not exist<br>`{ html: string; paragraphCount: number }` |
120
- | `getParagraphs` | Returns the list of paragraphs in this area. | — | list of paragraphs that can be inspected and edited. Empty array if the area does not exist<br>[`WordParagraph`](#word-wordparagraph) 목록 |
121
- | `getParagraph` | Returns the paragraph at the given index in this area. | `index` (선택) 숫자 — zero-based paragraph index (기본값: 0) | paragraph that can be inspected and edited. null if the area or that paragraph does not exist<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
122
- | `getComments` | Returns the list of comments in this area. Works only for the body area; other areas return an empty array. | — | array of comment proxies<br>[`WordComment`](#word-wordcomment) 목록 |
123
- | `getChangeTrackings` | Returns the list of change tracking items in this area in document order. | — | array of change tracking proxies<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
124
- | `acceptChangeTrackings` | Accepts all change tracking items in this area. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
125
- | `rejectChangeTrackings` | Rejects all change tracking items in this area. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
126
- | `getNotes` | Returns the list of footnotes/endnotes in the body. (body area only) | — | array of note proxies<br>[`WordNote`](#word-wordnote) 목록 |
127
- | `getFootnotes` | Returns the list of footnotes in the body. (body area only) | — | array of footnote proxies<br>[`WordNote`](#word-wordnote) 목록 |
128
- | `getEndnotes` | Returns the list of endnotes in the body. (body area only) | — | array of endnote proxies<br>[`WordNote`](#word-wordnote) 목록 |
129
- | `insertParagraph` | Inserts a new paragraph; if the position is omitted, appends it at the end of the area.<br>- Creates the area automatically if it does not exist. The new paragraph inherits the direct paragraph formatting of the reference paragraph, such as alignment, spacing, and indentation.<br>- If paragraphId is omitted, the first or last paragraph of the area is used as the reference depending on the insert position.<br>- To reset the inherited direct formatting, call clearFormat() on the returned paragraph.<br><br><b>Example</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` 문자열 — text of the new paragraph<br>`options` (선택) `{ paragraphId?: string; position?: InsertAt }` — insert options<br> · `paragraphId` reference paragraph ID<br> · `position` with a reference paragraph, "before" (above) / "after" (below) relative to that paragraph; without one, the area position "start" (very beginning) / "end" (very end) (기본값: after if a reference paragraph is given, otherwise end) | new paragraph that can be inspected and edited after insertion<br>[`WordParagraph`](#word-wordparagraph) |
130
- | `insertTable` | Inserts a table; if the position is omitted, appends it at the end of the area.<br>- Cannot insert inside a table cell. An error is thrown if the insertion point is inside a cell.<br><br><b>Example</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` 숫자 — number of rows<br>`columns` 숫자 — number of columns<br>`options` (선택) `{ paragraphId?: string; position?: InsertAt; values?: string[][] }` — insert options<br> · `paragraphId` reference paragraph ID<br> · `position` with a reference paragraph, "before" (above) / "after" (below) relative to that paragraph; without one, the area position "start" (very beginning) / "end" (very end) (기본값: after if a reference paragraph is given, otherwise end)<br> · `values` cell values to fill right after creation (2D array; throws before issuing if it exceeds the table size) | proxy of the inserted table<br>[`WordTable`](#word-wordtable) |
131
- | `insertHtml` | Inserts HTML and returns the range of the inserted content.<br>- If the position is omitted, creates a new paragraph at the end of the area and inserts there.<br>- If <img> is included, the images are uploaded first and their src replaced. Images that fail to upload are excluded and the rest is inserted.<br>- Plain text without tags (`"hello"`) and non-block tags (`"<div>abc</div>"`) are also normalized as text within a paragraph,<br> and multi-paragraph HTML (`"<p>a</p><p>b</p>"`) returns a range covering all of those paragraphs.<br>- Since it goes through the same path as paste, **anything paste does not support is not inserted**:<br> - List styles are not applied — `<ul>`/`<ol>`/`<li>` become plain paragraphs without numbers or bullets (set lists separately with `WordParagraph.setList`).<br> - Heading styles are not applied either — `<h1>`~`<h6>` become plain paragraphs without a style (set styles separately with `WordRange.setStyle`).<br> - Tags that are not document content (`<script>`/`<style>`/`<iframe>`, etc.) are discarded along with their inner text.<br>- If change tracking (track changes) is on, the inserted content remains as a revision, as with normal paste (except inside comments).<br>- Because block HTML (`<p>`, `<h1>`, etc.) inserts a paragraph break with each block, **one empty paragraph remains after the last block** (plain text and inline do not leave one).<br><br><b>Example</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 to insert. If an empty string (whitespace-only counts too), returns only an empty range at the insertion point without changing the document<br>`options` (선택) `{ paragraphId?: string; position?: InsertAt }` — insert position options<br> · `paragraphId` reference paragraph ID<br> · `position` without a reference paragraph, creates a new paragraph at "start" (very beginning of the area) / "end" (very end of the area) and inserts into it. With a reference paragraph, this is the **insertion point**, not a sibling position — "after" is the end point of that paragraph, "before" is its start point. "after" appends at the end of the anchor paragraph, so the first content merges into that paragraph (`<p>A</p><p>B</p>` = A merged into the anchor + B as a new paragraph), while "before" becomes a new paragraph before the anchor for block HTML, or merges at the very start of the anchor for inline HTML (기본값: after if a reference paragraph is given, otherwise end) | range of the inserted content. If there is nothing to insert (empty HTML or HTML without content), an empty (collapsed) range at the insertion point. Insertion failures are reported as exceptions.<br>[`WordRange`](#word-wordrange) |
132
- | `replaceAll` | Finds and replaces all matching text within this area.<br>- When called on the body, the scope is the whole body; when called on a header, footer, etc., it is limited to that area.<br><br><b>Example</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` 문자열 — text to find<br>`replaceText` 문자열 — replacement text<br>`options` (선택) `{ caseSensitive?: boolean }` — replace options<br> · `caseSensitive` case-sensitive matching (기본값: false) | number of actual replacements (0 if no match)<br>`{ replacedCount: number }` |
133
- | `insertText` | Puts text into this area, either at the very beginning or in place of the whole content.<br>- Without replace, the text goes in at the very start of the area and the existing content stays.<br>- With replace, the whole content is replaced and a single paragraph is left, so several paragraphs become one.<br>- If the area does not exist yet, it is created and this text becomes its first content.<br>- In a footnote or endnote area, replace keeps the automatic number marker and the space after it and replaces only the text that follows.<br>- Only the text changes — the formatting of the area stays as it is. Apply formatting to the returned range when you need it.<br><br><b>Example</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` 문자열 — text to put in. An empty string with replace empties the area<br>`options` (선택) `{ replace?: boolean }` — insert options<br> · `replace` true replaces the whole content of the area; omitted adds at the very beginning (기본값: false) | range of the text that was put in. For a footnote/endnote replace it covers the first paragraph including the number marker. null when a footnote/endnote has no content to replace<br>[`WordRange`](#word-wordrange) (없을 수 있음) |
134
- | `clear` | Clears the content of this area, leaving one empty paragraph.<br>- The content area itself is kept. | — | true if the area exists (including an already empty area), false if the area does not exist<br>참/거짓 |
135
- | `replaceParagraphs` | Replaces multiple paragraphs in place at once. Changes text only; unless keepFormat is set, resets the formatting of the replaced range. | `items` `{ paragraphId: string; text: string; keepFormat?: boolean }[]` — list of paragraphs to replace, looked up within this area. keepFormat defaults to false (reset formatting) | number of successful replacements<br>숫자 |
136
-
137
- <a id="word-wordbookmark"></a>
138
- ### Bookmark — 책갈피 (`WordBookmark`)
139
-
140
- Looks up a bookmark identified by name, deletes it, or moves to its position.
141
-
142
- | 기능 | 설명 | 입력 | 결과 |
143
- |---|---|---|---|
144
- | `getName` | Returns the bookmark name. | — | bookmark name<br>문자열 |
145
- | `exists` | Returns whether the bookmark exists. | — | true if it exists<br>참/거짓 |
146
- | `delete` | Deletes the bookmark. | — | — |
147
- | `goTo` | Moves the cursor to the bookmark position.<br>- Does not change document content; does nothing if the bookmark does not exist. | — | — |
148
- | `getRange` | Returns the range at which the bookmark marker is placed.<br><br><b>Example</b><pre><code>word.getBookmark("intro").getRange().getLocation(); // get the bookmark position<br>word.getBookmark("intro").getRange().insertText("headerText");</code></pre> | — | marker position range<br>[`WordRange`](#word-wordrange) |
149
-
150
- <a id="word-wordchangetracking"></a>
151
- ### ChangeTracking (`WordChangeTracking`)
152
-
153
- Looks up a change tracking entry and accepts or rejects it.
154
-
155
- | 기능 | 설명 | 입력 | 결과 |
156
- |---|---|---|---|
157
- | `getId` | Returns the ID of the change tracking entry. | — | change tracking entry ID<br>문자열 |
158
- | `exists` | Checks whether the change tracking entry still exists.<br>- An entry that has been accepted or rejected is considered no longer existing. | — | true if it exists<br>참/거짓 |
159
- | `getRange` | Returns the document range occupied by the change entry.<br>- When several changes are grouped, the range spans from the first to the last; null if there is no target. | — | change range, null if there is no target<br>[`WordRange`](#word-wordrange) (없을 수 있음) |
160
- | `accept` | Accepts the change tracking entry.<br>- Confirms insertions, deletions, and formatting changes. An already processed entry is not changed again. | — | true if accepted, false if there is no target<br>참/거짓 |
161
- | `reject` | Rejects the change tracking entry.<br>- Cancels insertions and deletions and restores the original formatting. An already processed entry is not changed again. | — | true if rejected, false if there is no target<br>참/거짓 |
162
-
163
- <a id="word-wordchart"></a>
164
- ### Chart (`WordChart`)
165
-
166
- Gets and edits the type and formatting of a chart.
167
-
168
- > 📎 [**Shape**](#word-wordshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
169
-
170
- | 기능 | 설명 | 입력 | 결과 |
171
- |---|---|---|---|
172
- | `getType` | 차트 타입을 enum 문자열로 반환한다. 미지원/미매핑 타입(파일 로드 stock/surface 등)은 "unknown". | — | 문자열 |
173
- | `isEditable` | 차트가 편집 가능한지 반환한다. 대상 부재·복원 불가·외부 데이터 차트는 false (throw 하지 않는다). | — | 참/거짓 |
174
- | `getTitle` | 차트 제목을 반환한다. 미설정 시 빈 문자열. | — | 문자열 |
175
- | `getAxisTitle` | 축 제목을 반환한다. 미설정 시 빈 문자열,<br>축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw. | 문자열 (없을 수 있음) |
176
- | `getLegendPosition` | 범례 위치를 반환한다. 범례가 없으면 "none". | — | [`ChartLegendPosition`](#common-chartlegendposition) |
177
- | `getDataLabelPosition` | 데이터레이블 위치를 반환한다. 레이블이 없으면 "none". | — | [`ChartDataLabelPosition`](#common-chartdatalabelposition) |
178
- | `getGridLine` | 축별 눈금선 종류를 반환한다. 꺼져 있으면 "none",<br>해당 눈금선을 갖지 않는 차트 종류는 null. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw. | [`ChartGridLineType`](#common-chartgridlinetype) (없을 수 있음) |
179
- | `getState` | 차트의 공통 서식 상태를 모델 조회 1회로 반환한다. 각 값은 동명 getter 와 같은 규약이다 —<br>axisTitle/gridLine 의 null 은 그 차트 종류에 해당 축의 제목·눈금선이 없다는 뜻이고,<br>"none" 은 지원하지만 꺼져 있다는 뜻이다.<br><br>개별 getter 는 호출마다 대상 실존 확인(hasChart)을 반복하므로, 여러 값을 함께 읽을 때는 이 쪽을 쓴다. | — | `{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string \| null; vertical: string \| null }; gridLine: { horizontal: ChartGridLineType \| null; vertical: ChartGridLineType \| null } }` |
180
- | `setType` | 차트 종류를 변경한다. 현재 종류와 같으면 아무것도 하지 않는다 —<br>종류가 그대로인데 스타일 미지정 차트의 스타일만 기본값으로 바뀌는 부작용을 막는다. | `chartType` [`ChartType`](#common-charttype) — 차트 종류 enum 값(= enum 문자열, 예: "clustered_column"). 미정의/미지원이면 CHART_TYPE_UNSUPPORTED throw. | — |
181
- | `setStyle` | 차트 프리셋 스타일을 변경한다. 번호별 실제 색은 문서 테마에 종속된다. | `style` 숫자 — 스타일 번호 (1~12 정수). 3개 단위로 색 그룹이 나뉘고(1~3=그룹1, 4~6=그룹2, 7~9=그룹3, 10~12=그룹4), 그룹 내 순서는 배경 변형이다(1번째=반투명 배경, 2번째=흰색 배경, 3번째=색상 배경+계열 테두리 — 정의는 chartInfo.setStyle JSDoc). 형태 위반 시 CHART_STYLE_INVALID throw. | — |
182
- | `setTitle` | 차트 제목을 설정한다. | `title` 문자열 | — |
183
- | `setAxisTitle` | 축 제목을 설정한다. 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는<br>CHART_AXIS_TITLE_UNSUPPORTED throw. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw.<br>`title` 문자열 | — |
184
- | `setLegendPosition` | 범례 위치를 설정한다. "none"이면 범례를 숨긴다. | `position` [`ChartLegendPosition`](#common-chartlegendposition) — 그 외 CHART_LEGEND_POSITION_INVALID throw. | — |
185
- | `setDataLabelPosition` | 데이터레이블 위치를 설정한다. "none"이면 숨긴다.<br>차트 타입별 유효 위치까지 검증한다 — 타입 그룹 미정의는 CHART_DATALABEL_UNSUPPORTED,<br>그룹에 없는 위치는 CHART_DATALABEL_POSITION_INVALID throw. "none"은 전 타입 허용. | `position` [`ChartDataLabelPosition`](#common-chartdatalabelposition) — 그 외 CHART_DATALABEL_POSITION_INVALID throw. | — |
186
- | `setGridLine` | 차트 눈금선을 설정한다. "none"이면 해당 축 눈금선을 숨긴다.<br>차트 타입별 지원 여부까지 검증한다 — 원형 계열·도넛은 양축, 방사형은 세로 축이<br>CHART_GRID_LINE_UNSUPPORTED throw. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw.<br>`gridType` [`ChartGridLineType`](#common-chartgridlinetype) — 그 외 CHART_GRID_LINE_INVALID throw. | — |
187
- | `getId` | Returns the chart shape ID. | — | chart shape ID (permanent GUID)<br>문자열 |
188
-
189
- <a id="word-wordcomment"></a>
190
- ### Comment — 댓글 (`WordComment`)
191
-
192
- Looks up a comment and edits its content or deletes it.
193
-
194
- | 기능 | 설명 | 입력 | 결과 |
195
- |---|---|---|---|
196
- | `getId` | Returns the comment ID. | — | comment ID<br>문자열 |
197
- | `exists` | Returns whether the comment exists. | — | true if it exists<br>참/거짓 |
198
- | `getRange` | Returns the body range the comment is attached to. | — | body range the comment is linked to<br>[`WordRange`](#word-wordrange) |
199
- | `getBody` | Returns the content area of the comment. | — | comment body area, null if none<br>[`WordBody`](#word-wordbody) (없을 수 있음) |
200
- | `delete` | Deletes the comment. | — | — |
201
-
202
- <a id="word-wordhyperlink"></a>
203
- ### Hyperlink — 하이퍼링크 (`WordHyperlink`)
204
-
205
- Gets, updates or deletes a hyperlink attached to text.
206
-
207
- | 기능 | 설명 | 입력 | 결과 |
208
- |---|---|---|---|
209
- | `getId` | Returns the hyperlink ID. | — | hyperlink ID, or null if not yet inserted<br>문자열 (없을 수 있음) |
210
- | `exists` | Returns whether the hyperlink exists. | — | true if it exists<br>참/거짓 |
211
- | `getUrl` | Returns the link target address.<br>- Bookmarks are returned as "#name". Web addresses entered without a protocol are returned as "https://…".<br><br><b>Example</b><pre><code>word.getHyperlinks().filter(link =&gt; link.getUrl().startsWith("http://")); // pick out insecure links</code></pre> | — | destination url<br>문자열 |
212
- | `getTooltip` | Returns the link tooltip (the description shown on mouse hover). | — | tooltip, or null if not set<br>문자열 (없을 수 있음) |
213
- | `getLinkType` | Returns the link type. | — | link type (link/mailto/bookmark)<br>[`HyperlinkType`](#word-hyperlinktype) |
214
- | `getRange` | Returns the range of the display text the link is attached to.<br>- The link start/end markers are not included. Editing the returned range changes only the text while keeping the link.<br><br><b>Example</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> | — | display text range<br>[`WordRange`](#word-wordrange) |
215
- | `update` | Updates the hyperlink's address, tooltip and display text.<br>- Specify at least one field to change. Giving only url keeps the display text; giving displayText replaces it.<br><br><b>Example</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 }` — update options (all fields optional, at least one required)<br> · `url` new URL (web `http(s)://` · email `mailto:` · bookmark `#name`) (기본값: current value)<br> · `tooltip` new tooltip (omitted: keeps the current tooltip, but becomes the new url when url is also changed)<br> · `displayText` new display text (if given, the visible text is replaced) (기본값: current value) | — |
216
- | `delete` | Deletes the hyperlink.<br>- The display text remains in the document. | — | — |
217
-
218
- <a id="word-wordimage"></a>
219
- ### Image — 이미지 (`WordImage`)
220
-
221
- Edits the size, position, wrap, and hyperlink of an image in the document.
222
-
223
- > 📎 [**Shape**](#word-wordshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
224
-
225
- | 기능 | 설명 | 입력 | 결과 |
226
- |---|---|---|---|
227
-
228
- <a id="word-wordlist"></a>
229
- ### List — 목록 (`WordList`)
230
-
231
- Changes the level and numbering restart position of a paragraph that belongs to a list.
232
-
233
- | 기능 | 설명 | 입력 | 결과 |
234
- |---|---|---|---|
235
- | `setLevel` | Changes the list level of this paragraph.<br>- Moves one level at a time with IndentType, or sets the target level with a 0-based number.<br>- Even on the first item of the list, only this paragraph's level changes. The change can be undone in one step.<br>- If the given level is deeper than the list supports, moves to the last level of that list.<br>- To remove the list, use clearList() on the paragraph or range.<br><br><b>Example</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" (one level in) \| "outdent" (one level out) \| target level (integer 0~8) | — |
236
- | `restartNumbering` | Restarts numbering from this paragraph.<br><br><b>Example</b><pre><code>para.getList().restartNumbering(); // restart list numbering from this paragraph</code></pre> | — | — |
237
-
238
- <a id="word-wordnote"></a>
239
- ### Note — 각주/미주 (`WordNote`)
240
-
241
- Looks up a footnote or endnote and edits its content or deletes it.
242
-
243
- | 기능 | 설명 | 입력 | 결과 |
244
- |---|---|---|---|
245
- | `getId` | Returns the footnote/endnote ID. | — | footnote/endnote ID<br>문자열 |
246
- | `exists` | Returns whether the footnote/endnote exists. | — | true if it exists<br>참/거짓 |
247
- | `getRange` | Returns the body range at which the footnote/endnote reference mark is placed.<br><br><b>Example</b><pre><code>word.getNote(id).getRange().getLocation(); // { startParaId, startOffset, ... }</code></pre> | — | marker position range<br>[`WordRange`](#word-wordrange) |
248
- | `getBody` | Returns the content area of the footnote/endnote.<br><br><b>Example</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> | — | content area, null if none<br>[`WordBody`](#word-wordbody) (없을 수 있음) |
249
- | `getIndex` | Returns the ordinal position among footnotes/endnotes of the same kind within the document. | — | ordinal position, -1 if none<br>숫자 |
250
- | `delete` | Deletes the footnote/endnote.<br>- Deletes both the reference mark in the body and the footnote/endnote content. | — | — |
251
-
252
- <a id="word-wordparagraph"></a>
253
- ### Paragraph — 문단 (`WordParagraph`)
254
-
255
- Gets and edits the content and formatting of a single paragraph.
256
-
257
- | 기능 | 설명 | 입력 | 결과 |
258
- |---|---|---|---|
259
- | `getId` | Returns the paragraph ID. | — | paragraph ID<br>문자열 |
260
- | `getText` | Returns the text of the paragraph.<br>- Character positions computed from the returned text are used as the offset of insertText() or the character positions of getRange().<br>- A tab is represented as "\t", line/page/column breaks as "\n", and objects such as footnotes and shapes as the single character "\uFFFC".<br>- The line break that marks the end of the paragraph is not included.<br><br><b>Example</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> | — | the concatenated text of the characters in the paragraph ("" if none)<br>문자열 |
261
- | `getStructure` | Returns the structure information of this paragraph.<br>- Includes index, type, paragraph ID, area ID and text. | — | a list containing this single paragraph entry<br>`{ paragraphs: { index: number; type: string; id: string; storyId: string; text: string }[] }` |
262
- | `getContentHtml` | Returns the content of this paragraph as HTML with formatting.<br>- The paragraph is represented as a <p> element. | — | HTML of this paragraph and the paragraph count<br>`{ html: string; paragraphCount: number }` |
263
- | `insertText` | Inserts text into the paragraph or replaces the entire paragraph content.<br>- Formatting is preserved. To change or reset formatting, use setTextFormat(), clearFormat() or setStyle() on the returned range.<br><br><b>Example</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` 문자열 — text to insert<br>`options` (선택) `{ offset?: number; position?: InsertAt; replace?: boolean }` — insert/replace options<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` append position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START)<br> · `replace` if true, replaces the entire paragraph content with the new text (position arguments ignored) (기본값: false) | range of the text just inserted (or replaced, when replacing)<br>[`WordRange`](#word-wordrange) |
264
- | `insertShape` | Inserts a shape of the given preset into the paragraph.<br>- After insertion, use the returned shape to set formatting and placement.<br><br><b>Example</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) — base shape of the shape (e.g. "rect", "ellipse", "roundRect")<br>`options` (선택) `{ width?: number; height?: number; offset?: number; position?: InsertAt }` — shape insertion options<br> · `width` width (pt) (기본값: 75)<br> · `height` height (pt) (기본값: 75)<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | the inserted shape<br>[`WordShape`](#word-wordshape) |
265
- | `insertTextbox` | Inserts a text box into the paragraph.<br><br><b>Example</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 }` — text box insertion options<br> · `width` width (pt) (기본값: 75)<br> · `height` height (pt) (기본값: 75)<br> · `text` initial content text<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | creation result (shape: shape object / storyId: text box area ID / paragraphId: first paragraph ID)<br>`{ shape: WordShape; storyId: string; paragraphId: string }` |
266
- | `insertImage` | Inserts an image into the paragraph, placed inline like a character.<br>- Processed asynchronously regardless of the image source.<br><br><b>Example</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 }` — image insertion options (exactly one source among src/url/base64 is required)<br> · `src` path of an already uploaded image<br> · `url` image URL (uploaded first, then inserted)<br> · `base64` base64 data (uploaded first, then inserted)<br> · `width` width (pt) (기본값: original size)<br> · `height` height (pt) (기본값: original size)<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | the inserted image<br>[`WordImage`](#word-wordimage) |
267
- | `insertWebVideo` | Inserts a web video into the paragraph, placed inline like a character.<br>- Supports YouTube and 3DS 3DEXPERIENCE URLs and is processed asynchronously.<br>- Uses a fallback image if the preview image cannot be fetched.<br><br><b>Example</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` 문자열 — web video URL (YouTube / 3DS 3DEXPERIENCE)<br>`options` (선택) `{ width?: number; height?: number; offset?: number; position?: InsertAt }` — web video insertion options<br> · `width` width (pt) (기본값: original thumbnail size)<br> · `height` height (pt) (기본값: original thumbnail size)<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | the inserted web video image object<br>[`WordImage`](#word-wordimage) |
268
- | `insertLineBreak` | Inserts a line break into the paragraph.<br>- Breaks the line while keeping the paragraph, like Shift+Enter.<br><br><b>Example</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 }` — insertion position options<br> · `offset` character position within the paragraph (0-based); a position past the end of the paragraph is adjusted to the paragraph end. takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | — |
269
- | `insertTab` | Inserts a tab character into the paragraph.<br>- Tab stop positions are set separately with setTabs().<br><br><b>Example</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 }` — insertion position options<br> · `offset` character position within the paragraph (0-based); a position past the end of the paragraph is adjusted to the paragraph end. takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | — |
270
- | `insertSymbol` | Inserts a symbol into the paragraph.<br>- font not specified: inserts the Unicode character as plain text.<br> - font specified: inserts the symbol glyph of that font.<br><br><b>Example</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` — Unicode code point (hex string "2605" \| "0x2605" \| number 0x2605)<br>`options` (선택) `{ font?: string; offset?: number; position?: InsertAt }` — symbol insertion options<br> · `font` if specified, inserts the symbol glyph of that font<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | — |
271
- | `insertSectionBreak` | Inserts a section break at the paragraph position to create a new section.<br>- Section breaks can only be inserted in the body (not in header/footer/text box).<br><br><b>Example</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) — start type of the new section (continuous: continues / nextPage: from the next page / evenPage: from the next even page / oddPage: from the next odd page)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — insertion position options<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | — |
272
- | `insertPageBreak` | Inserts a page break into the paragraph.<br>- The following content starts on the next page. Can only be inserted in the body.<br><br><b>Example</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 }` — insertion position options<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | — |
273
- | `insertColumnBreak` | Inserts a column break into the paragraph.<br>- The following content starts in the next column, or on the next page if the section has a single column. Can only be inserted in the body.<br><br><b>Example</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 }` — insertion position options<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | — |
274
- | `insertFootnote` | Inserts a footnote at the paragraph position.<br><br><b>Example</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` (선택) 문자열 — initial text of the footnote content (기본값: empty footnote)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — insertion position options<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | the created footnote object<br>[`WordNote`](#word-wordnote) |
275
- | `insertEndnote` | Inserts an endnote at the paragraph position.<br><br><b>Example</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` (선택) 문자열 — initial text of the endnote content (기본값: empty endnote)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — insertion position options<br> · `offset` character position within the paragraph (0-based); takes precedence over position<br> · `position` insertion position (when offset is absent). start (paragraph start) \| end (paragraph end) (기본값: InsertAt.START) | the created endnote object<br>[`WordNote`](#word-wordnote) |
276
- | `insertParagraph` | Inserts a new paragraph above or below this paragraph, or splits the paragraph at the given character position.<br>- The new paragraph inherits this paragraph's direct paragraph formatting such as alignment, spacing and indentation.<br>- To reset the inherited direct formatting, call clearFormat() on the returned paragraph.<br><br><b>Example</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` 문자열 — text of the new paragraph (empty string creates an empty paragraph — a pure split when offset is given)<br>`options` (선택) `{ offset?: number; position?: InsertAt }` — insertion options<br> · `offset` splits at the character position within the paragraph (0-based); the following content is preserved as the new paragraph. a position past the end of the paragraph is adjusted to the paragraph end. position is ignored when specified<br> · `position` for sibling insertion, "before" (above) / "after" (below) relative to this paragraph (기본값: InsertAt.AFTER) | the newly created paragraph object<br>[`WordParagraph`](#word-wordparagraph) |
277
- | `insertTable` | Inserts a table above or below this paragraph, or splits the paragraph at a character position and inserts the table between the parts.<br>- Cannot be inserted inside a table cell (nested tables are not supported — an error is thrown if the insertion point is inside a cell).<br><br><b>Example</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` 숫자 — number of rows<br>`columns` 숫자 — number of columns<br>`options` (선택) `{ offset?: number; position?: InsertAt; values?: string[][] }` — insertion options<br> · `offset` splits at the character position within the paragraph (0-based) and inserts the table between the parts; the following content is preserved as a new paragraph. position is ignored when specified<br> · `position` for sibling insertion, "before" (above) / "after" (below) relative to this paragraph (기본값: InsertAt.AFTER)<br> · `values` cell values to fill right after creation (2D array; an error is thrown before execution if it exceeds the table size) | the inserted table object<br>[`WordTable`](#word-wordtable) |
278
- | `setTextFormat` | Applies text formatting to the entire text of the paragraph.<br><br><b>Example</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) — text formatting to apply | — |
279
- | `clearFormat` | Resets the text formatting and paragraph formatting of the entire paragraph. | — | — |
280
- | `select` | Sets this paragraph as the on-screen selection.<br>- Does not change document content.<br><br><b>Example</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" (entire paragraph) / "start" (cursor at paragraph start) / "end" (cursor at paragraph end) (기본값: SelectionMode.SELECT) | — |
281
- | `setParagraphFormat` | Applies the given paragraph formatting to this paragraph.<br>- Only the specified fields are changed. Text formatting is set with setTextFormat().<br><br><b>Example</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) — paragraph formatting to apply | — |
282
- | `setParagraphBorder` | Sets the border of this paragraph.<br>- Uses the same Border format as cell borders.<br><br><b>Example</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) — border value | — |
283
- | `setTabs` | Sets the tab stop positions of this paragraph.<br>- Replaces the existing setting with the given array; an empty array removes all tab stops.<br><br><b>Example</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) 목록 — array of tab stops | — |
284
- | `setStyle` | Applies a style to this paragraph.<br>- Applying a style resets the existing direct formatting.<br>- A paragraph style is applied to the paragraph; a character style is applied to the entire text of the paragraph.<br><br><b>Example</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 for built-in styles (value = key), or the style value from getStyles() for custom document styles. null removes the style (reverts to default) | — |
285
- | `setIndent` | Adjusts indent/outdent by one level.<br>- For a list paragraph the list level moves; otherwise the paragraph's left indent moves.<br>- Even for the first item of a list, only that item's level moves.<br><br><b>Example</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" | — |
286
- | `getRange` | Returns the range for the given character position span within this paragraph.<br><br><b>Example</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` (선택) 숫자 — start character position (0-based) (기본값: paragraph start)<br>`endOffset` (선택) 숫자 — end character position (기본값: paragraph end) | range object bound to the offset span within the paragraph<br>[`WordRange`](#word-wordrange) |
287
- | `getComments` | Returns the list of comments overlapping this paragraph's range. | — | list of comments<br>[`WordComment`](#word-wordcomment) 목록 |
288
- | `getChangeTrackings` | Returns the list of change tracking entries overlapping this paragraph. | — | list of change tracking entries<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
289
- | `acceptChangeTrackings` | Accepts all change tracking entries overlapping this paragraph. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
290
- | `rejectChangeTrackings` | Rejects all change tracking entries overlapping this paragraph. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
291
- | `getNotes` | Returns the list of footnotes/endnotes in this paragraph. | — | list of footnotes and endnotes<br>[`WordNote`](#word-wordnote) 목록 |
292
- | `getFootnotes` | Returns the list of footnotes in this paragraph. | — | list of footnotes<br>[`WordNote`](#word-wordnote) 목록 |
293
- | `getEndnotes` | Returns the list of endnotes in this paragraph. | — | list of endnotes<br>[`WordNote`](#word-wordnote) 목록 |
294
- | `getPreviousSibling` | Returns the immediately preceding paragraph.<br>- Returns null if the preceding element is not a paragraph (e.g. a table) or does not exist. Does not cross section boundaries. | — | the previous paragraph; null if none or the preceding element is not a paragraph<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
295
- | `getNextSibling` | Returns the immediately following paragraph.<br>- Returns null if the following element is not a paragraph (e.g. a table) or does not exist. Does not cross section boundaries. | — | the next paragraph; null if none or the following element is not a paragraph<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
296
- | `getParentBody` | Returns the area (body/header/footer, etc.) this paragraph belongs to. | — | the area this paragraph belongs to<br>[`WordBody`](#word-wordbody) |
297
- | `getParentTable` | Returns the nearest table this paragraph belongs to.<br>- Returns null for a paragraph outside a table. For nested tables, returns the inner table. | — | the parent table object; null if outside a table<br>[`WordTable`](#word-wordtable) (없을 수 있음) |
298
- | `getParentTableCell` | Returns the nearest table cell this paragraph belongs to.<br>- Returns null for a paragraph outside a cell. For nested tables, returns the inner cell. | — | the parent cell object; null if outside a cell<br>[`WordTableCell`](#word-wordtablecell) (없을 수 있음) |
299
- | `setList` | Applies the given list format to this paragraph.<br>- When applied to an existing list, items at the same level of the same list change as well.<br>- Applying a multilevel list affects the entire list.<br>- After applying, change the list level with setLevel() on the list obtained from getList().<br><br><b>Example</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) — list type to apply. Choose from the built-in bullet, numbered and multilevel lists. | — |
300
- | `getList` | Returns the list of this paragraph.<br>- Used to change the list level and restart numbering.<br><br><b>Example</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> | — | list handle; null if the paragraph is not a list item<br>[`WordList`](#word-wordlist) (없을 수 있음) |
301
- | `clearList` | Removes the list from this paragraph.<br>- To remove lists from multiple paragraphs at once, use clearList of WordRange. | — | — |
302
- | `delete` | Deletes the paragraph.<br>- If no other paragraph follows, keeps the paragraph and deletes only its characters. | — | — |
303
-
304
- <a id="word-wordrange"></a>
305
- ### Range — 텍스트 범위 (`WordRange`)
306
-
307
- Reads and edits content within a specified range of the document.
308
-
309
- | 기능 | 설명 | 입력 | 결과 |
310
- |---|---|---|---|
311
- | `getLocation` | Returns the start/end positions of this range as paragraph coordinates.<br>- Ranges created without coordinates, such as the selection, cursor, or a footnote marker, also have their current position computed and returned.<br> The return shape matches the `getRange` argument, so passing it back recreates the same range.<br><br><b>Example</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> | — | start/end paragraph IDs, character offsets, and area ID<br>`{ startParaId: string; startOffset: number; endParaId: string; endOffset: number; storyId: string }` |
312
- | `getText` | Returns the text contained in this range.<br>- Paragraph boundaries are separated by "\n". Within a single paragraph, add getLocation().startOffset to a character position in the returned text to get the paragraph character position.<br>- This calculation cannot be used for ranges spanning multiple paragraphs.<br>- Tabs are represented as "\t", line/page/column breaks as "\n", and objects such as footnotes and shapes as the single character "".<br><br><b>Example</b><pre><code>range.getText(); // get the text of this range<br>doc.getSelection().getText(); // get the selected text</code></pre> | — | range text ("" for an empty range/cursor)<br>문자열 |
313
- | `isCollapsed` | Checks whether this range is empty, with the same start and end.<br>- Returns true for a cursor-only range, and false for a range containing selected characters or a search result.<br><br><b>Example</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 if the range is empty<br>참/거짓 |
314
- | `getStructure` | Returns the paragraph/table structure spanned by this range.<br>- Contains, in document order, everything from the start paragraph to the end paragraph (including tables in between). | — | list of paragraph and table entries spanned by the range<br>`{ paragraphs: { index: number; type: string; id: string; storyId: string; text?: string; rows?: number; columns?: number }[] }` |
315
- | `getContentHtml` | Returns the paragraph content spanned by this range as HTML with formatting.<br>- Includes paragraphs from the start to the end paragraph in document order; paragraphs inside tables are also represented as <p> elements. | — | range HTML and paragraph count<br>`{ html: string; paragraphCount: number }` |
316
- | `search` | Finds text or special characters (page break/column break/line break/tab/symbol) within this range and returns editable ranges.<br><br><b>Example</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 }` — a string searches text; a `{ character }` object searches special characters<br>`options` (선택) `{ caseSensitive?: boolean; wholeWord?: boolean }` — text search options (ignored for special character search)<br> · `caseSensitive` case-sensitive matching (기본값: false)<br> · `wholeWord` whole-word search (a match is accepted only when bounded by whitespace, punctuation, or a document boundary) (기본값: false) | list of matched ranges within this range (empty array if none)<br>[`WordRange`](#word-wordrange) 목록 |
317
- | `setTextFormat` | Applies text formatting to the range.<br><br><b>Example</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) — text formatting to apply (only the specified fields change; passing null instead of a value removes that property and reverts to style inheritance) | — |
318
- | `clearFormat` | Resets the text formatting and paragraph formatting of the range.<br>- Paragraph formatting is reset only for paragraphs whose paragraph mark falls inside the range. | — | — |
319
- | `setStyle` | Applies a style to this range.<br>- Existing direct formatting is reset. A paragraph style applies to the paragraphs spanned by the range; a character style applies to the range text.<br><br><b>Example</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` — built-in styles use the Style enum (value = key); custom document styles use the style value from getStyles(). null removes the character style only, leaving the paragraph style in place | — |
320
- | `delete` | Deletes the text of the range. | — | — |
321
- | `insertHyperlink` | Attaches a hyperlink to this range.<br>- With displayText, that text replaces the range text and carries the link; without it, the existing range text is linked as is.<br>- An empty range has no text to link, so displayText is required there.<br>- The link type is determined automatically from the url (web `http(s)://`, email `mailto:`, bookmark `#name`; https:// is assumed when no scheme is given).<br><br><b>Example</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` 문자열 — link destination<br>`options` (선택) `{ tooltip?: string; displayText?: string }` — hyperlink options<br> · `tooltip` mouse-over tooltip (기본값: url)<br> · `displayText` text to show in place of the range text (required for an empty range) | the inserted hyperlink, or null if the new id could not be identified<br>[`WordHyperlink`](#word-wordhyperlink) (없을 수 있음) |
322
- | `getHyperlink` | Returns the hyperlink attached to this range.<br>- The link at the start point is used; if there is none, the link at the end point is used. So a range spanning several links gives the one at the start.<br>- Only the two end points are examined — a link that lies entirely inside the range, touching neither point, is not found. | — | hyperlink object, or null if neither point has a link<br>[`WordHyperlink`](#word-wordhyperlink) (없을 수 있음) |
323
- | `setParagraphFormat` | Applies paragraph formatting to the paragraphs spanned by this range.<br>- Only the specified fields change; null removes that property so the style's formatting applies.<br><br><b>Example</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) — paragraph formatting to apply | — |
324
- | `getFormat` | Returns the text formatting and paragraph formatting at the start position of this range.<br>- Even if formatting varies within the range, the direct formatting at the start position is returned. | — | text and paragraph formatting at the start position (missing items are omitted)<br>`{ textFormat?: TextFormat; paragraphFormat?: ParagraphFormat }` |
325
- | `copyFormatTo` | Copies the style and formatting (text + paragraph) at the start position of this range to the target range.<br>- The source is read from the **start point only** of this range — even if the range spans multiple paragraphs, only the first paragraph's formatting is taken.<br>- For the same reason, paragraph formatting is applied only to the **first paragraph** of the target range.<br>- **If the target is an empty paragraph or a cursor, only paragraph formatting is applied and text formatting is not** — there are no characters to format,<br> and characters entered into that paragraph later do not follow the source text formatting.<br><br><b>Example</b><pre><code>range.copyFormatTo(targetRange); // copy the formatting at the start position to the target range</code></pre> | `targetRange` [`WordRange`](#word-wordrange) — range that receives the formatting | — |
326
- | `setParagraphBorder` | Sets borders on the paragraphs spanned by this range.<br>- Uses the same Border format as cell borders; location specifies which sides to apply.<br><br><b>Example</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) — border value (shared by paragraphs, cells, and pages) | — |
327
- | `setTabs` | Sets the tab stops of the paragraphs spanned by this range.<br>- Replaces the existing setting with the given array; an empty array removes all tab stops.<br><br><b>Example</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) 목록 — array of tab stops | — |
328
- | `setIndent` | Adjusts the indent/outdent of the paragraphs spanned by the range by one step.<br>- For list paragraphs the list level moves; for non-list paragraphs the paragraph left margin moves.<br>- Even if the start paragraph is the first item of a list, only that item's level moves.<br><br><b>Example</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" | — |
329
- | `setList` | Applies list formatting to the paragraphs spanned by this range.<br>- An empty range applies to the paragraph containing the cursor. If multiple paragraphs are included, all of them are affected.<br>- If the cursor is inside an existing list, items of the same list at the same level change too. Multi-level lists are updated as a whole.<br><br><b>Example</b><pre><code>doc.getSelection().setList(ListType.NUMBER_DECIMAL); // number the selected paragraphs</code></pre> | `listType` [`ListType`](#word-listtype) — list type to apply. Choose from the built-in bullet, numbered, and multi-level lists. | — |
330
- | `clearList` | Removes list formatting from the paragraphs spanned by the range.<br><br><b>Example</b><pre><code>doc.getSelection().clearList(); // remove lists from the selected range</code></pre> | — | — |
331
- | `getParagraph` | Returns the start paragraph of this range.<br>- Use the returned paragraph to edit the content and formatting of the whole paragraph.<br>- A coordinate range is not checked here — if the paragraph ID does not exist, the error surfaces when the returned paragraph is used. | — | start paragraph object<br>[`WordParagraph`](#word-wordparagraph) |
332
- | `getParentSection` | Returns the section containing the start position of this range.<br>- Returns null when the section cannot be determined outside the body, such as in headers and footers. | — | section object, or null if no body section is found<br>[`WordSection`](#word-wordsection) (없을 수 있음) |
333
- | `getComments` | Returns the list of comments overlapping this range. | — | list of comments<br>[`WordComment`](#word-wordcomment) 목록 |
334
- | `getChangeTrackings` | Returns the list of change-tracking entries overlapping this range, in document order. | — | list of change-tracking entries<br>[`WordChangeTracking`](#word-wordchangetracking) 목록 |
335
- | `acceptChangeTrackings` | Accepts all change-tracking entries overlapping this range. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
336
- | `rejectChangeTrackings` | Rejects all change-tracking entries overlapping this range. | — | processing result<br>`{ processedCount: number; remainingCount: number; failedIds: string[] }` |
337
- | `getNotes` | Returns the list of footnotes and endnotes within this range. | — | list of footnotes and endnotes<br>[`WordNote`](#word-wordnote) 목록 |
338
- | `getFootnotes` | Returns the list of footnotes within this range. | — | list of footnotes<br>[`WordNote`](#word-wordnote) 목록 |
339
- | `getEndnotes` | Returns the list of endnotes within this range. | — | list of endnotes<br>[`WordNote`](#word-wordnote) 목록 |
340
- | `getShapes` | Returns the list of shapes, images, and charts within this range.<br>- Includes both inline shapes and shapes placed in front of or behind text. | — | list of shapes (pictures as WordImage, charts as WordChart; empty array if none)<br>`(WordShape \| WordImage \| WordChart)[]` |
341
- | `getBookmarks` | Returns the list of bookmarks whose markers lie within the range. | — | list of bookmarks (empty array if none)<br>[`WordBookmark`](#word-wordbookmark) 목록 |
342
- | `getHyperlinks` | Returns the list of text hyperlinks overlapping this range. | — | list of hyperlinks (empty array if none)<br>[`WordHyperlink`](#word-wordhyperlink) 목록 |
343
- | `insertText` | Inserts text into this range.<br>- replace not specified: inserts at one end point of the range (the original text remains even for a span). position determines which end.<br> - replace: true: replaces the range text with the new text (for a single point, inserts there; position is ignored).<br> Handles text only and leaves formatting as-is. Apply formatting changes separately to the returned range.<br><br><b>Example</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` 문자열 — text to insert<br>`options` (선택) `{ position?: InsertAt; replace?: boolean }` — insert/replace options<br> · `position` relative to the range: "before" (start point, before the match) / "after" (end point, after the match). Ignored when replace:true. (기본값: InsertAt.BEFORE)<br> · `replace` if true, replaces the range text with the new text (position ignored) | range of the newly inserted or replaced text (setTextFormat etc. can be applied to it directly)<br>[`WordRange`](#word-wordrange) |
344
- | `select` | Sets this range as the on-screen selection.<br>- Does not change document content.<br><br><b>Example</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" (whole range) / "start" (cursor at the start point) / "end" (cursor at the end point) (기본값: SelectionMode.SELECT) | — |
345
- | `insertParagraph` | Inserts a new paragraph above or below the anchor paragraph of this range.<br>- The new paragraph inherits the anchor paragraph's direct paragraph formatting such as alignment, spacing, and indents.<br>- To reset the inherited direct formatting, call clearFormat() on the returned paragraph.<br><br><b>Example</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` 문자열 — text of the new paragraph<br>`options` (선택) `{ position?: InsertAt }` — insert options<br> · `position` relative to the range paragraph: "before" (above) / "after" (below) (기본값: InsertAt.AFTER) | the newly created paragraph<br>[`WordParagraph`](#word-wordparagraph) |
346
- | `insertTable` | Inserts a table relative to the paragraph of the range.<br>- Cannot insert inside a table cell (nested tables are not supported — an error occurs if the insertion point is inside a cell).<br><br><b>Example</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` 숫자 — number of rows<br>`columns` 숫자 — number of columns<br>`options` (선택) `{ position?: InsertAt; values?: string[][] }` — insert options<br> · `position` relative to the range paragraph: "before" (above) / "after" (below) (기본값: InsertAt.AFTER)<br> · `values` cell values to fill right after creation (2D array; exceeding the table size raises an error before issuing) | the inserted table<br>[`WordTable`](#word-wordtable) |
347
- | `insertShape` | Inserts a shape of the given preset into the paragraph of this range.<br>- Use the returned shape to set formatting and placement.<br><br><b>Example</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) — basic shape of the shape (e.g. "rect", "ellipse", "roundRect")<br>`options` (선택) [`Size`](#word-size) — size (pt; an omitted axis defaults to 75) | the inserted shape<br>[`WordShape`](#word-wordshape) |
348
- | `insertTextbox` | Inserts a text box into the paragraph of the range.<br><br><b>Example</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 }` — text box creation options (an omitted size axis defaults to 100; text is the initial content) | creation result (shape: shape object / storyId: text box area ID / paragraphId: first paragraph ID)<br>`{ shape: WordShape; storyId: string; paragraphId: string }` |
349
- | `insertImage` | Inserts an image inline at the start position of this range.<br>- Processed asynchronously regardless of the image source.<br><br><b>Example</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 }` — image insert options (exactly one source among src/url/base64 is required)<br> · `src` path of an already uploaded image<br> · `url` image URL (uploaded first, then inserted)<br> · `base64` base64 data (uploaded first, then inserted)<br> · `width` width (pt). Required with src — the original size is only known for url/base64, which are measured on upload (기본값: original size)<br> · `height` height (pt). Required with src — the original size is only known for url/base64, which are measured on upload (기본값: original size) | the inserted image<br>[`WordImage`](#word-wordimage) |
350
- | `insertWebVideo` | Inserts a web video inline at the start position of this range.<br>- Supports YouTube and 3DS 3DEXPERIENCE URLs and is processed asynchronously.<br>- If the preview image cannot be fetched, a fallback image is used.<br><br><b>Example</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` 문자열 — web video URL (YouTube / 3DS 3DEXPERIENCE)<br>`options` (선택) [`Size`](#word-size) — size (pt) (기본값: thumbnail original size) | the inserted web video image object<br>[`WordImage`](#word-wordimage) |
351
- | `insertLineBreak` | Inserts a line break at the start position of this range.<br>- Breaks the line while keeping the paragraph, like Shift+Enter.<br><br><b>Example</b><pre><code>range.insertLineBreak(); // line break at the range start</code></pre> | — | — |
352
- | `insertTab` | Inserts a tab character at the start position of this range.<br>- Tab stop positions are set separately with setTabs().<br><br><b>Example</b><pre><code>range.insertTab(); // insert a tab at the range start</code></pre> | — | — |
353
- | `insertSymbol` | Inserts a symbol at the start position of this range.<br>- font not specified: inserts the Unicode character as plain text.<br> - font specified: inserts it as a symbol glyph of that font.<br><br><b>Example</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` — Unicode code point (hex string "2605" \| "0x2605" \| number 0x2605)<br>`options` (선택) `{ font?: string }` — when font is specified, inserts the symbol in that font | — |
354
- | `insertSectionBreak` | Inserts a section break at this range position to create a new section.<br>- Section breaks can only be inserted in the body (not in headers/footers/text boxes).<br><br><b>Example</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) — start type of the new section (continuous: continues on the same page / nextPage: from the next page / evenPage: from the next even page / oddPage: from the next odd page) | — |
355
- | `insertPageBreak` | Inserts a page break at this range position.<br>- The following content starts on the next page. Can only be inserted in the body.<br><br><b>Example</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> | — | — |
356
- | `insertColumnBreak` | Inserts a column break at this range position.<br>- The following content starts in the next column, or on the next page if the section has a single column. Can only be inserted in the body.<br><br><b>Example</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> | — | — |
357
- | `insertBookmark` | Inserts a bookmark at the start position of this range.<br>- If a bookmark with the same name exists, it is replaced. The name cannot start with a digit, special character, or space.<br><br><b>Example</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` 문자열 — bookmark name | the inserted bookmark<br>[`WordBookmark`](#word-wordbookmark) |
358
- | `insertComment` | Inserts a comment on this range.<br><br><b>Example</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` 문자열 — comment body<br>`options` (선택) `{ authorName?: string; initials?: string }` — author metadata | the inserted comment<br>[`WordComment`](#word-wordcomment) |
359
- | `insertFootnote` | Inserts a footnote at the end of this range.<br>- The marker is placed in the body and the content goes into the footnote area at the bottom of the page.<br><br><b>Example</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` (선택) 문자열 — initial text of the footnote content (기본값: empty footnote) | the created footnote<br>[`WordNote`](#word-wordnote) |
360
- | `insertEndnote` | Inserts an endnote at the end of this range.<br>- The marker is placed in the body and the content goes into the endnote area at the end of the document.<br><br><b>Example</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` (선택) 문자열 — initial text of the endnote content (기본값: empty endnote) | the created endnote<br>[`WordNote`](#word-wordnote) |
361
-
362
- <a id="word-wordsection"></a>
363
- ### Section — 구역 (`WordSection`)
364
-
365
- Gets and edits the page setup and headers/footers of a single document section.
366
-
367
- | 기능 | 설명 | 입력 | 결과 |
368
- |---|---|---|---|
369
- | `getIndex` | Returns the index of this section. | — | 0-based section index<br>숫자 |
370
- | `getBody` | Returns the section body.<br>- The body is shared by all sections, so calling this on any section returns the same body. | — | body area<br>[`WordBody`](#word-wordbody) |
371
- | `getHeader` | Returns the header area of this section.<br>- An area that does not exist yet is created on first content insertion.<br><br><b>Example</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` — kind: HeaderFooterType (primary/firstPage/evenPages) or HeaderFooterVariant (default/first/even) (기본값: HeaderFooterType.PRIMARY) | header area of the given kind<br>[`WordBody`](#word-wordbody) |
372
- | `getFooter` | Returns the footer area of this section.<br>- An area that does not exist yet is created on first content insertion.<br><br><b>Example</b><pre><code>section.getFooter(); // default footer<br>section.getFooter(HeaderFooterVariant.FIRST); // first-page footer</code></pre> | `type` (선택) `HeaderFooterType \| HeaderFooterVariant` — kind: HeaderFooterType (primary/firstPage/evenPages) or HeaderFooterVariant (default/first/even) (기본값: HeaderFooterType.PRIMARY) | footer area of the given kind<br>[`WordBody`](#word-wordbody) |
373
- | `getNext` | Returns the next section in document order. | — | the next section; null if this is the last section<br>[`WordSection`](#word-wordsection) (없을 수 있음) |
374
- | `getPrevious` | Returns the previous section in document order. | — | the previous section; null if this is the first section<br>[`WordSection`](#word-wordsection) (없을 수 있음) |
375
- | `getPageSetup` | Returns the page setup of this section.<br>- Paper size and margins are returned in pt. | — | page setup of this section<br>[`PageSetupInfo`](#word-pagesetupinfo) |
376
- | `getColumns` | Returns the column (multi-column) layout of this section.<br>- count, equalWidth, space and separator are always included; widths is added only when the column widths differ.<br> - A single column is always reported as equal width, so the result is { count: 1, equalWidth: true, space, separator } with no widths.<br> - The return value can be passed to setColumns() as is. | — | column layout (same shape as the setColumns input)<br>[`ColumnLayout`](#word-columnlayout) |
377
- | `setPageSize` | Sets the paper size and orientation of this section.<br>- Specify a paper preset or a width/height in pt. Unspecified dimensions are kept.<br>- When an orientation is given, width and height are aligned to it. Changing only the preset keeps the current orientation.<br><br><b>Example</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` — paper dimensions (pt; an omitted axis keeps its current value) or a paper preset name (A3/A4/A5/Letter/Legal/Executive). null keeps the size (changes orientation only)<br>`orientation` (선택) [`PageOrientation`](#word-pageorientation) — orientation (portrait/landscape) | — |
378
- | `setPageMargin` | Sets the page margins of this section.<br>- Only the specified sides are changed; the unit is pt.<br><br><b>Example</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) — margins (pt) | — |
379
- | `setTitlePage` | Enables a separate header/footer for the first page of this section.<br>- Does nothing if the value equals the current one. After enabling, enter the first-page content separately.<br>- Check the setting via getPageSetup().titlePage.<br><br><b>Example</b><pre><code>section.setTitlePage(true); // separate first-page header/footer<br>section.setTitlePage(false); // remove the distinction</code></pre> | `enabled` 참/거짓 — enable (true) / disable (false) | — |
380
- | `setPageNumbering` | Changes the page numbering settings of this section.<br>- Only the specified fields are changed; null removes the whole setting. Does nothing if the value equals the current one.<br>- Check the setting via getPageSetup().pageNumber.<br><br><b>Example</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) (없을 수 있음) — page numbering settings, or null (remove) | — |
381
- | `setBreakType` | Changes the break type of this section (continuous, next page, etc.). Does nothing if the value equals the current one.<br>- Same as the value read via getPageSetup().breakType.<br><br><b>Example</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) — break type (continuous/nextPage/evenPage/oddPage) | — |
382
- | `setColumns` | Changes the column (multi-column) layout of this section.<br>- Only the specified fields are changed; the rest keep their current values. Does nothing if the value equals the current one. The unit is pt.<br>- To give each column a different width, specify widths; otherwise all columns share the same width. When count is 1, equalWidth and widths are ignored.<br>- Check the setting via getColumns(); its return value can be passed back as is.<br><br><b>Example</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) — column layout | — |
383
- | `deleteBreak` | Removes the break of this section and merges it with the next section.<br>- The last section has no break to remove. | — | — |
384
-
385
- <a id="word-wordshape"></a>
386
- ### Shape — 도형 (`WordShape`)
387
-
388
- Gets and edits the content and formatting of a shape or text box.
389
-
390
- | 기능 | 설명 | 입력 | 결과 |
391
- |---|---|---|---|
392
- | `getRange` | Returns the range of the position the shape occupies.<br>- The shape occupies a single character position, so start = end.<br><br><b>Example</b><pre><code>word.getShape(id).getRange().getLocation(); // { startParaId, startOffset, ... }</code></pre> | — | range of the shape position (errors at use time if the shape does not exist)<br>[`WordRange`](#word-wordrange) |
393
- | `getBody` | Returns the text area inside the shape. | — | text area container, null if the shape is not a text box<br>[`WordBody`](#word-wordbody) (없을 수 있음) |
394
- | `getFill` | Returns the current fill settings of the shape.<br>- The return value can be passed to setFill() as-is.<br>- A theme color fill or a radial gradient fill returns only type, so passing such a value back to setFill() fails. | — | fill information (same shape as the setFill input), null if there is no fill information<br>[`ShapeFill`](#word-shapefill) (없을 수 있음) |
395
- | `getLine` | Returns the current line settings of the shape.<br>- The return value can be passed to setLine() as-is. | — | line information (same shape as the setLine input), null if there is no line information<br>[`ShapeLine`](#word-shapeline) (없을 수 있음) |
396
- | `getHyperlink` | Returns the hyperlink information attached to the shape.<br>- A shape can have one hyperlink.<br><br><b>Example</b><pre><code>const link = shape.getHyperlink();<br>if (link) { shape.updateHyperlink({ url: "https://new.com" }); } // update if present</code></pre> | — | link information, null if none. For a bookmark, url="#name" and anchor="name"<br>`{ url: string; tooltip: string \| null; linkType: HyperlinkType; anchor?: string } \| null` |
397
- | `resize` | Changes the size of the shape.<br>- Specify at least one of width or height. The size of the unspecified dimension is kept.<br><br><b>Example</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) — new size (pt). Each field is optional, at least one required; omitted axes keep their current value | — |
398
- | `setWrap` | Changes the wrap mode of the shape.<br>- Switches between inline with text and in front of / behind text.<br><br><b>Example</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" | — |
399
- | `setZOrder` | Changes the z-order of a shape placed in front of or behind text.<br>- Specifying the same position for a shape already at the very front or back makes no change.<br><br><b>Example</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" | — |
400
- | `move` | Changes the position of a shape placed in front of or behind text.<br>- x and y are pt coordinates relative to relativeFromH and relativeFromV; unspecified fields are kept.<br>- A reference point must be given together with its coordinate, because changing the reference point changes the meaning of the coordinate.<br>- If anchorParagraphId is given, the shape moves to that paragraph; otherwise only the position within the current paragraph changes.<br><br><b>Example</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 }` — move options (x/y in pt). Omitted fields keep their current value | — |
401
- | `setFill` | Sets the shape fill.<br>- For blipFill, give image as one of { src } (file name already uploaded to the server) / { url } (external image address) / { base64 }.<br> url and base64 are uploaded to the server first and then applied, so the result must be awaited in every case — always call with await.<br> - The input has the same shape as the getFill() return value (ShapeFill), so a read value can be re-applied as-is.<br><br><b>Example</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) — fill information (type determines which fields are valid) | no return value<br>— |
402
- | `setLine` | Sets the shape line.<br>- Omitted = no change, null (color/dash/compound) = remove. null or a non-number for width is rejected (no "remove" meaning).<br><br><b>Example</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) — line options. Omitted = no change, null for color/dash/compound = remove | — |
403
- | `insertHyperlink` | Sets a hyperlink on the shape.<br>- Replaces an existing link if present. Web address, email and bookmark are distinguished by URL format; a web address without a protocol gets https:// prepended.<br><br><b>Example</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` 문자열 — link destination<br>`options` (선택) `{ tooltip?: string }` — additional options<br> · `tooltip` mouse-over tooltip (기본값: url) | — |
404
- | `updateHyperlink` | Updates the address or tooltip of the hyperlink attached to the shape.<br>- Throws if there is no existing link. Unspecified fields are kept.<br><br><b>Example</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 }` — items to update (at least one of url/tooltip)<br> · `url` new URL (web `http(s)://` · email `mailto:` · bookmark `#name`) (기본값: current value)<br> · `tooltip` new tooltip (기본값: current value) | — |
405
- | `removeHyperlink` | Removes the hyperlink from the shape.<br>- The shape itself is kept. Use getHyperlink() to check whether a link exists.<br><br><b>Example</b><pre><code>if (shape.getHyperlink()) { shape.removeHyperlink(); } // remove only if present</code></pre> | — | — |
406
- | `setText` | Replaces the text content of the shape.<br>- For a plain shape, a new text area is created. Throws for shapes that cannot hold text, such as images.<br>- An empty string clears the content.<br><br><b>Example</b><pre><code>shape.setText("Notice text"); // set or replace text<br>shape.setText(""); // clear content</code></pre> | `text` 문자열 — text to fill in ("" clears the content) | — |
407
- | `setTextVerticalAlign` | Sets the vertical alignment of the shape text.<br>- Applies only to shapes with a text area. If there is none, add text first with setText().<br><br><b>Example</b><pre><code>shape.setTextVerticalAlign(TextVerticalAlign.MIDDLE); // vertically centered</code></pre> | `align` [`TextVerticalAlign`](#word-textverticalalign) — "top"\|"middle"\|"bottom" | — |
408
- | `setTextMargin` | Sets the inner margins of the shape text area.<br>- Specifies all four margins of a shape that has a text area.<br><br><b>Example</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 }` — four margins (pt, each ≥ 0) | — |
409
- | `delete` | Deletes the shape.<br>- Both inline shapes and shapes placed in front of or behind text can be deleted. | — | — |
410
-
411
- <a id="word-wordstyle"></a>
412
- ### Style — 스타일 (`WordStyle`)
413
-
414
- Gets and updates the information and formatting defined in a style.
415
-
416
- | 기능 | 설명 | 입력 | 결과 |
417
- |---|---|---|---|
418
- | `getStyle` | Returns the information and formatting defined directly on this style.<br>- Formatting from parent styles linked via basedOn is not included.<br>- textFormat and paragraphFormat can be reused to set text and paragraph formatting respectively. Character styles have no paragraphFormat. | — | null if none<br>`(StyleInfo & { textFormat?: TextFormat, paragraphFormat?: ParagraphFormat }) \| null` |
419
- | `getResolvedStyle` | Returns the final style information including formatting inherited from parent styles.<br>- Returned in the same shape as getStyle(), with formatting inheritance via basedOn applied. | — | null if none<br>`(StyleInfo & { textFormat?: TextFormat, paragraphFormat?: ParagraphFormat }) \| null` |
420
- | `update` | Partially updates the formatting defined in the style.<br>- Only the specified fields are changed; the rest are kept. null removes the property so the parent style's formatting applies.<br>- Paragraph styles accept both text and paragraph formatting; character styles accept text formatting only.<br><br><b>Example</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 }` — formatting to change (partial, at least one) | — |
421
-
422
- <a id="word-wordtable"></a>
423
- ### Table — 표 (`WordTable`)
424
-
425
- Gets and edits the structure of a table and the content and formatting of its cells.
426
-
427
- | 기능 | 설명 | 입력 | 결과 |
428
- |---|---|---|---|
429
- | `getId` | Returns the table ID. | — | table ID<br>문자열 |
430
- | `getRowCount` | Returns the number of rows in the table. | — | number of rows in the table<br>숫자 |
431
- | `getColumnCount` | Returns the total number of columns in the table, including the columns occupied by merged cells. | — | total number of columns in the table, taking merges into account<br>숫자 |
432
- | `getRow` | Returns the row at the given position. | `rowIndex` 숫자 — row index (0-based) | the row at that index<br>[`WordTableRow`](#word-wordtablerow) |
433
- | `getCell` | Returns the cell at the given position. | `rowIndex` 숫자 — row index (0-based)<br>`columnIndex` 숫자 — column index (0-based) | the cell at that row and column<br>[`WordTableCell`](#word-wordtablecell) |
434
- | `setValues` | Replaces the content of multiple cells with text from a 2D array.<br>- Puts values[r][c] into row r, column c. Cells not covered by the array and cells whose value is null or undefined are left unchanged.<br>- Throws if the array exceeds the table size.<br><br><b>Example</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[][]` — array of values per row (rows may have different column lengths) | — |
435
- | `delete` | Deletes the table. | — | — |
436
- | `setAlignment` | Sets the horizontal position of the table within the page.<br>- Set the horizontal alignment of cell content with setParagraphFormat() on the cell paragraph, and vertical alignment with setCellVerticalAlignment().<br><br><b>Example</b><pre><code>table.setAlignment(TableAlign.CENTER); // center the table on the page</code></pre> | `align` [`TableAlign`](#word-tablealign) — horizontal position "left" \| "center" \| "right" | — |
437
- | `setColumnWidths` | Sets the widths of all columns in the table.<br>- The array length must equal the total number of columns. Columns with null keep their current width.<br>- Values smaller than the minimum width are raised to the minimum.<br><br><b>Example</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)[]` — array of column widths (pt). A null slot keeps the current value | — |
438
- | `setRowHeights` | Sets the row heights of the table row by row.<br>- The array length must equal the number of rows. Rows with null keep their current height.<br><br><b>Example</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)[]` — array of row heights (pt). A null slot keeps the current value | — |
439
- | `distributeColumns` | Makes the widths of the target columns equal.<br>- Divides the total width of the target columns evenly while preserving it; other columns are unchanged.<br><br><b>Example</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) — target column range. Only the column span (col/colSpan) is used (기본값: whole table) | — |
440
- | `setRowHeight` | Sets the target rows to the same given height.<br><br><b>Example</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` 숫자 — row height (pt, positive)<br>`range` (선택) [`CellRange`](#word-cellrange) — target row range. Only the row span (row/rowSpan) is used (기본값: whole table) | — |
441
- | `insertRow` | Inserts a new row before or after the reference row.<br><br><b>Example</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` 숫자 — reference row index (0-based)<br>`position` (선택) [`InsertAt`](#word-insertat) — insert position "before" (above the reference row) \| "after" (below the reference row) (기본값: InsertAt.AFTER) | the newly created row<br>[`WordTableRow`](#word-wordtablerow) |
442
- | `deleteRow` | Deletes a row. | `rowIndex` 숫자 — index of the row to delete (0-based) | — |
443
- | `insertColumn` | Inserts a new column to the left or right of the reference column.<br>- Access the cells of the new column by passing row and column indices to getCell().<br><br><b>Example</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` 숫자 — reference column index (0-based)<br>`position` (선택) [`InsertAt`](#word-insertat) — insert position "before" (left of the reference column) \| "after" (right of the reference column) (기본값: InsertAt.AFTER) | — |
444
- | `deleteColumn` | Deletes a column. | `columnIndex` 숫자 — index of the column to delete (0-based) | — |
445
- | `mergeCells` | Merges a cell range.<br><br><b>Example</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) — target cell range (anchor + count; at least one of rowSpan/colSpan must be 2 or more) | — |
446
- | `unmergeCells` | Splits the merged cells within the given range.<br><br><b>Example</b><pre><code>table.unmergeCells({ row: 0, col: 0 }); // split the specified merged cell</code></pre> | `range` [`CellRange`](#word-cellrange) — target cell range (omit the counts for a single cell) | — |
447
- | `setCellBackgroundColor` | Sets the background color of a cell range.<br><br><b>Example</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) — target cell range (anchor + count)<br>`color` 문자열 (없을 수 있음) — background color (hex "#RRGGBB"; null or "" removes it) | — |
448
- | `setCellVerticalAlignment` | Sets the vertical alignment of a cell range.<br><br><b>Example</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) — target cell range (anchor + count)<br>`align` [`CellVerticalAlign`](#word-cellverticalalign) — vertical alignment "top" \| "center" \| "bottom" | — |
449
- | `setCellPadding` | Sets the inner padding of the given cell range.<br><br><b>Example</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) — target cell range (anchor + count)<br>`padding` [`Padding`](#word-padding) — padding on 4 sides (pt; only the specified sides change) | — |
450
- | `setCellBorder` | Sets the borders of a cell range.<br><br><b>Example</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) — target cell range (anchor + count)<br>`border` [`Border`](#word-border) — border value (shared by paragraph/cell/page — see the Border typedef of WordRange.setParagraphBorder for field definitions) | — |
451
-
452
- <a id="word-wordtablecell"></a>
453
- ### TableCell — 표 셀 (`WordTableCell`)
454
-
455
- Fills a single table cell with content and sets its formatting.
456
-
457
- | 기능 | 설명 | 입력 | 결과 |
458
- |---|---|---|---|
459
- | `getTable` | Returns the table this cell belongs to. | — | the table this cell belongs to<br>[`WordTable`](#word-wordtable) |
460
- | `getRow` | Returns the row index. | — | 0-based row index<br>숫자 |
461
- | `getColumn` | Returns the column index. | — | 0-based column index<br>숫자 |
462
- | `getParagraphs` | Returns all paragraphs in the cell, in order. | — | array of paragraphs inside the cell (empty array if the cell is empty)<br>[`WordParagraph`](#word-wordparagraph) 목록 |
463
- | `getParagraph` | Returns the paragraph at the given index inside the cell.<br>- Use the returned paragraph to read its text and edit its content and formatting. | `index` (선택) 숫자 — 0-based paragraph index (기본값: 0) | the paragraph, or null if none<br>[`WordParagraph`](#word-wordparagraph) (없을 수 있음) |
464
- | `setText` | Replaces the text of the first paragraph in the cell with the given text.<br>- Only the first paragraph is changed; the other paragraphs of the cell are left as they are.<br><br><b>Example</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` 문자열 — text to set | — |
465
- | `setBackgroundColor` | Sets the cell background color.<br><br><b>Example</b><pre><code>cell.setBackgroundColor("#FFEB3B"); // yellow background<br>cell.setBackgroundColor(null); // remove background</code></pre> | `color` 문자열 (없을 수 있음) — "#RRGGBB" hex color; null/"" removes the background | — |
466
- | `setVerticalAlignment` | Sets the vertical alignment of the cell.<br><br><b>Example</b><pre><code>cell.setVerticalAlignment(CellVerticalAlign.CENTER); // vertically center</code></pre> | `align` [`CellVerticalAlign`](#word-cellverticalalign) — "top" \| "center" \| "bottom" | — |
467
- | `setPadding` | Sets the inner padding of the cell.<br>- Only the specified sides are changed.<br><br><b>Example</b><pre><code>cell.setPadding({ left: 8, right: 8 }); // set only left/right padding to 8pt</code></pre> | `padding` [`Padding`](#word-padding) — padding for the four sides | — |
468
- | `setBorder` | Sets the cell border.<br><br><b>Example</b><pre><code>cell.setBorder({ location: BorderLocation.BOTTOM, style: BorderStyle.SOLID, color: "#000000", width: 1 }); // solid bottom border</code></pre> | `border` [`Border`](#word-border) — border value | — |
469
-
470
- <a id="word-wordtablerow"></a>
471
- ### TableRow — 표 행 (`WordTableRow`)
472
-
473
- Gets a single table row and inserts or deletes adjacent rows.
474
-
475
- | 기능 | 설명 | 입력 | 결과 |
476
- |---|---|---|---|
477
- | `getTable` | Returns the table this row belongs to. | — | the table this row belongs to<br>[`WordTable`](#word-wordtable) |
478
- | `getIndex` | Returns the row index. | — | 0-based row index<br>숫자 |
479
- | `getCells` | Returns the list of cells in this row.<br>- Returned in column order, including merged cells. | — | cells in column order<br>[`WordTableCell`](#word-wordtablecell) 목록 |
480
- | `getCell` | Returns the cell at the given column in this row. | `columnIndex` 숫자 — 0-based column index | the cell at that column<br>[`WordTableCell`](#word-wordtablecell) |
481
- | `delete` | Deletes this row. | — | — |
482
- | `insertSibling` | Inserts a new row above or below this row.<br><br><b>Example</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) — insert position: "before" (above) \| "after" (below) (기본값: InsertAt.AFTER) | the newly created row<br>[`WordTableRow`](#word-wordtablerow) |
483
-
484
- ### 부록 — 입출력 데이터 형식 (Word)
485
-
486
- <a id="word-rangedata"></a>
487
- #### `RangeData`
488
-
489
- | 항목 | 형식 | 설명 |
490
- |---|---|---|
491
- | `startParaId` (선택) | 문자열 | start paragraph ID |
492
- | `startOffset` (선택) | 숫자 | start offset (기본값: start of paragraph) |
493
- | `endParaId` (선택) | 문자열 | end paragraph ID (기본값: startParaId) |
494
- | `endOffset` (선택) | 숫자 | end offset (기본값: end of paragraph) |
495
-
496
- <a id="word-pagesetupinfo"></a>
497
- #### `PageSetupInfo`
498
-
499
- | 항목 | 형식 | 설명 |
500
- |---|---|---|
501
- | `pageSize` | [`Size`](#word-size) (없을 수 있음) | paper dimensions (pt; null if unset) |
502
- | `orientation` | [`PageOrientation`](#word-pageorientation) (없을 수 있음) | orientation (null if unset) |
503
- | `paperSize` | [`PaperSize`](#word-papersize) (없을 수 있음) | name of the matched paper preset (null if no match) |
504
- | `margins` | [`PageMargins`](#word-pagemargins) | margins (pt) |
505
- | `titlePage` | 참/거짓 | whether "different first page" is enabled |
506
- | `breakType` | 문자열 | section break type (nextPage/continuous, etc.; nextColumn for column-break documents) |
507
- | `pageNumber` | [`PageNumbering`](#word-pagenumbering) (없을 수 있음) | page numbering settings of the section (null if unset) |
508
-
509
- <a id="word-pagemargins"></a>
510
- #### `PageMargins`
511
-
512
- | 항목 | 형식 | 설명 |
513
- |---|---|---|
514
- | `top` (선택) | 숫자 | top margin (pt) |
515
- | `bottom` (선택) | 숫자 | bottom margin (pt) |
516
- | `left` (선택) | 숫자 | left margin (pt) |
517
- | `right` (선택) | 숫자 | right margin (pt) |
518
- | `header` (선택) | 숫자 | header area margin (pt) |
519
- | `footer` (선택) | 숫자 | footer area margin (pt) |
520
-
521
- <a id="word-pagenumbering"></a>
522
- #### `PageNumbering`
523
-
524
- | 항목 | 형식 | 설명 |
525
- |---|---|---|
526
- | `start` (선택) | 숫자 | starting number for the first page of this section (integer ≥ 0) |
527
- | `formatType` (선택) | [`NumberFormat`](#word-numberformat) | page number display format (decimal, roman numerals, etc.) |
528
-
529
- <a id="word-columnlayout"></a>
530
- #### `ColumnLayout`
531
-
532
- | 항목 | 형식 | 설명 |
533
- |---|---|---|
534
- | `count` | 숫자 | number of columns (1~12; 1 removes columns) |
535
- | `equalWidth` (선택) | 참/거짓 | whether all columns have the same width (기본값: false if widths is given, otherwise current value) |
536
- | `space` (선택) | 숫자 | spacing between columns (pt; used when a column does not specify its own spacing) (기본값: current value (initially 36)) |
537
- | `separator` (선택) | 참/거짓 | whether to show a separator line between columns (기본값: current value (initially false)) |
538
- | `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) (기본값: current value) |
539
-
540
- <a id="word-columnwidth"></a>
541
- #### `ColumnWidth`
542
-
543
- | 항목 | 형식 | 설명 |
544
- |---|---|---|
545
- | `width` | 숫자 | column width (pt) |
546
- | `space` (선택) | 숫자 | spacing after this column (pt) (기본값: parent space) |
547
-
548
- <a id="word-textformat"></a>
549
- #### `TextFormat`
550
-
551
- | 항목 | 형식 | 설명 |
552
- |---|---|---|
553
- | `bold` (선택) | `boolean \| null` | bold (null removes the property) |
554
- | `italic` (선택) | `boolean \| null` | italic (null removes the property) |
555
- | `underline` (선택) | `boolean \| null` | underline (null removes the property) |
556
- | `size` (선택) | 숫자 (없을 수 있음) | font size (pt, null removes the property) |
557
- | `color` (선택) | 문자열 (없을 수 있음) | text color (hex, e.g. "#FF0000", null removes the property) |
558
- | `font` (선택) | 문자열 (없을 수 있음) | font name (null removes the property) |
559
- | `strikeThrough` (선택) | `boolean \| null` | strikethrough (null removes the property) |
560
- | `highlightColor` (선택) | 문자열 (없을 수 있음) | highlight color (hex, e.g. "#FFFF00"; null/"transparent" removes it) |
561
- | `superscript` (선택) | `boolean \| null` | superscript (mutually exclusive with subscript; takes precedence if both are true, null removes it) |
562
- | `subscript` (선택) | `boolean \| null` | subscript (mutually exclusive with superscript, null removes it) |
563
- | `spacing` (선택) | 숫자 (없을 수 있음) | character spacing (pt, negative tightens; range -12~400, null removes the property) |
564
-
565
- <a id="word-paragraphformat"></a>
566
- #### `ParagraphFormat`
567
-
568
- | 항목 | 형식 | 설명 |
569
- |---|---|---|
570
- | `align` (선택) | [`TextAlign`](#word-textalign) (없을 수 있음) | alignment ("left"\|"center"\|"right"\|"justify", null removes it) |
571
- | `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 |
572
- | `leftIndent` (선택) | 숫자 (없을 수 있음) | left indent (pt, null removes it) |
573
- | `rightIndent` (선택) | 숫자 (없을 수 있음) | right indent (pt, null removes it) |
574
- | `firstLineIndent` (선택) | 숫자 (없을 수 있음) | first-line indent (pt, negative for a hanging indent, null removes it) |
575
- | `spaceBefore` (선택) | 숫자 (없을 수 있음) | space before the paragraph (pt, null removes it) |
576
- | `spaceAfter` (선택) | 숫자 (없을 수 있음) | space after the paragraph (pt, null removes it) |
577
- | `backgroundColor` (선택) | 문자열 (없을 수 있음) | paragraph background color (shading fill, hex "#RRGGBB", null removes it) |
578
- | `outlineLevel` (선택) | [`OutlineLevel`](#word-outlinelevel) (없을 수 있음) | outline level ("level1"~"level9"; "body" or null means body text) |
579
-
580
- <a id="word-border"></a>
581
- #### `Border`
582
-
583
- | 항목 | 형식 | 설명 |
584
- |---|---|---|
585
- | `location` | [`BorderLocation`](#word-borderlocation) | target side (for paragraph borders, top/bottom/left/right/all and between (horizontal line between paragraphs) are valid) |
586
- | `style` | [`BorderStyle`](#word-borderstyle) | line style (solid/dashed/dotted/double/none/hidden) |
587
- | `color` | 문자열 | line color (hex "#RRGGBB") |
588
- | `width` | 숫자 | line width (pt) |
589
-
590
- <a id="word-tabstop"></a>
591
- #### `TabStop`
592
-
593
- | 항목 | 형식 | 설명 |
594
- |---|---|---|
595
- | `position` | 숫자 | tab stop position (pt) |
596
- | `alignment` (선택) | [`TabAlignment`](#word-tabalignment) | alignment ("left"\|"center"\|"right"\|"decimal", default "left") |
597
- | `leader` (선택) | [`TabLeader`](#word-tableader) | leader fill ("none"\|"dot"\|"hyphen"\|"underscore"\|"middleDot", default "none") |
598
-
599
- <a id="word-cellrange"></a>
600
- #### `CellRange`
601
-
602
- | 항목 | 형식 | 설명 |
603
- |---|---|---|
604
- | `row` | 숫자 | anchor row (0-based, relative to the table) |
605
- | `col` | 숫자 | anchor column (0-based, relative to the table) |
606
- | `rowSpan` (선택) | 숫자 | number of rows (기본값: 1) |
607
- | `colSpan` (선택) | 숫자 | number of columns (기본값: 1) |
608
-
609
- <a id="word-padding"></a>
610
- #### `Padding`
611
-
612
- | 항목 | 형식 | 설명 |
613
- |---|---|---|
614
- | `left` (선택) | 숫자 | left padding (pt) |
615
- | `right` (선택) | 숫자 | right padding (pt) |
616
- | `top` (선택) | 숫자 | top padding (pt) |
617
- | `bottom` (선택) | 숫자 | bottom padding (pt) |
618
-
619
- <a id="word-shapeinfo"></a>
620
- #### `ShapeInfo`
621
-
622
- | 항목 | 형식 | 설명 |
623
- |---|---|---|
624
- | `shapeId` | 문자열 | 도형 ID (영구 GUID) |
625
- | `shapeType` | [`ShapeType`](#word-shapetype) | 도형 종류 ("sp"=도형/텍스트박스, "pic"=이미지) |
626
- | `storyId` | 문자열 | 도형이 속한 영역 ID (본문 "0") |
627
- | `width` | 숫자 | 너비(pt) |
628
- | `height` | 숫자 | 높이(pt) |
629
- | `wrap` | [`ShapeWrap`](#word-shapewrap) | 배치 모드 (inline/infront/behind) |
630
- | `zIndex` | 숫자 | 앞뒤 순서 (floating 전용 의미) |
631
- | `anchor` | `{ paragraphId: string; offset?: number }` | 소속 위치 (offset 은 inline 전용 단락 내 글자 위치) |
632
- | `x` (선택) | 숫자 | floating 전용 가로 위치(pt, relativeFromH 기준 — move 에 그대로 재사용 가능) |
633
- | `y` (선택) | 숫자 | floating 전용 세로 위치(pt, relativeFromV 기준) |
634
- | `relativeFromH` (선택) | [`PositionRelativeFromH`](#word-positionrelativefromh) | floating 전용 가로 기준점 |
635
- | `relativeFromV` (선택) | [`PositionRelativeFromV`](#word-positionrelativefromv) | floating 전용 세로 기준점 |
636
- | `fill` | [`ShapeFill`](#word-shapefill) (없을 수 있음) | 채우기 readback (setFill 입력과 대칭) |
637
- | `line` | [`ShapeLine`](#word-shapeline) (없을 수 있음) | 선 readback (setLine 입력과 대칭) |
638
- | `hyperlink` | `{ url: string; tooltip: string; linkType: string; anchor?: string } \| null` | 링크 readback |
639
- | `isTextbox` (선택) | 참/거짓 | 텍스트 영역 보유 여부(텍스트박스) |
640
- | `textboxStoryId` (선택) | 문자열 | 텍스트박스 내부 텍스트 영역 ID |
641
- | `altText` (선택) | 문자열 | 대체 텍스트 |
642
-
643
- <a id="word-size"></a>
644
- #### `Size`
645
-
646
- | 항목 | 형식 | 설명 |
647
- |---|---|---|
648
- | `width` (선택) | 숫자 | width (positive) |
649
- | `height` (선택) | 숫자 | height (positive) |
650
-
651
- <a id="word-shapefill"></a>
652
- #### `ShapeFill`
653
-
654
- | 항목 | 형식 | 설명 |
655
- |---|---|---|
656
- | `type` | [`FillType`](#word-filltype) | fill kind (noFill/solidFill/blipFill/gradFill) |
657
- | `color` (선택) | 문자열 (없을 수 있음) | solidFill color "#RRGGBB" (null/"" removes the fill) |
658
- | `image` (선택) | `{ src?: string; url?: string; base64?: string }` | blipFill image source (exactly one of src, url, base64) |
659
- | `stops` (선택) | `{ position: number; color: string }[]` | gradFill color stops (≥2, position 0~100) |
660
- | `angle` (선택) | 숫자 | gradFill angle (degrees) (기본값: 0 (left→right)) |
661
-
662
- <a id="word-shapeline"></a>
663
- #### `ShapeLine`
664
-
665
- | 항목 | 형식 | 설명 |
666
- |---|---|---|
667
- | `color` (선택) | 문자열 (없을 수 있음) | line color "#RRGGBB" (null or "" removes it) |
668
- | `width` (선택) | 숫자 | line width (pt) |
669
- | `dash` (선택) | [`LineDash`](#common-linedash) (없을 수 있음) | dash style (null removes it) |
670
- | `compound` (선택) | [`LineCompound`](#word-linecompound) (없을 수 있음) | compound line style (null removes it) |
671
-
672
- <a id="word-styleinfo"></a>
673
- #### `StyleInfo`
674
-
675
- | 항목 | 형식 | 설명 |
676
- |---|---|---|
677
- | `style` | 문자열 | style key |
678
- | `name` | 문자열 | display name |
679
- | `type` | `"paragraph" \| "character"` | style type |
680
- | `basedOn` (선택) | 문자열 | key of the parent style it inherits from (if any) |
681
- | `next` (선택) | 문자열 | key of the style for the next paragraph (if any) |
682
-
683
- ### 부록 — 상수 목록 (Word)
684
-
685
- <a id="word-insertat"></a>
686
- #### `InsertAt`
687
-
688
- 삽입 위치 — 기준 객체(receiver)를 기준으로 어디에 넣을지. insert 계열의 옵션 `position` 값.
689
- 밖(형제): before/after, 안(콘텐츠 끝단): start/end.
690
- start/end 의 기준은 기준 객체 종류로 갈린다 — 단락이면 그 단락 콘텐츠의 맨앞/맨끝,
691
- 본문(body)이면 본문 콘텐츠의 맨앞/맨끝(= 첫 단락 앞 / 마지막 단락 뒤).
692
-
693
- | 상수 | 값 | 설명 |
694
- |---|---|---|
695
- | `BEFORE` | `before` | 기준 요소 앞(형제) |
696
- | `AFTER` | `after` | 기준 요소 뒤(형제) |
697
- | `START` | `start` | 기준 요소 콘텐츠 맨 앞 |
698
- | `END` | `end` | 기준 요소 콘텐츠 맨 끝 |
699
-
700
- <a id="word-rangeposition"></a>
701
- #### `RangePosition`
702
-
703
- 범위 조회 위치 — 기준 객체(receiver)의 어느 부분 범위를 반환할지. getRange(RangePosition) 값.
704
-
705
- | 상수 | 값 | 설명 |
706
- |---|---|---|
707
- | `WHOLE` | `whole` | 전체(단락 기호 포함) |
708
- | `START` | `start` | 시작 지점(collapsed) |
709
- | `END` | `end` | 끝 지점(단락 기호 앞, collapsed) |
710
- | `AFTER` | `after` | 단락 기호 다음 지점(collapsed) |
711
- | `CONTENT` | `content` | 단락 기호 제외한 내용 범위 |
712
- | `BEFORE` | `before` | 시작 앞 지점(collapsed) |
713
-
714
- <a id="word-selectionmode"></a>
715
- #### `SelectionMode`
716
-
717
- 선택 영역 기준 위치 — 현재 선택/커서를 어느 지점으로 잡을지.
718
- - select: 선택 영역 전체, start/end: 선택(커서)의 시작/끝 지점(collapsed).
719
-
720
- | 상수 | 값 | 설명 |
721
- |---|---|---|
722
- | `SELECT` | `select` | 현재 선택 영역 전체 |
723
- | `START` | `start` | 선택/커서 시작 지점(collapsed) |
724
- | `END` | `end` | 선택/커서 끝 지점(collapsed) |
725
-
726
- <a id="word-viewcontexttype"></a>
727
- #### `ViewContextType`
728
-
729
- RangeBuilder.fromView() 인자 타입.
730
- View 환경에서 어떤 정보를 ModelRange로 변환할지 결정한다.
731
-
732
- | 상수 | 값 | 설명 |
733
- |---|---|---|
734
- | `CURSOR` | `cursor` | 현재 커서 (selection.getModelRange(false)) |
735
- | `SELECTION` | `selection` | 현재 선택 영역 (selection.getModelRange(true)) |
736
-
737
- <a id="word-structurefilter"></a>
738
- #### `StructureFilter`
739
-
740
- 문서 구조 조회 타입 필터 — getStructure({ type }) / get_document_structure 의 type 값.
741
-
742
- | 상수 | 값 | 설명 |
743
- |---|---|---|
744
- | `TABLE` | `table` | 표 |
745
- | `LIST` | `list` | 목록 단락 |
746
-
747
- <a id="word-rangekind"></a>
748
- #### `RangeKind`
749
-
750
- WordRange 가 "무엇을 가리키는지" 적어 두는 방식(종류).
751
-
752
- OFFSET 만 좌표를 직접 들고 있고, 나머지는 대상의 id·이름만 들고 있다가 **쓸 때 위치를 찾는다**
753
- — 그래서 선택 영역이 바뀌거나 편집으로 표시가 밀려도 항상 지금 위치를 가리킨다.
754
-
755
- | 상수 | 값 | 설명 |
756
- |---|---|---|
757
- | `OFFSET` | `offset` | 단락 ID + 글자 위치를 직접 지정(좌표를 들고 있음 — 이후 편집으로 어긋날 수 있다) |
758
- | `RANGE_POSITION` | `rangePosition` | 영역의 어느 부분인지로 지정(맨앞/맨끝/전체 등 — RangePosition) |
759
- | `VIEW` | `view` | 화면의 선택 영역/커서(쓸 때마다 현재 선택을 다시 읽는다) |
760
- | `COMMENT` | `comment` | 그 댓글이 달린 본문 구간 |
761
- | `NOTE` | `note` | 각주/미주 표시가 놓인 자리 |
762
- | `BOOKMARK` | `bookmark` | 책갈피 표시가 놓인 자리(글자 한 칸) |
763
- | `SHAPE` | `shape` | 도형·이미지가 놓인 자리(글자 한 칸 — floating 이면 앵커 자리) |
764
- | `HYPERLINK` | `hyperlink` | 하이퍼링크의 표시 텍스트 구간(앞뒤 마커는 제외 — 링크를 유지한 채 글자만 다룬다) |
765
- | `CHANGE_TRACKING` | `changeTracking` | 변경 추적 항목이 차지하는 구간 |
766
-
767
- <a id="word-specialcharacter"></a>
768
- #### `SpecialCharacter`
769
-
770
- WordBody.search()/WordRange.search() 로 찾을 수 있는 특수 문자(눈에 보이지 않는 비-텍스트 런) 종류.
771
- Word 찾기/바꾸기의 "특수 문자"에 대응 — 텍스트 검색(search)이 문자로 매칭하지 못하는 요소를 종류로 지목해 위치(Range)를 얻는다.
772
- 값은 코어 모델 런 타입(DefineTypes.element)의 키와 동일하다.
773
-
774
- | 상수 | 값 | 설명 |
775
- |---|---|---|
776
- | `PAGE_BREAK` | `pageBreak` | 페이지 나누기 |
777
- | `COLUMN_BREAK` | `columnBreak` | 단 나누기 |
778
- | `SOFT_BREAK` | `softBreak` | 줄바꿈(Shift+Enter) |
779
- | `TAB` | `tab` | 탭 |
780
- | `SYMBOL` | `symbol` | 기호 |
781
-
782
- <a id="word-zoommode"></a>
783
- #### `ZoomMode`
784
-
785
- 보기 배율/맞춤 모드.
786
- WordDocument.setZoom() 에서 사용한다. 코어에 정의된 배율 프리셋(50~200%)과 맞춤·단계 모드.
787
-
788
- | 상수 | 값 | 설명 |
789
- |---|---|---|
790
- | `SCALE_50` | `50` | 50% |
791
- | `SCALE_66` | `66` | 66% |
792
- | `SCALE_75` | `75` | 75% |
793
- | `SCALE_100` | `100` | 100% (원래 배율) |
794
- | `SCALE_125` | `125` | 125% |
795
- | `SCALE_150` | `150` | 150% |
796
- | `SCALE_200` | `200` | 200% |
797
- | `FIT_WIDTH` | `fitWidth` | 폭 맞춤 |
798
- | `FIT_WINDOW` | `fitInWindow` | 쪽 맞춤 |
799
- | `ZOOM_IN` | `zoomIn` | 한 단계 확대 |
800
- | `ZOOM_OUT` | `zoomOut` | 한 단계 축소 |
801
-
802
- <a id="word-headerfootertype"></a>
803
- #### `HeaderFooterType`
804
-
805
- 머리글/바닥글 종류.
806
- - PRIMARY: 기본(홀수/모든 페이지) — 별도 "odd" 는 없고 PRIMARY 가 그 역할
807
-
808
- | 상수 | 값 | 설명 |
809
- |---|---|---|
810
- | `PRIMARY` | `primary` | 기본 머리글/바닥글 (OOXML default) |
811
- | `FIRST_PAGE` | `firstPage` | 첫 페이지 (OOXML first) |
812
- | `EVEN_PAGES` | `evenPages` | 짝수 페이지 (OOXML even) |
813
-
814
- <a id="word-headerfootervariant"></a>
815
- #### `HeaderFooterVariant`
816
-
817
- 머리글/바닥글 종류의 OOXML/모델 어휘 (WordSection.getHeader/getFooter type 으로도 허용).
818
- - HeaderFooterType(primary/firstPage/evenPages)과 1:1 동의어 — 둘 중 어느 어휘로도 호출 가능.
819
-
820
- | 상수 | 값 | 설명 |
821
- |---|---|---|
822
- | `DEFAULT` | `default` | 기본(= HeaderFooterType.PRIMARY) |
823
- | `FIRST` | `first` | 첫 페이지(= HeaderFooterType.FIRST_PAGE) |
824
- | `EVEN` | `even` | 짝수 페이지(= HeaderFooterType.EVEN_PAGES) |
825
-
826
- <a id="word-sectionbreaktype"></a>
827
- #### `SectionBreakType`
828
-
829
- 구역(section) 나누기 유형 (WordSection.setBreakType type — getPageSetup().breakType 과 대칭).
830
- setBreakType 으로 지정한 값은 getPageSetup().breakType 으로 그대로 다시 읽힌다.
831
- - "단 나누기"(nextColumn)는 구역 나누기 유형이 아니라 본문 inline 나누기다 — WordRange.insertColumnBreak / SpecialCharacter.COLUMN_BREAK 로 다룬다.
832
-
833
- | 상수 | 값 | 설명 |
834
- |---|---|---|
835
- | `CONTINUOUS` | `continuous` | 이어서 (이어나누기) |
836
- | `NEXT_PAGE` | `nextPage` | 다음 페이지부터 |
837
- | `EVEN_PAGE` | `evenPage` | 짝수 페이지부터 |
838
- | `ODD_PAGE` | `oddPage` | 홀수 페이지부터 |
839
-
840
- <a id="word-notetype"></a>
841
- #### `NoteType`
842
-
843
- 각주/미주 종류.
844
- 값은 코어 DefineTypes.noteTypes / DefineActions.type.footnote·endnote 와 동일해 매핑 없이 그대로 쓰인다.
845
-
846
- | 상수 | 값 | 설명 |
847
- |---|---|---|
848
- | `FOOTNOTE` | `footnote` | 각주 (페이지 하단) |
849
- | `ENDNOTE` | `endnote` | 미주 (문서 끝) |
850
-
851
- <a id="word-hyperlinktype"></a>
852
- #### `HyperlinkType`
853
-
854
- 하이퍼링크 종류 (WordHyperlink.getLinkType()).
855
- 종류는 별도 입력축이 아니라 url 에서 정해진다: "#이름"→BOOKMARK, "mailto:"→MAILTO, 그 외→LINK.
856
-
857
- | 상수 | 값 | 설명 |
858
- |---|---|---|
859
- | `LINK` | `link` | 웹 주소 (http/https) |
860
- | `MAILTO` | `mailto` | 이메일 |
861
- | `BOOKMARK` | `bookmark` | 문서 내부 북마크 |
862
-
863
- <a id="word-changetrackingtype"></a>
864
- #### `ChangeTrackingType`
865
-
866
- 변경 추적 항목(change tracking) 공개 유형 (WordChangeTracking.getInfo().type).
867
- 코어 revisionType(ins/del/change)을 정규화한 공개 값 — 변환 맵은 소비자(extractors)가 보유한다.
868
-
869
- | 상수 | 값 | 설명 |
870
- |---|---|---|
871
- | `ADDED` | `added` | 삽입 (코어 ins) |
872
- | `DELETED` | `deleted` | 삭제 (코어 del) |
873
- | `FORMATTED` | `formatted` | 서식 변경 (코어 change) |
874
-
875
- <a id="word-shapewrap"></a>
876
- #### `ShapeWrap`
877
-
878
- 도형 wrap(텍스트 배치) 종류.
879
- 워드 모델이 지원하는 3가지 ([defineTypes.js] shapeWrapType) 만 노출.
880
-
881
- | 상수 | 값 | 설명 |
882
- |---|---|---|
883
- | `INLINE` | `inline` | 텍스트 흐름 안에 글자처럼 박힘 (paragraphId + offset 으로 위치) |
884
- | `INFRONT` | `infront` | 텍스트 위에 떠있음 |
885
- | `BEHIND` | `behind` | 텍스트 뒤에 깔림 |
886
-
887
- <a id="word-positionrelativefromh"></a>
888
- #### `PositionRelativeFromH`
889
-
890
- floating 도형 가로 위치 기준 (OOXML wp:positionH @relativeFrom).
891
-
892
- | 상수 | 값 | 설명 |
893
- |---|---|---|
894
- | `PAGE` | `page` | — |
895
- | `MARGIN` | `margin` | — |
896
- | `COLUMN` | `column` | — |
897
-
898
- <a id="word-positionrelativefromv"></a>
899
- #### `PositionRelativeFromV`
900
-
901
- floating 도형 세로 위치 기준 (OOXML wp:positionV @relativeFrom).
902
-
903
- | 상수 | 값 | 설명 |
904
- |---|---|---|
905
- | `PAGE` | `page` | — |
906
- | `MARGIN` | `margin` | — |
907
- | `PARAGRAPH` | `paragraph` | — |
908
-
909
- <a id="word-shapetype"></a>
910
- #### `ShapeType`
911
-
912
- 도형 종류.
913
-
914
- | 상수 | 값 | 설명 |
915
- |---|---|---|
916
- | `SHAPE` | `sp` | preset geometry 도형 |
917
- | `PICTURE` | `pic` | 이미지 |
918
-
919
- <a id="word-filltype"></a>
920
- #### `FillType`
921
-
922
- 도형 채우기 종류 (setFill type).
923
-
924
- | 상수 | 값 | 설명 |
925
- |---|---|---|
926
- | `NONE` | `noFill` | — |
927
- | `SOLID` | `solidFill` | — |
928
- | `GRADIENT` | `gradFill` | — |
929
- | `IMAGE` | `blipFill` | — |
930
-
931
- <a id="word-textverticalalign"></a>
932
- #### `TextVerticalAlign`
933
-
934
- 텍스트박스 세로 정렬 (setTextVerticalAlign align — bodyPr anchor).
935
- 가로 텍스트(flow=horz) 기준. 모델 anchor 값과 1:1.
936
-
937
- | 상수 | 값 | 설명 |
938
- |---|---|---|
939
- | `TOP` | `top` | — |
940
- | `MIDDLE` | `middle` | — |
941
- | `BOTTOM` | `bottom` | — |
942
-
943
- <a id="word-linecompound"></a>
944
- #### `LineCompound`
945
-
946
- 선 겹선(compound) 스타일 (setShapeLine compound — OOXML a:ln @cmpd).
947
-
948
- | 상수 | 값 | 설명 |
949
- |---|---|---|
950
- | `SINGLE` | `sng` | — |
951
- | `DOUBLE` | `dbl` | — |
952
- | `THICK_THIN` | `thickThin` | — |
953
- | `THIN_THICK` | `thinThick` | — |
954
- | `TRIPLE` | `tri` | — |
955
-
956
- <a id="word-textalign"></a>
957
- #### `TextAlign`
958
-
959
- 텍스트/단락 정렬.
960
-
961
- | 상수 | 값 | 설명 |
962
- |---|---|---|
963
- | `LEFT` | `left` | — |
964
- | `CENTER` | `center` | — |
965
- | `RIGHT` | `right` | — |
966
- | `JUSTIFY` | `justify` | — |
967
-
968
- <a id="word-tablealign"></a>
969
- #### `TableAlign`
970
-
971
- 표 상자의 페이지 내 가로 위치.
972
-
973
- | 상수 | 값 | 설명 |
974
- |---|---|---|
975
- | `LEFT` | `left` | — |
976
- | `CENTER` | `center` | — |
977
- | `RIGHT` | `right` | — |
978
-
979
- <a id="word-cellverticalalign"></a>
980
- #### `CellVerticalAlign`
981
-
982
- 표 셀 세로 정렬.
983
-
984
- | 상수 | 값 | 설명 |
985
- |---|---|---|
986
- | `TOP` | `top` | — |
987
- | `CENTER` | `center` | — |
988
- | `BOTTOM` | `bottom` | — |
989
-
990
- <a id="word-outlinelevel"></a>
991
- #### `OutlineLevel`
992
-
993
- 개요 수준(outline level) — 단락의 개요/목차 상 수준. "body"=본문(개요 수준 없음).
994
-
995
- | 상수 | 값 | 설명 |
996
- |---|---|---|
997
- | `LEVEL_1` | `level1` | — |
998
- | `LEVEL_2` | `level2` | — |
999
- | `LEVEL_3` | `level3` | — |
1000
- | `LEVEL_4` | `level4` | — |
1001
- | `LEVEL_5` | `level5` | — |
1002
- | `LEVEL_6` | `level6` | — |
1003
- | `LEVEL_7` | `level7` | — |
1004
- | `LEVEL_8` | `level8` | — |
1005
- | `LEVEL_9` | `level9` | — |
1006
- | `BODY` | `body` | — |
1007
-
1008
- <a id="word-style"></a>
1009
- #### `Style`
1010
-
1011
- 문서 기본 제공(내장) 스타일 키. setStyle(style) 에 그대로 넘긴다(값 = getStyles() 의 style 키).
1012
- 내장 스타일은 문서 로드 시 항상 존재하므로 이 enum 값은 어느 문서에서든 유효하다.
1013
- 커스텀 문서 스타일은 이 enum 없이 getStyles() 로 얻은 style 값(String)을 직접 넘긴다.
1014
-
1015
- | 상수 | 값 | 설명 |
1016
- |---|---|---|
1017
- | `NORMAL` | `normal` | 본문(기본 단락 스타일) |
1018
- | `TITLE` | `title` | — |
1019
- | `SUBTITLE` | `subtitle` | — |
1020
- | `HEADING_1` | `heading_1` | — |
1021
- | `HEADING_2` | `heading_2` | — |
1022
- | `HEADING_3` | `heading_3` | — |
1023
- | `QUOTE` | `quote` | — |
1024
- | `STRONG` | `strong` | ↓ 글자 스타일 |
1025
- | `EMPHASIS` | `emphasis` | — |
1026
- | `SUBTLE_EMPHASIS` | `subtle_emphasis` | — |
1027
- | `INTENSE_EMPHASIS` | `intense_emphasis` | — |
1028
-
1029
- <a id="word-indenttype"></a>
1030
- #### `IndentType`
1031
-
1032
- 들여쓰기 상대 조정.
1033
-
1034
- | 상수 | 값 | 설명 |
1035
- |---|---|---|
1036
- | `INDENT` | `indent` | — |
1037
- | `OUTDENT` | `outdent` | — |
1038
-
1039
- <a id="word-listtype"></a>
1040
- #### `ListType`
1041
-
1042
- 문서 기본 제공 목록 서식.
1043
-
1044
- | 상수 | 값 | 설명 |
1045
- |---|---|---|
1046
- | `BULLET_CIRCLE` | `bulletCircle` | ● |
1047
- | `BULLET_SQUARE` | `bulletSquare` | ■ |
1048
- | `BULLET_DIAMOND` | `bulletDiamond` | ◆ |
1049
- | `BULLET_CHECK` | `bulletCheck` | ✓ |
1050
- | `BULLET_ARROW` | `bulletArrow` | ➢ |
1051
- | `BULLET_STAR` | `bulletStar` | ✧ |
1052
- | `NUMBER_DECIMAL` | `numberDecimal` | 1. |
1053
- | `NUMBER_UPPER_LETTER` | `numberUpperLetter` | A. |
1054
- | `NUMBER_UPPER_ROMAN` | `numberUpperRoman` | I. |
1055
- | `NUMBER_CIRCLED` | `numberCircled` | ① |
1056
- | `NUMBER_LOWER_LETTER` | `numberLowerLetter` | a. |
1057
- | `NUMBER_LOWER_ROMAN` | `numberLowerRoman` | i. |
1058
- | `MULTILEVEL_NUMBER_LETTER_ROMAN` | `multilevelNumberLetterRoman` | 1. / A. / i. |
1059
- | `MULTILEVEL_NUMBER_LETTER_LETTER` | `multilevelNumberLetterLetter` | 1. / A. / a. |
1060
- | `MULTILEVEL_ROMAN_LETTER_ROMAN` | `multilevelRomanLetterRoman` | I. / A. / i. |
1061
- | `MULTILEVEL_NESTED_NUMBER` | `multilevelNestedNumber` | 1 / 1.1 / 1.1.1 |
1062
- | `MULTILEVEL_NESTED_NUMBER_DOT` | `multilevelNestedNumberDot` | 1. / 1.1. / 1.1.1. |
1063
- | `MULTILEVEL_NESTED_FULL_WIDTH` | `multilevelNestedFullWidth` | 1 / 1-1 / 1-1-1 |
1064
-
1065
- <a id="word-pagenumberarea"></a>
1066
- #### `PageNumberArea`
1067
-
1068
- 페이지 번호 대상 영역 (setPageNumber area).
1069
-
1070
- | 상수 | 값 | 설명 |
1071
- |---|---|---|
1072
- | `HEADER` | `header` | 머리글 |
1073
- | `FOOTER` | `footer` | 바닥글 |
1074
-
1075
- <a id="word-pagenumberalign"></a>
1076
- #### `PageNumberAlign`
1077
-
1078
- 페이지 번호 정렬 (setPageNumber align).
1079
-
1080
- | 상수 | 값 | 설명 |
1081
- |---|---|---|
1082
- | `LEFT` | `left` | 왼쪽 정렬 |
1083
- | `CENTER` | `center` | 가운데 정렬 |
1084
- | `RIGHT` | `right` | 오른쪽 정렬 |
1085
-
1086
- <a id="word-borderstyle"></a>
1087
- #### `BorderStyle`
1088
-
1089
- 테두리 선 스타일 (셀·단락 테두리 공용).
1090
-
1091
- | 상수 | 값 | 설명 |
1092
- |---|---|---|
1093
- | `SOLID` | `solid` | — |
1094
- | `DASHED` | `dashed` | — |
1095
- | `DOTTED` | `dotted` | — |
1096
- | `DOUBLE` | `double` | — |
1097
- | `NONE` | `none` | — |
1098
- | `HIDDEN` | `hidden` | — |
1099
-
1100
- <a id="word-borderlocation"></a>
1101
- #### `BorderLocation`
1102
-
1103
- 테두리 적용 위치(면/영역) (셀·단락 테두리 공용).
1104
- - 단락 테두리: top/bottom/left/right/all/between 유효 (between=단락 사이 가로선, 단락 전용).
1105
- - 표 셀 테두리: top/bottom/left/right/all/outer/inner/betweenRows/betweenColumns 유효.
1106
-
1107
- | 상수 | 값 | 설명 |
1108
- |---|---|---|
1109
- | `TOP` | `top` | — |
1110
- | `RIGHT` | `right` | — |
1111
- | `BOTTOM` | `bottom` | — |
1112
- | `LEFT` | `left` | — |
1113
- | `ALL` | `all` | — |
1114
- | `OUTER` | `outer` | — |
1115
- | `INNER` | `inner` | — |
1116
- | `BETWEEN_ROWS` | `betweenRows` | — |
1117
- | `BETWEEN_COLUMNS` | `betweenColumns` | — |
1118
- | `BETWEEN` | `between` | — |
1119
-
1120
- <a id="word-tabalignment"></a>
1121
- #### `TabAlignment`
1122
-
1123
- 탭 스톱 정렬 (값은 코어 tab val 과 동일).
1124
-
1125
- | 상수 | 값 | 설명 |
1126
- |---|---|---|
1127
- | `LEFT` | `left` | — |
1128
- | `CENTER` | `center` | — |
1129
- | `RIGHT` | `right` | — |
1130
- | `DECIMAL` | `decimal` | — |
1131
-
1132
- <a id="word-tableader"></a>
1133
- #### `TabLeader`
1134
-
1135
- 탭 스톱 리더(빈 공간 채움 문자) (값은 코어 tab leader 와 동일).
1136
-
1137
- | 상수 | 값 | 설명 |
1138
- |---|---|---|
1139
- | `NONE` | `none` | — |
1140
- | `DOT` | `dot` | — |
1141
- | `HYPHEN` | `hyphen` | — |
1142
- | `UNDERSCORE` | `underscore` | — |
1143
- | `MIDDLE_DOT` | `middleDot` | — |
1144
-
1145
- <a id="word-pageorientation"></a>
1146
- #### `PageOrientation`
1147
-
1148
- 페이지 방향 (setPageSize orientation).
1149
-
1150
- | 상수 | 값 | 설명 |
1151
- |---|---|---|
1152
- | `PORTRAIT` | `portrait` | 세로 |
1153
- | `LANDSCAPE` | `landscape` | 가로 |
1154
-
1155
- <a id="word-papersize"></a>
1156
- #### `PaperSize`
1157
-
1158
- 용지 크기 프리셋 (setPageSize 프리셋 이름).
1159
-
1160
- | 상수 | 값 | 설명 |
1161
- |---|---|---|
1162
- | `A3` | `A3` | — |
1163
- | `A4` | `A4` | — |
1164
- | `A5` | `A5` | — |
1165
- | `LETTER` | `Letter` | — |
1166
- | `LEGAL` | `Legal` | — |
1167
- | `EXECUTIVE` | `Executive` | — |
1168
-
1169
- <a id="word-numberformat"></a>
1170
- #### `NumberFormat`
1171
-
1172
- 페이지 번호 형식 (setPageNumbering formatType / getPageSetup().pageNumber.formatType).
1173
-
1174
- | 상수 | 값 | 설명 |
1175
- |---|---|---|
1176
- | `DECIMAL` | `decimal` | 1, 2, 3 |
1177
- | `DECIMAL_CIRCLE` | `decimalEnclosedCircle` | ①, ②, ③ |
1178
- | `DECIMAL_PAREN` | `decimalEnclosedParen` | (1), (2), (3) |
1179
- | `DECIMAL_FULLSTOP` | `decimalEnclosedFullstop` | 1., 2., 3. |
1180
- | `DECIMAL_ZERO` | `decimalZero` | 01, 02, 03 |
1181
- | `DECIMAL_FULL_WIDTH` | `decimalFullWidth` | 1, 2, 3 (전각) |
1182
- | `DECIMAL_HALF_WIDTH` | `decimalHalfWidth` | 1, 2, 3 (반각) |
1183
- | `NUMBER_DASH` | `numberInDash` | -1-, -2-, -3- |
1184
- | `CARDINAL_TEXT` | `cardinalText` | One, Two, Three |
1185
- | `ORDINAL` | `ordinal` | 1st, 2nd, 3rd |
1186
- | `ORDINAL_TEXT` | `ordinalText` | First, Second, Third |
1187
- | `CHICAGO` | `chicago` | *, †, ‡, § |
1188
- | `HEX` | `hex` | 1, 2, ..., 9, A, B |
1189
- | `LOWER_LETTER` | `lowerLetter` | a, b, c |
1190
- | `UPPER_LETTER` | `upperLetter` | A, B, C |
1191
- | `LOWER_ROMAN` | `lowerRoman` | i, ii, iii |
1192
- | `UPPER_ROMAN` | `upperRoman` | I, II, III |
1193
- | `HANGUL_CHOSUNG` | `chosung` | ㄱ, ㄴ, ㄷ |
1194
- | `HANGUL_GANADA` | `ganada` | 가, 나, 다 |
1195
- | `KOREAN_COUNT` | `koreanCounting` | 일, 이, 삼 |
1196
- | `KOREAN_LEGAL` | `koreanLegal` | 하나, 둘, 셋 |
1197
- | `KOREAN_DIGITAL` | `koreanDigital` | 一, 二, 三 |
1198
- | `KOREAN_DIGITAL2` | `koreanDigital2` | 壹, 貳, 參 |
1199
- | `CHINESE_COUNT` | `chineseCounting` | 一, 二, 三 |
1200
- | `CHINESE_COUNTING_THOUSAND` | `chineseCountingThousand` | 一, 二, 三 (천 단위) |
1201
- | `CHINESE_LEGAL` | `chineseLegalSimplified` | 壹, 贰, 叁 |
1202
- | `CHINESE_DIGITAL` | `chineseDigital` | 一, 二, 三 (자릿수 나열) |
1203
- | `CHINESE_ZERO_TAIWANESE_DIGITAL` | `chineseZeroTaiwaneseDigital` | 〇, 一, 二 |
1204
- | `TAIWANESE_COUNT` | `taiwaneseCounting` | 一, 二, 三 |
1205
- | `TAIWANESE_COUNTING_THOUSAND` | `taiwaneseCountingThousand` | 一, 二, 三 (천 단위) |
1206
- | `TAIWANESE_DIGITAL` | `taiwaneseDigital` | 一, 二, 三 (자릿수 나열) |
1207
- | `IDEOGRAPH_DIGITAL` | `ideographDigital` | 一, 二, 三 |
1208
- | `IDEOGRAPH_CIRCLE` | `ideographEnclosedCircle` | ㊀, ㊁, ㊂ |
1209
- | `IDEOGRAPH_LEGAL` | `ideographLegalTraditional` | 壹, 貳, 參 |
1210
- | `IDEOGRAPH_TRADITIONAL` | `ideographTraditional` | 갑, 을, 병 (십간) |
1211
- | `IDEOGRAPH_ZODIAC` | `ideographZodiac` | 자, 축, 인 (십이지) |
1212
- | `IDEOGRAPH_ZODIAC_TRADITIONAL` | `ideographZodiacTraditional` | 갑자, 을축, 병인 (육십갑자) |
1213
- | `JAPANESE_COUNT` | `japaneseCounting` | 一, 二, 三 |
1214
- | `JAPANESE_DIGITAL` | `japaneseDigitalTenThousand` | 一, 二, 三 (만 단위) |
1215
- | `JAPANESE_LEGAL` | `japaneseLegal` | 壱, 弐, 参 |
1216
- | `JAPANESE_AIUEO` | `aiueo` | ア, イ, ウ (반각) |
1217
- | `JAPANESE_AIUEO_FULL_WIDTH` | `aiueoFullWidth` | ア, イ, ウ (전각) |
1218
- | `JAPANESE_IROHA` | `iroha` | イ, ロ, ハ (반각) |
1219
- | `JAPANESE_IROHA_FULL_WIDTH` | `irohaFullWidth` | イ, ロ, ハ (전각) |
1220
- | `NONE` | `none` | 번호 표시 안 함 |
1221
-
1222
- <a id="mod-cell"></a>
1223
- ## Spreadsheet
1224
-
1225
- Spreadsheet 문서를 다루는 기능입니다. 시트·셀 값 편집, 서식 적용, 차트·표·자동 필터 관리 등을 외부 서비스에서 호출할 수 있습니다.
1226
-
1227
- <a id="cell-workbook"></a>
1228
- ### Workbook — 통합 문서 (`Workbook`)
1229
-
1230
- | 기능 | 설명 | 입력 | 결과 |
1231
- |---|---|---|---|
1232
- | `getSheetList` | 전체 시트 목록을 배열로 반환한다. 배열 순서가 시트 인덱스이다.<br>시트별 상세 속성(hidden/tabColor/usedRange 등)은 ApiWorksheet.getSheetInfo() 로 조회한다. | — | `{ name: string; active: boolean }[]` |
1233
- | `getWorksheet` | 시트 핸들을 반환한다. 인덱스(0-based) 또는 시트 이름으로 지정하며, 생략하면 현재 활성 시트를 대상으로 한다.<br>없는 이름이면 SHEET_NOT_FOUND, 범위 밖 인덱스거나 숫자·문자열이 아니면 INVALID_ARGUMENT 를 throw 한다. | `sheet` (선택) `number \| string` | [`Worksheet`](#cell-worksheet) |
1234
- | `getObjectById` | oid(전역 유일 키)로 객체 핸들을 반환한다. 시트를 몰라도 전역 역산으로 찾는다.<br>현재는 차트만 핸들(ApiChart)을 제공하며, 차트가 아니거나 부재하면 null 을 반환한다.<br>(향후 다른 객체 타입 핸들의 공통 진입점) | `oid` 문자열 | [`Chart`](#cell-chart) |
1235
- | `getTable` | 이름으로 테이블 핸들을 반환한다. 워크북 전체에서 이름은 unique 하다. 없으면 null.<br>조회는 대소문자를 무시하고, 핸들에는 표의 정본 이름을 담는다. | `name` 문자열 | [`Table`](#cell-table) |
1236
- | `getDefinedName` | 정의된 이름 핸들. sheet 생략 시 전역(localSheetId=-1), 지정 시 그 시트 로컬. 없으면 null. | `name` 문자열<br>`sheet` (선택) `number \| string` — 시트 로컬 스코프면 시트 이름/인덱스 (생략 시 전역) | [`Name`](#cell-name) |
1237
- | `addDefinedName` | 정의된 이름 생성. sheet 생략 시 전역, 지정 시 그 시트 로컬. | `name` 문자열<br>`formula` 문자열<br>`sheet` (선택) `number \| string` — 시트 로컬 스코프면 시트 이름/인덱스 (생략 시 전역) | [`Name`](#cell-name) |
1238
- | `getDefinedNameList` | 정의된 이름 요약 목록(내장 제외). sheet 생략 시 전역, 지정 시 그 시트 로컬. | `sheet` (선택) `number \| string` — 시트 로컬 스코프면 시트 이름/인덱스 (생략 시 전역) | `{ name: string; sheet: string \| null; formula: string }[]` |
1239
- | `addSheet` | 새 시트를 추가한다. | `name` 문자열 | `{ sheetIndex: number; sheetName: string }` |
1240
- | `removeSheet` | 시트를 삭제한다. | `sheet` `number \| string` | — |
1241
- | `copySheet` | 시트를 복사한다. 복사된 시트는 원본 시트 바로 뒤에 추가된다. | `sheet` `number \| string` | `{ sheetIndex: number; sheetName: string }` |
1242
- | `moveSheet` | 시트 위치를 이동한다. | `from` `number \| string`<br>`to` 숫자 — 0 ~ (시트 갯수 - 1) 사이의 정수 | — |
1243
- | `setActiveSheet` | 활성 시트를 변경한다. | `sheet` `number \| string` | — |
1244
- | `getDocumentProperties` | 워크북 문서 속성을 반환한다.<br>creator 는 원본 문서 작성자로, 값이 없는 문서(신규 웹 생성 문서 등)에서는 undefined 일 수 있다. | — | `{ application: string; creator: string \| undefined; created: any; lastModified: any; fileType: any; locale: string }` |
1245
-
1246
- <a id="cell-worksheet"></a>
1247
- ### Worksheet — 워크시트 (`Worksheet`)
1248
-
1249
- | 기능 | 설명 | 입력 | 결과 |
1250
- |---|---|---|---|
1251
- | `getName` | *설명 준비 중* | — | 문자열 |
1252
- | `isHidden` | *설명 준비 중* | — | 참/거짓 |
1253
- | `getTabColor` | 시트 탭 색상을 "#RRGGBB" 형태로 반환한다. 색이 지정되지 않았으면 "". | — | 문자열 |
1254
- | `getSelection` | 현재 선택 영역을 반환한다. | — | [`Range`](#cell-range) |
1255
- | `getUsedRange` | 데이터(값 또는 셀 서식)가 존재하는 사용 범위를 반환한다. 데이터가 없으면 null. | — | [`Range`](#cell-range) |
1256
- | `getMergeCellList` | 이 시트의 모든 병합 셀 목록을 A1 범위 문자열 배열로 반환한다.<br>핸들이 아니라 요약 배열을 반환하며(List 접미사 컨벤션), 병합이 없으면 빈 배열.<br>범위와 교차하는 병합만 조회하려면 Range.getMergeCellList() 를 사용한다. | — | 문자열 목록 |
1257
- | `getHyperlinkList` | 이 시트의 전체 하이퍼링크 목록을 반환한다. | — | [`HyperlinkInfo`](#cell-hyperlinkinfo) 목록 |
1258
- | `getFreezePanes` | 틀 고정 정보를 반환한다. | — | rows=고정 행 수, cols=고정 열 수 (0이면 고정 없음)<br>`{ rows: number; cols: number }` |
1259
- | `getGridlinesVisible` | 눈금선 표시 여부를 반환한다. | — | 참/거짓 |
1260
- | `getZoom` | 줌 배율을 반환한다. 분수 스케일(1=100%)로 반환한다. (퍼센트 변환 없음) | — | 숫자 |
1261
- | `getSheetInfo` | 시트 정보를 한 번에 반환한다. (통합 읽기)<br>usedRange/selection 은 A1 범위 문자열이며, usedRange 는 데이터가 없는 빈 시트에서 null 이다. | — | [`SheetInfo`](#cell-sheetinfo) |
1262
- | `setName` | 시트 이름을 변경한다. | `name` 문자열 | — |
1263
- | `setHidden` | 시트의 표시/숨김을 설정한다. hidden 이 null/undefined 면 아무 동작도 하지 않는다. | `hidden` 참/거짓 — true=숨김, false=표시 | — |
1264
- | `setTabColor` | 시트 탭 색상을 설정한다. | `color` 문자열 | — |
1265
- | `setSelection` | 선택 영역을 설정한다. 대상 시트가 활성 시트가 아니면 먼저 활성화된다. | `range` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — A1 표기 문자열("A1:B2", 단일 셀은 "E10") 또는 0-based 좌표 객체(단일 셀은 row2/col2 생략 가능) | 적용 후 위치 — sheet=시트 이름, selection=A1 표기 문자열<br>`{ sheet: string; selection: string }` |
1266
- | `goto` | 지정 범위로 이동(goto)한다. 선택 영역을 설정하고 대상 셀이 보이도록 화면을 스크롤한다.<br>대상 시트가 활성 시트가 아니면 먼저 활성화된다.<br>setSelection 이 선택만 바꾸는 것과 달리, 이름상자/이동 다이얼로그와 동일한 이동 동작이다. | `range` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — A1 표기 문자열("A1:B2", 단일 셀은 "E10") 또는 0-based 좌표 객체(단일 셀은 row2/col2 생략 가능) | 이동 후 위치 — sheet=시트 이름, selection=A1 표기 문자열<br>`{ sheet: string; selection: string }` |
1267
- | `setFreezePanes` | 틀 고정을 설정한다. | `rows` 숫자 — 고정할 상단 행 수 (0이면 행 고정 해제)<br>`cols` 숫자 — 고정할 좌측 열 수 (0이면 열 고정 해제) | — |
1268
- | `setGridlinesVisible` | 눈금선 표시 여부를 설정한다. | `visible` 참/거짓 | — |
1269
- | `setZoom` | 줌 배율을 설정한다. 분수 스케일(1=100%)로 지정한다.<br>ZOOM_MIN(0.5)~ZOOM_MAX(1.5) 범위를 벗어나면 ZOOM_OUT_OF_RANGE 를 throw 한다. (clamp 아님) | `zoomFactor` 숫자 | — |
1270
- | `getRange` | 이 시트의 Range 핸들을 반환한다. | `range` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — A1 표기 문자열("A1:B2", 단일 셀은 "E10") 또는 0-based 좌표 객체(단일 셀은 row2/col2 생략 가능) | [`Range`](#cell-range) |
1271
- | `addChart` | 이 시트에 차트를 추가하고 ApiChart 핸들을 반환한다.<br>영역 인자는 진입부에서 0-based 좌표로 정규화하며, command 이하로는 좌표만 전달한다. | `chartType` [`ChartType`](#common-charttype) — 차트 종류 enum 값(= enum 문자열, 예: "clustered_column"). 미정의/미지원이면 CHART_TYPE_UNSUPPORTED throw.<br>`dataRange` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 데이터 범위(A1 표기 문자열 또는 0-based 좌표 객체)<br>`opts` (선택) `{ seriesBy?: "auto" \| "rows" \| "columns" }` — 추가 옵션<br> · `seriesBy` 시리즈 방향. rows=행이 시리즈, columns=열이 시리즈, auto(기본)=데이터 모양에 따라 자동. 분산형/거품형은 rows/columns 미지원(CHART_SWITCH_UNSUPPORTED) | [`Chart`](#cell-chart) |
1272
- | `getChart` | 이 시트에서 oid 로 차트 핸들을 반환한다. 이 시트에 없으면(다른 시트이거나 부재) CHART_NOT_FOUND 를 throw 한다. | `oid` 문자열 | [`Chart`](#cell-chart) |
1273
- | `getChartList` | 이 시트의 모든 차트 요약을 배열로 반환한다.<br>핸들이 아니라 요약 객체를 반환하므로(getSheetList 와 동일 컨벤션 — 요약 반환은 List 접미사),<br>핸들이 필요하면 요약의 oid 로 getChart(oid) 를 호출해 복원한다. | — | `{ oid: string; type: string; range: string \| null; title: string }[]` |
1274
- | `addTable` | 이 시트에 테이블을 추가하고 ApiTable 핸들을 반환한다.<br>영역 인자는 진입부에서 0-based 좌표로 정규화하며, command 이하로는 좌표만 전달한다. | `dataRange` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 데이터 범위(A1 표기 문자열 또는 0-based 좌표 객체)<br>`hasHeaders` (선택) 참/거짓 — 첫 행을 머리글로 사용할지 여부 (기본값: true) | [`Table`](#cell-table) |
1275
- | `getTableList` | 이 시트의 모든 테이블 요약을 배열로 반환한다.<br>핸들이 아니라 요약 객체를 반환하므로(List 접미사 컨벤션),<br>핸들이 필요하면 요약의 name 으로 Workbook.getTable(name) 을 호출해 복원한다. | — | 요약 스키마는 ApiTable.getInfo() 의 TableInfo 와 동일<br>[`TableInfo`](#cell-tableinfo) 목록 |
1276
- | `getFilter` | 이 시트의 자동 필터 핸들을 반환한다. 필터 유무와 무관하게 항상 핸들을 반환한다(null 아님).<br>필터 생성/존재 조회는 핸들에서 수행한다(create() / getInfo().enabled). | — | [`Filter`](#cell-filter) |
1277
- | `getConditionalFormatList` | 이 시트의 조건부 서식 규칙 요약을 배열로 반환한다(핸들 아님 — priority 키 요약).<br>내부 모델 ruleInfo 전체 대신, 규칙을 추가할 때(add_conditional_format) 지정하는 것과 동일한<br>정규화 rule 형태(rule_type + 타입별 필드)만 `rule` 에 담는다(conditionalFormat.spec.md §4 스키마).<br>priority/ranges/stopIfTrue 는 규칙 식별·일괄편집(update)용 메타로 함께 반환한다. 강조 서식(style)은<br>규칙과 분리된 dxf 참조라 이 조회에는 포함하지 않는다.<br>ranges 는 다중(비연속) 영역도 콤마로 이어붙인 단일 A1 문자열이라 update 의 set_ranges[].ranges 에<br>그대로 되돌려 넣을 수 있다(콤마 = A1 참조 문법의 다중 영역 연산자). | — | `{ priority: number; stopIfTrue: boolean; ranges: string; rule: Record<string, unknown> }[]` |
1278
- | `getDataValidationList` | 이 시트의 데이터 유효성 규칙 요약을 반환한다(핸들 아님 — list-only). 각 항목에 적용 ranges(A1) 포함. | — | [`DataValidationRule`](#cell-datavalidationrule) 목록 |
1279
- | `getCommentList` | 이 시트의 모든 셀 메모를 요약 배열로 반환한다(핸들 아님 — list-only). 메모가 없으면 빈 배열.<br>cell=앵커 셀(A1), text=본문(plain text), visible=표시 여부(true=항상 표시 / false=hover 시 표시). | — | `{ cell: string; text: string; visible: boolean }[]` |
1280
- | `updateConditionalFormatRules` | 조건부 서식 규칙을 일괄 편집한다(삭제 / 적용영역 변경 / 우선순위 단건 move — 단일 트랜잭션, all-or-nothing).<br>규칙 내용(operator/formula/type 등) 편집은 UI(규칙 관리자)에도 없는 기능이라 미지원 — 내용 변경은 삭제 후 재추가로 처리한다. | `descriptor` 객체 — deletes: {number[]} 삭제할 규칙 priority 목록 - set_ranges: {{priority:number, ranges:string\|{row1,col1,row2?,col2?}[]}[]} 규칙별 적용영역 변경. 규칙 하나가 다중(비연속) 영역을 가질 수 있어 ranges 는 목록이다 — 콤마 구분 A1 문자열 ("A1:B2,D4:E5") 또는 좌표 객체 배열 ([{row1, col1, row2, col2}, ...]). 문자열 배열은 콤마 문자열과 중복이라 받지 않고, 빈 목록도 받지 않는다(영역 제거는 deletes 소관) - move_priority: {{priority:number, to:number}} 우선순위 단건 move (호출당 1건) — 대상 규칙을 목표 위치로 옮기고 사이 규칙은 한 칸씩 shift(Excel/Sheets 동일). 닫힌 순열 전개는 command 가 수행(UI 규칙 관리자의 setPriorities 닫힌 순열 경로는 별도 유지) | — |
1281
-
1282
- <a id="cell-chart"></a>
1283
- ### Chart — 차트 (`Chart`)
1284
-
1285
- | 기능 | 설명 | 입력 | 결과 |
1286
- |---|---|---|---|
1287
- | `getType` | 차트 타입을 enum 문자열로 반환한다. 미지원/미매핑 타입(파일 로드 stock/surface 등)은 "unknown". | — | 문자열 |
1288
- | `isEditable` | 차트가 편집 가능한지 반환한다. 대상 부재·복원 불가·외부 데이터 차트는 false (throw 하지 않는다). | — | 참/거짓 |
1289
- | `getTitle` | 차트 제목을 반환한다. 미설정 시 빈 문자열. | — | 문자열 |
1290
- | `getAxisTitle` | 축 제목을 반환한다. 미설정 시 빈 문자열,<br>축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw. | 문자열 (없을 수 있음) |
1291
- | `getLegendPosition` | 범례 위치를 반환한다. 범례가 없으면 "none". | — | [`ChartLegendPosition`](#common-chartlegendposition) |
1292
- | `getDataLabelPosition` | 데이터레이블 위치를 반환한다. 레이블이 없으면 "none". | — | [`ChartDataLabelPosition`](#common-chartdatalabelposition) |
1293
- | `getGridLine` | 축별 눈금선 종류를 반환한다. 꺼져 있으면 "none",<br>해당 눈금선을 갖지 않는 차트 종류는 null. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw. | [`ChartGridLineType`](#common-chartgridlinetype) (없을 수 있음) |
1294
- | `getState` | 차트의 공통 서식 상태를 모델 조회 1회로 반환한다. 각 값은 동명 getter 와 같은 규약이다 —<br>axisTitle/gridLine 의 null 은 그 차트 종류에 해당 축의 제목·눈금선이 없다는 뜻이고,<br>"none" 은 지원하지만 꺼져 있다는 뜻이다.<br><br>개별 getter 는 호출마다 대상 실존 확인(hasChart)을 반복하므로, 여러 값을 함께 읽을 때는 이 쪽을 쓴다. | — | `{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string \| null; vertical: string \| null }; gridLine: { horizontal: ChartGridLineType \| null; vertical: ChartGridLineType \| null } }` |
1295
- | `setType` | 차트 종류를 변경한다. 현재 종류와 같으면 아무것도 하지 않는다 —<br>종류가 그대로인데 스타일 미지정 차트의 스타일만 기본값으로 바뀌는 부작용을 막는다. | `chartType` [`ChartType`](#common-charttype) — 차트 종류 enum 값(= enum 문자열, 예: "clustered_column"). 미정의/미지원이면 CHART_TYPE_UNSUPPORTED throw. | — |
1296
- | `setStyle` | 차트 프리셋 스타일을 변경한다. 번호별 실제 색은 문서 테마에 종속된다. | `style` 숫자 — 스타일 번호 (1~12 정수). 3개 단위로 색 그룹이 나뉘고(1~3=그룹1, 4~6=그룹2, 7~9=그룹3, 10~12=그룹4), 그룹 내 순서는 배경 변형이다(1번째=반투명 배경, 2번째=흰색 배경, 3번째=색상 배경+계열 테두리 — 정의는 chartInfo.setStyle JSDoc). 형태 위반 시 CHART_STYLE_INVALID throw. | — |
1297
- | `setTitle` | 차트 제목을 설정한다. | `title` 문자열 | — |
1298
- | `setAxisTitle` | 축 제목을 설정한다. 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는<br>CHART_AXIS_TITLE_UNSUPPORTED throw. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw.<br>`title` 문자열 | — |
1299
- | `setLegendPosition` | 범례 위치를 설정한다. "none"이면 범례를 숨긴다. | `position` [`ChartLegendPosition`](#common-chartlegendposition) — 그 외 CHART_LEGEND_POSITION_INVALID throw. | — |
1300
- | `setDataLabelPosition` | 데이터레이블 위치를 설정한다. "none"이면 숨긴다.<br>차트 타입별 유효 위치까지 검증한다 — 타입 그룹 미정의는 CHART_DATALABEL_UNSUPPORTED,<br>그룹에 없는 위치는 CHART_DATALABEL_POSITION_INVALID throw. "none"은 전 타입 허용. | `position` [`ChartDataLabelPosition`](#common-chartdatalabelposition) — 그 외 CHART_DATALABEL_POSITION_INVALID throw. | — |
1301
- | `setGridLine` | 차트 눈금선을 설정한다. "none"이면 해당 축 눈금선을 숨긴다.<br>차트 타입별 지원 여부까지 검증한다 — 원형 계열·도넛은 양축, 방사형은 세로 축이<br>CHART_GRID_LINE_UNSUPPORTED throw. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw.<br>`gridType` [`ChartGridLineType`](#common-chartgridlinetype) — 그 외 CHART_GRID_LINE_INVALID throw. | — |
1302
- | `getId` | 차트 핸들 키(oid)를 반환한다. | — | 문자열 |
1303
- | `getDataRange` | 차트 데이터 범위를 A1 문자열로 반환한다.<br>다중/cross-sheet 등으로 단일 bounding range 가 성립하지 않으면 null. | — | 문자열 (없을 수 있음) |
1304
- | `getInfo` | 차트 요약 정보를 반환한다. getChartList 가 쓰는 요약 스키마.<br>타입·제목은 공통 mixin 의 getState() 로 받고, 데이터 범위만 chartGraphic 을 따로 읽는다. | — | `{ oid: string; type: string; range: string \| null; title: string }` |
1305
- | `delete` | 차트를 삭제한다. | — | `{ undoable: boolean; undoBufferCleared: boolean }` |
1306
- | `setDataRange` | 차트의 데이터 소스 범위를 다른 셀 범위로 교체한다.<br>영역 인자는 진입부에서 0-based 좌표로 정규화하며, command 이하로는 좌표만 전달한다.<br>차트가 속한 시트 기준 단일 범위만 지원한다(cross-sheet 는 getDataRange 와 대칭으로 미지원).<br>무효 범위/시리즈 상한 초과는 CHART_RANGE_INVALID 를 throw 한다. | `dataRange` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 데이터 범위(A1 표기 문자열 또는 0-based 좌표 객체)<br>`seriesBy` (선택) `"auto" \| "rows" \| "columns"` — 시리즈 방향. rows=행이 시리즈, columns=열이 시리즈, auto=새 범위 모양 기준 자동. 미지정 시 기존 방향 유지. 분산형/거품형은 rows/columns 미지원(CHART_SWITCH_UNSUPPORTED) | — |
1307
- | `switchRowColumn` | 차트의 행/열(시리즈 방향)을 전환한다. 호출할 때마다 전환 상태가 토글된다.<br>분산형/거품형 차트는 전환을 지원하지 않으며 CHART_SWITCH_UNSUPPORTED 를 throw 한다.<br>데이터 범위가 없거나 시리즈 상한(행/열 100개)을 넘는 차트는 CHART_RANGE_INVALID 를 throw 한다. | — | — |
1308
- | `setPosition` | 차트를 지정한 시작 셀로 이동한다. (이동 전용 — 현재 크기 유지)<br>영역 인자는 진입부에서 0-based 좌표로 정규화하며, command 이하로는 좌표만 전달한다.<br>단일 셀 의미이므로 범위를 넘겨도 **좌상단(row1, col1)만** 새 from 앵커로 사용한다 — 우하단은 무시된다.<br>크기 변경(리사이즈)은 후속 범위이며, endCell 을 넘기면 UNSUPPORTED_OPERATION 을 throw 한다. | `startCell` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 이동 목표 셀(A1 표기 문자열 또는 0-based 좌표 객체 — 단일 셀은 row2/col2 생략 가능). 좌상단만 사용<br>`endCell` (선택) `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 후속 리사이즈용 예약(우하단). 현재 지정 시 UNSUPPORTED_OPERATION throw. | — |
1309
-
1310
- <a id="cell-filter"></a>
1311
- ### Filter — 자동 필터 (`Filter`)
1312
-
1313
- | 기능 | 설명 | 입력 | 결과 |
1314
- |---|---|---|---|
1315
- | `create` | 자동 필터를 생성한다. (SET_FILTER 라우팅)<br> - 시트: 전달 범위(range)에 필터를 설정한다. range 생략 시 command 가 현재 선택영역 기준으로 유도한다.<br> - 테이블: range 는 무시하고 테이블 구조(머리글~데이터, 합계 행 제외)로 설정한다.<br>이미 필터가 있으면 SET_FILTER command 가 FILTER_INVALID_RANGE 로 거부하므로 여기서 선검사하지 않는다. | `range` (선택) `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 시트 필터 범위(A1 표기 문자열 또는 0-based 좌표 객체). 생략 시 선택영역 기준. | — |
1316
- | `applyFilter` | 지정 열에 필터 조건을 적용한다. criteria=null 이면 해당 열 조건을 해제한다. | `colId` 숫자 — 대상 열 — 필터 범위 첫 열부터의 0-based 오프셋 (0=첫 열, Filter.sort 의 colId 와 동일 의미). 정수가 아니거나 음수면 FILTER_INVALID_RANGE, 범위 상한 검증은 APPLY_FILTER command 가 수행한다(위반 시 FILTER_INVALID_RANGE).<br>`criteria` `Record<string, unknown> \| null` — filterType 별 스키마 또는 null(해제). APPLY_FILTER command 스키마와 동일. 종류·연산자 어휘는 FilterType/FilterOperator/FilterDynamicType. | — |
1317
- | `clearFilter` | 필터 조건을 해제한다. colId 지정 시 해당 열만, 생략 시 조건이 걸린 모든 열을 일괄 해제한다.<br>두 모드 모두 필터 영역·구조는 유지된다 — 필터(영역) 자체를 제거하는 remove() 와 구분.<br> - colId 지정: applyFilter(colId, null) 동치. 시트 필터가 없으면 FILTER_NOT_FOUND.<br> - colId 생략(전체 해제): 해제할 조건이 없으면 no-op. 열별로 APPLY_FILTER(null) 를 반복하므로<br> undo 가 열 수만큼 분할된다. | `colId` (선택) 숫자 — 해제할 열 — 필터 범위 첫 열부터의 0-based 오프셋 (0=첫 열). 생략(undefined)하면 모든 열의 조건을 해제한다. undefined 도 유효 정수도 아니면(문자열·음수·비정수) FILTER_INVALID_RANGE. | — |
1318
- | `sort` | 필터/테이블 컨텍스트를 지정 열 기준으로 정렬한다. (SORT_FILTER 라우팅 — sortState 갱신)<br> - 시트 필터: 필터가 없으면 FILTER_NOT_FOUND (정렬은 명시 필터 필요, create() 선행).<br> - 테이블 필터: 필터가 없으면 정렬 전 자동 생성된다(테이블 필터링은 내재적). | `colId` 숫자 — 정렬 기준 열 — 필터 범위 첫 열부터의 0-based 오프셋 (0=첫 열). 정수가 아니거나 음수면 INVALID_SORT_FIELD, 범위 상한 검증은 SORT_FILTER command 가 수행한다(위반 시 INVALID_SORT_FIELD).<br>`order` [`SortOrder`](#cell-sortorder) — 정렬 방향 | this<br>[`Filter`](#cell-filter) |
1319
- | `remove` | 자동 필터(영역)를 제거한다. (REMOVE_FILTER 라우팅 — 시트/테이블 공통)<br>조건만 해제하고 필터 영역·구조를 유지하는 clearFilter() 와 구분된다.<br>대상에 필터가 없으면 REMOVE_FILTER command 가 FILTER_NOT_FOUND 로 throw 하므로 여기서 선검사하지 않는다. | — | — |
1320
- | `getInfo` | 필터 정보를 조회한다. (command 없음 — Model getter 조합. 절대 throw 하지 않는다)<br>필터가 없으면(시트 미생성 / 테이블 내재적 필터 미생성) `{ enabled: false }` 만 반환한다 —<br>range/columns/hiddenRowCount/sort 는 필터가 있을 때만 포함된다.<br>columns 는 조건이 걸린 열만 포함하며, criteria 는 정규화 criteria 로 역변환된다. | — | [`FilterInfo`](#cell-filterinfo) |
1321
-
1322
- <a id="cell-name"></a>
1323
- ### Name — 이름 정의 (`Name`)
1324
-
1325
- | 기능 | 설명 | 입력 | 결과 |
1326
- |---|---|---|---|
1327
- | `getName` | Returns the defined name string. | — | 문자열 |
1328
- | `getSheetName` | Returns the sheet name for a sheet-scoped name, or null for workbook scope. | — | 문자열 (없을 수 있음) |
1329
- | `getFormula` | Returns the active formula with a leading "=". | — | 문자열 |
1330
- | `setName` | Renames the defined name. | `newName` 문자열 | — |
1331
- | `setFormula` | Replaces the formula. | `formula` 문자열 | — |
1332
- | `update` | Updates name or formula. | `fields` `{ newName?: string; formula?: string }` | — |
1333
- | `delete` | Deletes the defined name. | — | — |
1334
- | `getInfo` | Returns a simple info object. | — | `{ name: string; sheet: string \| null; formula: string }` |
1335
-
1336
- <a id="cell-range"></a>
1337
- ### Range — 셀 범위 (`Range`)
1338
-
1339
- | 기능 | 설명 | 입력 | 결과 |
1340
- |---|---|---|---|
1341
- | `isSingleCell` | 범위가 셀 하나인지 반환한다. 행/열 전체 범위(A:A, 5:5 — -1 마커·0~MAX 표현 모두)는<br>크기와 무관하게 false 다. | — | 참/거짓 |
1342
- | `getValue` | 범위 좌상단 셀의 값을 모델 원본 그대로 반환한다. 날짜는 시리얼 숫자, 수식 에러는 "#REF!" 같은 문자열이다. | — | 값이 없으면 undefined<br>값 |
1343
- | `getValues` | 범위 전체의 값을 행 우선 2차원 배열로 반환한다. 바깥 배열이 행, 안쪽 배열이 열이며 범위 크기와<br>같다 — 빈 셀도 자리를 차지한다. | — | 시트에 데이터가 전혀 없을 때만 빈 배열<br>`any[][]` |
1344
- | `getFormula` | 범위 좌상단 셀의 수식 문자열을 반환한다. 수식이 아닌 셀(상수·빈 셀)이면 undefined 다. | — | 문자열 (없을 수 있음) |
1345
- | `getDisplayValue` | 범위 좌상단 셀의 화면 표시 문자열을 반환한다. 표시 서식(숫자 서식)이 적용된 결과라 원본 값과 다를 수 있다. | — | 셀이 비어 있으면 빈 문자열<br>문자열 |
1346
- | `getFormulas` | 범위 내 모든 셀의 수식을 2차원 배열로 반환한다.<br>수식이 없는 셀은 null. | — | `(string \| null)[][]` |
1347
- | `getDisplayValues` | 범위 내 모든 셀의 서식 적용된 표시값을 2차원 배열로 반환한다. | — | `string[][]` |
1348
- | `getCellContent` | 단일 셀의 value, displayValue, formula를 한 번에 반환한다. | — | `{ value: any; displayValue: string; formula: string \| null }` |
1349
- | `getCellContents` | 범위 내 모든 셀의 { value, displayValue, formula } 객체를 2차원 배열로 반환한다. | — | `{ value: any; displayValue: string; formula: string \| null }[][]` |
1350
- | `getRowHeight` | 범위 첫 행의 높이(px)를 반환한다. 숨긴 행도 숨기기 전 높이를 반환한다. | — | 숫자 |
1351
- | `getColumnWidth` | 범위 첫 열의 너비(px)를 반환한다. 숨긴 열도 숨기기 전 너비를 반환한다. | — | 숫자 |
1352
- | `setRowHeight` | 범위에 걸친 행의 높이(px)를 설정한다. 0 이하를 주면 높이 변경이 아니라 행 숨김으로 동작한다. | `height` 숫자 | — |
1353
- | `setColumnWidth` | 범위에 걸친 열의 너비(px)를 설정한다. 0 이하를 주면 너비 변경이 아니라 열 숨김으로 동작한다. | `width` 숫자 | — |
1354
- | `autofitRows` | 범위의 행 높이를 셀 내용에 맞춰 자동으로 조정한다. | — | — |
1355
- | `autofitColumns` | 범위의 열 너비를 셀 내용에 맞춰 자동으로 조정한다. | — | — |
1356
- | `insertRow` | 범위의 첫 행 위치에 행을 삽입한다. | `count` (선택) 숫자 — 삽입할 행 수. 미지정 시 range 의 행 높이만큼 삽입. | — |
1357
- | `deleteRow` | 범위에 해당하는 행을 삭제한다. | — | — |
1358
- | `insertColumn` | 범위의 첫 열 위치에 열을 삽입한다. | `count` (선택) 숫자 — 삽입할 열 수. 미지정 시 range 의 열 폭만큼 삽입. | — |
1359
- | `deleteColumn` | 범위에 해당하는 열을 삭제한다. | — | — |
1360
- | `setRowVisible` | 범위가 걸친 행의 표시 여부를 설정한다. | `visible` 참/거짓 — true=표시, false=숨김 | — |
1361
- | `setColumnVisible` | 범위가 걸친 열의 표시 여부를 설정한다. | `visible` 참/거짓 — true=표시, false=숨김 | — |
1362
- | `getRowVisible` | 범위의 첫 행 표시 여부를 반환한다. | — | true=표시, false=숨김<br>참/거짓 |
1363
- | `getColumnVisible` | 범위의 첫 열 표시 여부를 반환한다. | — | true=표시, false=숨김<br>참/거짓 |
1364
- | `setValue` | 범위 내 모든 셀에 동일한 값을 설정한다.<br>수식(=로 시작)은 자동으로 감지/파싱된다.<br><br>배열수식("{=...}")도 자동 감지되어 범위 전체가 하나의 배열수식 영역으로<br>입력된다(Excel ctrl+shift+enter 와 동일 의미론). 이때 Command 검증 실패 시<br>OperationErrorCode 를 message 로 하는 Error 가 throw 된다:<br>테이블 교차(ARRAY_FORMULA_TABLE), 병합 셀 포함(ARRAY_FORMULA_MERGED_CELL),<br>기존 배열수식 영역과 부분 교차(ARRAY_FORMULA_EDIT), 피벗 영역(PIVOT_TABLE_EDIT).<br>단일 셀이 기존 배열수식 영역 내부이면 영역 전체 재입력으로 확장된다. | `value` 값 — 설정할 값 | — |
1365
- | `setValues` | 2차원 배열로 범위에 각 셀마다 다른 값을 설정한다.<br>values의 행/열 크기가 범위와 일치해야 한다.<br><br>2D 배열을 이 범위의 원점(row1,col1) 기준 절대좌표 insertions 리스트로 펼쳐<br>SET_VALUES Command 를 1회 호출한다. 전체가 단일 OT/undo 단위로 묶인다.<br><br>배열수식("{=...}")은 허용하지 않는다 — 배열수식은 영역 전체에 단일 수식을<br>입력하는 의미론(ARRAY_FORMULA_INSERTION)이라 셀별 개별값 입력과 양립할 수<br>없다. 섞여 있으면 Error 를 throw 한다(리터럴 텍스트로 조용히 들어가는 것 방지).<br>배열수식 입력은 setValue 를 사용한다. | `values` `any[][]` — 2차원 배열 | — |
1366
- | `deleteValue` | 범위 내 모든 셀의 값을 삭제한다. (서식은 유지) | — | — |
1367
- | `setFontBold` | 범위 전체에 굵게를 적용하거나 해제한다. | `isOn` 참/거짓 | — |
1368
- | `setFontItalic` | 범위 전체에 기울임을 적용하거나 해제한다. | `isOn` 참/거짓 | — |
1369
- | `setFontUnderline` | 범위 전체에 밑줄을 적용하거나 해제한다. | `isOn` 참/거짓 — 밑줄 적용 여부. false 이면 isDouble 인자는 무시된다.<br>`isDouble` (선택) 참/거짓 — 이중 밑줄 여부 (기본값: false) | — |
1370
- | `setFontStrikethrough` | 범위 전체에 취소선을 적용하거나 해제한다. | `isOn` 참/거짓 | — |
1371
- | `isFontBold` | 범위 좌상단 셀이 굵게인지 반환한다. 범위가 여러 셀이어도 좌상단만 읽으므로 범위 안에서 서식이 섞여 있어도 알 수 없다.<br>서식 미지정 셀은 기본 스타일 값을 따른다. | — | 참/거짓 (없을 수 있음) |
1372
- | `isFontItalic` | 범위 좌상단 셀이 기울임인지 반환한다. 서식 미지정 셀은 기본 스타일 값을 따른다. | — | 참/거짓 (없을 수 있음) |
1373
- | `getFontUnderline` | *설명 준비 중* | — | 밑줄 종류 ("single", "double", "none" 등)<br>문자열 (없을 수 있음) |
1374
- | `isFontStrikethrough` | 범위 좌상단 셀에 취소선이 있는지 반환한다. 서식 미지정 셀은 기본 스타일 값을 따른다. | — | 참/거짓 (없을 수 있음) |
1375
- | `setFontName` | 범위 전체의 글꼴을 바꾼다. | `name` 문자열 — 글꼴 이름 | — |
1376
- | `setFontSize` | 범위 전체의 글꼴 크기를 바꾼다. | `size` `number \| string` — 글꼴 크기(pt) | — |
1377
- | `setFontColor` | 범위 전체의 글꼴 색을 바꾼다. | `color` 문자열 — #RRGGBB 형식 | — |
1378
- | `getFontName` | 범위 좌상단 셀의 글꼴 이름을 반환한다. 서식 미지정 셀은 기본 스타일 값을 따른다. | — | 문자열 (없을 수 있음) |
1379
- | `getFontSize` | 범위 좌상단 셀의 글꼴 크기(pt)를 반환한다. 서식 미지정 셀은 기본 스타일 값을 따른다. | — | 숫자 (없을 수 있음) |
1380
- | `getFontColor` | 범위 좌상단 셀의 글꼴 색을 "#RRGGBB" 형식으로 반환한다. 서식 미지정 셀은 기본 스타일 값을 따른다. | — | 문자열 (없을 수 있음) |
1381
- | `getFont` | *설명 준비 중* | — | { bold, italic, underline, strikethrough, name, size, color }<br>`Record<string, unknown> \| undefined` |
1382
- | `setBackgroundColor` | 범위 전체의 배경색을 바꾼다. | `color` (선택) 문자열 — #RRGGBB 형식. null/undefined/빈 문자열이면 배경 제거. | — |
1383
- | `setHorizontalAlign` | 범위 전체의 가로 정렬을 설정한다. 목록 밖의 값도 검증 없이 저장된다 — 모델이 아는 값<br>(`centerContinuous`·`center-across`)은 가운데로, 모르는 값은 데이터 종류와 무관하게 왼쪽으로 그려진다. | `value` [`HorizontalAlign`](#cell-horizontalalign) | — |
1384
- | `setVerticalAlign` | 범위 전체의 세로 정렬을 설정한다. 목록 밖의 값도 검증 없이 저장된다 — 모델이 아는 값<br>(`distributed`)은 가운데로, 모르는 값은 아래로 그려진다. | `value` [`VerticalAlign`](#cell-verticalalign) | — |
1385
- | `setWrapText` | 범위 전체에 텍스트 줄바꿈을 적용하거나 해제한다. | `isOn` 참/거짓 | — |
1386
- | `getBackgroundColor` | 범위 좌상단 셀의 바탕색을 "#RRGGBB" 형식으로 반환한다. 배경이 없으면 undefined 다.<br>채우기 종류까지 알아야 하면 getFill 을 쓴다. | — | 문자열 (없을 수 있음) |
1387
- | `getHorizontalAlign` | 범위 좌상단 셀의 가로 정렬을 반환한다. 명시 지정된 값만 반환하고, 기본 정렬 상태면 undefined 다.<br>값 어휘는 HorizontalAlign 이지만, 가져온 문서에는 목록 밖 값(fill·centerContinuous 등)이 있을 수 있다. | — | 문자열 (없을 수 있음) |
1388
- | `getVerticalAlign` | 범위 좌상단 셀의 세로 정렬을 반환한다. 명시 지정된 값만 반환하고, 기본 정렬 상태면 undefined 다.<br>값 어휘는 VerticalAlign 이지만, 가져온 문서에는 목록 밖 값이 있을 수 있다. | — | 문자열 (없을 수 있음) |
1389
- | `isWrapText` | 범위 좌상단 셀에 텍스트 줄바꿈이 적용되어 있는지 반환한다. 서식 미지정 셀은 기본 스타일 값을 따른다. | — | 참/거짓 (없을 수 있음) |
1390
- | `getFill` | 범위 좌상단 셀의 채우기 상태를 반환한다. 배경이 없으면 undefined 다. | — | [`FillInfo`](#cell-fillinfo) (없을 수 있음) |
1391
- | `getAlignment` | *설명 준비 중* | — | { horizontalAlign, verticalAlign, wrapText, indent }<br>`Record<string, unknown> \| undefined` |
1392
- | `increaseIndent` | 범위의 들여쓰기 수준을 1 증가시킨다. | — | — |
1393
- | `decreaseIndent` | 범위의 들여쓰기 수준을 1 감소시킨다. | — | — |
1394
- | `getIndent` | 범위 좌상단 셀의 들여쓰기 수준을 반환한다. 들여쓰기가 지정되어 있지 않으면 0 이다(다른 서식 조회와 달리 undefined 가 아니다). | — | 숫자 |
1395
- | `setBorder` | 테두리 서식을 설정한다.<br>type 이 "none" 이면 테두리를 제거하며, style/color 는 무시된다. | `type` [`BorderType`](#cell-bordertype) — 테두리를 적용할 위치<br>`lineStyle` (선택) [`BorderLineStyle`](#cell-borderlinestyle) — 선 스타일 (기본값: "thin")<br>`color` (선택) 문자열 — #RRGGBB 형식 색상 (기본값: "#000000") | — |
1396
- | `getBorder` | 범위 좌상단 셀의 테두리 상태를 변별로 반환한다. 테두리가 없는 변은 null 이다.<br><br>setBorder 는 범위 단위 명령(all·rectangle·cross 등)을 받지만 모델에는 셀별 네 변으로 분해되어<br>저장되므로, 조회는 그 명령을 되돌려 주지 못하고 변별 상태만 준다. | — | [`BorderInfo`](#cell-borderinfo) (없을 수 있음) |
1397
- | `clearFormat` | 범위의 셀 서식(글꼴/채우기/정렬/테두리/표시형식/병합 등)을 제거한다. 값은 유지된다.<br>행/열 전체 범위가 병합 셀과 교차하면 OVERLAPPING_MERGE 를 throw 한다.<br>대용량 범위는 confirm 없이 즉시 실행되며, 기준 초과 시 undo buffer 가 비워진다(UI 경로와 동일 규칙). | — | — |
1398
- | `clearAll` | 범위의 모든 내용을 지운다 — 값/수식/하이퍼링크/서식/병합/메모/데이터 유효성/스파크라인/필터/표.<br>전체가 단일 undo 단위로 처리된다.<br>피벗 교차(PIVOT_TABLE_EDIT), 배열수식 일부 포함(ARRAY_FORMULA_EDIT),<br>행/열 전체 범위 + 병합 교차(OVERLAPPING_MERGE) 시 throw 한다. | — | — |
1399
- | `merge` | 범위 내 셀을 하나로 병합한다.<br>단일 셀이면 무시. 범위 내 여러 값이 있으면 좌상단 셀 값을 유지한다. | — | — |
1400
- | `unmerge` | 범위 내 병합된 셀을 모두 해제한다. | — | — |
1401
- | `getMergeCellList` | 이 범위와 교차(intersect)하는 병합 셀 목록을 A1 범위 문자열 배열로 반환한다. (순수 조회)<br>부분 교차라도 병합 영역 전체 주소를 반환하며(범위로 잘라내지 않음 — Office.js getMergedAreas 관례),<br>범위에 온전히 포함되거나 범위를 포함하는 병합도 모두 포함한다. 교차하는 병합이 없으면 빈 배열.<br>시트 전체 병합 목록은 Worksheet.getMergeCellList() 를 사용한다. | — | 문자열 목록 |
1402
- | `setNumberFormat` | format code 문자열을 직접 지정해 표시 형식을 설정한다. (예: "#,##0.00", "yyyy-mm-dd", "0.00%")<br>다이얼로그 custom 경로와 동일하게 사용자정의(164) grain 으로 모델에 반영된다. | `formatCode` 문자열 — 엑셀 호환 형식 코드 | — |
1403
- | `getNumberFormat` | 좌상단 셀의 표시 형식 정보를 반환한다. | — | { formatCode }<br>`Record<string, unknown> \| undefined` |
1404
- | `addConditionalFormat` | 이 범위에 조건부 서식 규칙을 추가한다.<br>rule 은 정규화 규칙 객체(§4 스키마) — rule_type 은 ConditionalFormatRuleType, cellIs 의 operator 는<br>ConditionalFormatOperator, timePeriod 의 time_period 는 ConditionalFormatTimePeriod,<br>시각 규칙의 cfvo[].type 은 ConditionalFormatValueType 어휘다.<br>수식 계열 규칙의 강조 서식은 style(직접 지정, §4.13)로 지정한다(생략 시 기본 강조).<br>colorScale 은 colors(ARGB 2~3개)로, dataBar/iconSet 은 프리셋(data_bar/icon_set)으로 지정한다.<br>예: { rule_type:"cellIs", operator:"lessThan", formula1:"0",<br> style:{ font:{bold:true, color:"#9C0006"}, fill:{color:"#FFC7CE"}, border:{style:"thin", color:"#9C0006"} } } | `rule` 객체 — 정규화 규칙 객체 | — |
1405
- | `clearConditionalFormats` | 이 범위에 걸친 조건부 서식 규칙을 제거한다(겹치는 규칙의 영역 축소 또는 삭제). | — | — |
1406
- | `setDataValidation` | 이 범위에 데이터 유효성 검사 규칙을 적용/교체한다(셀당 1규칙, 겹치면 교차분 정리 후 교체).<br>rule 은 공개 규칙 값객체 — type(DataValidationType) + 타입별 formula 와 operator(DataValidationOperator)<br>+ 메시지·옵션(errorStyle 는 DataValidationErrorStyle). | `rule` 객체 | — |
1407
- | `clearDataValidation` | 이 범위와 겹치는 데이터 유효성 규칙을 제거한다(교차 영역만; 규칙의 나머지 영역은 유지, 겹침 없으면 no-op). | — | — |
1408
- | `sort` | 범위를 지정 열 기준으로 정렬한다.<br>대상이 필터/테이블 영역의 단일 셀이면 필터 정렬(sortState 저장)로 자동 위임되고,<br>그 외에는 1회성 무상태 범위 정렬로 동작한다. 헤더는 자동 감지된다(옵션 아님).<br>배열수식 포함(ARRAY_FORMULA_EDIT), 피벗 영역(PIVOT_TABLE_EDIT),<br>빈/무효 범위(SORT_RANGE_INVALID), 불일치 병합 셀 포함(SORT_MERGE_MISMATCH),<br>20만 행 초과(SORT_RANGE_TOO_LARGE) 시 throw 한다. | `key` 숫자 — 정렬 기준 열 — 이 범위의 첫 열부터의 0-based 오프셋 (0=첫 열, Excel JS SortField.key 와 동일 의미). 정수가 아니거나 범위 너비를 벗어나면 INVALID_SORT_FIELD.<br>`order` [`SortOrder`](#cell-sortorder) — 정렬 방향<br>`options` (선택) 객체 — 1차 미지원 예약(matchCase/hasHeaders/orientation 등). 값이 오면 INVALID_SORT_OPTION. | — |
1409
- | `setComment` | 이 셀(범위 좌상단)에 메모를 설정한다 — 없으면 생성, 있으면 본문만 교체(표시/위치 상태 보존). | `text` 문자열 — 메모 본문(plain text). 여러 줄은 "\n" | — |
1410
- | `deleteComment` | 이 범위 내 모든 셀 메모를 삭제한다(겹치는 메모가 없으면 no-op). | — | — |
1411
- | `setCommentVisible` | 이 셀(범위 좌상단) 메모의 표시/숨김을 설정한다. 메모가 없으면 COMMENT_NOT_FOUND. | `visible` 참/거짓 — true=항상 표시 / false=hover 시 표시 | — |
1412
- | `getHyperlinkList` | 이 범위와 교차(부분적으로만 겹쳐도 포함)하는 하이퍼링크 목록을 반환한다. | — | [`HyperlinkInfo`](#cell-hyperlinkinfo) 목록 |
1413
- | `setHyperlink` | 이 범위에 하이퍼링크를 설정한다.<br>범위가 다중 셀이면 링크·서식(파란색+밑줄)은 범위 전체에 적용되지만,<br>표시 텍스트는 좌상단에만 적용된다. (display 판정-셀 값 유무/타입도 좌상단 셀 기준) | `options` `{ location: string; display?: string; type?: HyperlinkType }`<br> · `location` 링크 대상 (URL/이메일/문서 내 참조, 예: "Sheet1!A1", 정의된 이름)<br> · `display` 셀 표시 텍스트. - 셀 값이 있고 숫자이거나 줄바꿈 포함 문자열이면 무시되고 셀 값이 유지된다. - 셀 값이 있는 일반 문자열이면 display가 우선 적용된다. - 셀 값이 없으면 display가 적용되고, 생략 시 location이 적용된다.<br> · `type` 목록 밖의 값이면 INVALID_HYPERLINK_TYPE. 생략 시 location에서 자동 판별 | — |
1414
- | `removeHyperlink` | 이 범위와 상호 포함 관계(범위가 링크를 포함하거나 링크가 범위를 포함)인 하이퍼링크만 삭제한다(셀 값은 유지).<br>부분적으로만 겹치는 링크는 삭제되지 않는다.<br>서식(파란색+밑줄)도 함께 제거되며,<br>삭제된 링크와 교차하는 다른 하이퍼링크는 서식이 복원된다. | — | — |
1415
-
1416
- <a id="cell-table"></a>
1417
- ### Table — 표 (`Table`)
1418
-
1419
- | 기능 | 설명 | 입력 | 결과 |
1420
- |---|---|---|---|
1421
- | `getName` | 테이블 이름(핸들 키)을 반환한다. | — | 문자열 |
1422
- | `getRange` | 테이블 전체 영역의 Range 핸들을 반환한다. | — | [`Range`](#cell-range) |
1423
- | `getOptions` | 테이블 옵션을 일괄 반환한다. | — | [`TableOptions`](#cell-tableoptions) |
1424
- | `delete` | 테이블을 삭제한다. 표 정의·오토필터 제거 + 테이블 영역 셀 내용을 클리어한다.<br>두 변경은 한 번의 undo 로 함께 복원된다. | — | — |
1425
- | `resize` | 테이블 영역을 새 범위로 변경한다. 머리글 행 위치는 유지된다. | `range` `string \| { row1: number; col1: number; row2?: number; col2?: number }` — 새 영역(A1 표기 문자열 또는 0-based 좌표 객체) | — |
1426
- | `setOptions` | 테이블 옵션을 변경한다. 지정한 키만 적용되고 나머지는 현재 값을 유지한다.<br>(스타일 `style` 변경은 현재 미지원 — `getOptions`로 조회만 가능.) | `options` `{ headerRow?: boolean; totalsRow?: boolean; firstColumn?: boolean; lastColumn?: boolean; bandedRows?: boolean; bandedColumns?: boolean }` | — |
1427
- | `setName` | 테이블 이름을 변경한다. | `name` 문자열 | — |
1428
- | `getFilter` | 이 테이블의 자동 필터 핸들을 반환한다.<br>테이블 필터링은 내재적이므로, 테이블이 존재하면 필터 유무와 무관하게 항상 핸들을 반환한다(null 아님).<br>필터가 아직 없으면 조건 적용(applyFilter) 시 자동 생성되고, getInfo 는 빈 상태를 반환한다.<br>명시적 생성/삭제는 핸들의 create()/remove() 로도 가능하다. | — | [`Filter`](#cell-filter) |
1429
- | `getInfo` | 목록/조회가 공유하는 요약 스키마. | — | [`TableInfo`](#cell-tableinfo) |
1430
-
1431
- ### 부록 — 입출력 데이터 형식 (Spreadsheet)
1432
-
1433
- <a id="cell-sheetinfo"></a>
1434
- #### `SheetInfo`
1435
-
1436
- | 항목 | 형식 | 설명 |
1437
- |---|---|---|
1438
- | `name` | 문자열 | — |
1439
- | `hidden` | 참/거짓 | — |
1440
- | `tabColor` | 문자열 | — |
1441
- | `usedRange` | 문자열 (없을 수 있음) | — |
1442
- | `selection` | 문자열 | — |
1443
- | `freezePanes` | `{ rows: number; cols: number }` | — |
1444
- | `gridlinesVisible` | 참/거짓 | — |
1445
- | `zoom` | 숫자 | — |
1446
-
1447
- <a id="cell-datavalidationrule"></a>
1448
- #### `DataValidationRule`
1449
-
1450
- | 항목 | 형식 | 설명 |
1451
- |---|---|---|
1452
- | `ranges` | 문자열 | 적용 범위(A1 문자열). 다중(비연속) 영역은 콤마로 이어붙인 단일 문자열 |
1453
- | `type` | 문자열 | any/list/whole/decimal/date/time/textLength/custom |
1454
- | `formula1` (선택) | `string \| number` | 주 값/참조/수식(any 타입은 없음) |
1455
- | `operator` (선택) | 문자열 | 비교 연산자(숫자·날짜·시간·길이 타입만) |
1456
- | `formula2` (선택) | `string \| number` | between/notBetween 의 두 번째 경계 |
1457
- | `allowBlank` | 참/거짓 | 빈 셀 허용 |
1458
- | `showDropDown` (선택) | 참/거짓 | list 드롭다운 표시(list 만) |
1459
- | `showInputMessage` | 참/거짓 | 셀 선택 시 안내 메시지 표시 |
1460
- | `inputTitle` (선택) | 문자열 | 안내 메시지 제목 |
1461
- | `inputMessage` (선택) | 문자열 | 안내 메시지 본문 |
1462
- | `showErrorMessage` | 참/거짓 | 위반 시 오류 메시지 표시 |
1463
- | `errorStyle` | 문자열 | 오류 스타일 stop/warning/information |
1464
- | `errorTitle` (선택) | 문자열 | 오류 메시지 제목 |
1465
- | `errorMessage` (선택) | 문자열 | 오류 메시지 본문 |
1466
-
1467
- <a id="cell-hyperlinkinfo"></a>
1468
- #### `HyperlinkInfo`
1469
-
1470
- | 항목 | 형식 | 설명 |
1471
- |---|---|---|
1472
- | `range` | 문자열 | — |
1473
- | `type` | `"web" \| "email" \| "book" \| "document" \| "file" \| ""` | — |
1474
- | `location` | 문자열 | — |
1475
- | `display` | 문자열 | — |
1476
-
1477
- <a id="cell-borderline"></a>
1478
- #### `BorderLine`
1479
-
1480
- | 항목 | 형식 | 설명 |
1481
- |---|---|---|
1482
- | `style` | 문자열 | 선 스타일 — BorderLineStyle 어휘 |
1483
- | `color` (선택) | 문자열 | 선 색 "#RRGGBB". 색을 지정하지 않은 테두리는 비어 있다 |
1484
-
1485
- <a id="cell-borderdiagonal"></a>
1486
- #### `BorderDiagonal`
1487
-
1488
- | 항목 | 형식 | 설명 |
1489
- |---|---|---|
1490
- | `style` | 문자열 | 선 스타일 — BorderLineStyle 어휘 |
1491
- | `color` (선택) | 문자열 | 선 색 "#RRGGBB" |
1492
- | `direction` | `"diagonal_up" \| "diagonal_down" \| "diagonal_cross"` | 대각선 방향. setBorder 의 type 으로 그대로 넘길 수 있다 |
1493
-
1494
- <a id="cell-borderinfo"></a>
1495
- #### `BorderInfo`
1496
-
1497
- | 항목 | 형식 | 설명 |
1498
- |---|---|---|
1499
- | `top` | [`BorderLine`](#cell-borderline) (없을 수 있음) | 테두리가 없으면 null |
1500
- | `bottom` | [`BorderLine`](#cell-borderline) (없을 수 있음) | — |
1501
- | `left` | [`BorderLine`](#cell-borderline) (없을 수 있음) | — |
1502
- | `right` | [`BorderLine`](#cell-borderline) (없을 수 있음) | — |
1503
- | `diagonal` | [`BorderDiagonal`](#cell-borderdiagonal) (없을 수 있음) | — |
1504
-
1505
- <a id="cell-fillpattern"></a>
1506
- #### `FillPattern`
1507
-
1508
- | 항목 | 형식 | 설명 |
1509
- |---|---|---|
1510
- | `type` | 문자열 | 무늬 종류 — "lightGrid", "darkVertical" 등 |
1511
- | `color` (선택) | 문자열 | 무늬선 색 "#RRGGBB" |
1512
-
1513
- <a id="cell-fillinfo"></a>
1514
- #### `FillInfo`
1515
-
1516
- | 항목 | 형식 | 설명 |
1517
- |---|---|---|
1518
- | `type` | `"solid" \| "pattern" \| "gradient"` | — |
1519
- | `backgroundColor` (선택) | 문자열 | 바탕색 "#RRGGBB". 그라디언트와 바탕색이 지정되지 않은 채우기에서는 비어 있다 |
1520
- | `pattern` (선택) | [`FillPattern`](#cell-fillpattern) | 바탕색 위에 겹쳐 그리는 무늬. 무늬 채우기에만 오며 조회 전용이다 |
1521
-
1522
- <a id="cell-tableoptions"></a>
1523
- #### `TableOptions`
1524
-
1525
- | 항목 | 형식 | 설명 |
1526
- |---|---|---|
1527
- | `headerRow` | 참/거짓 | — |
1528
- | `totalsRow` | 참/거짓 | — |
1529
- | `firstColumn` | 참/거짓 | — |
1530
- | `lastColumn` | 참/거짓 | — |
1531
- | `bandedRows` | 참/거짓 | — |
1532
- | `bandedColumns` | 참/거짓 | — |
1533
- | `style` | 문자열 | — |
1534
-
1535
- <a id="cell-tableinfo"></a>
1536
- #### `TableInfo`
1537
-
1538
- | 항목 | 형식 | 설명 |
1539
- |---|---|---|
1540
- | `name` | 문자열 | — |
1541
- | `sheet` | 문자열 | — |
1542
- | `range` | 문자열 | — |
1543
- | `headerRow` | 참/거짓 | — |
1544
- | `totalsRow` | 참/거짓 | — |
1545
- | `firstColumn` | 참/거짓 | — |
1546
- | `lastColumn` | 참/거짓 | — |
1547
- | `bandedRows` | 참/거짓 | — |
1548
- | `bandedColumns` | 참/거짓 | — |
1549
- | `style` | 문자열 | — |
1550
-
1551
- <a id="cell-filterinfo"></a>
1552
- #### `FilterInfo`
1553
-
1554
- | 항목 | 형식 | 설명 |
1555
- |---|---|---|
1556
- | `enabled` | 참/거짓 | 필터 존재 여부. false 면 이 필드만 존재한다. |
1557
- | `range` (선택) | 문자열 | A1 문자열 (예: "A1:D20"). 필터가 있을 때만 포함. |
1558
- | `columns` (선택) | `{ colId: number; filterType: string; criteria: Record<string, unknown> }[]` | 필터가 있을 때만 포함. colId 는 필터 범위 첫 열부터의 0-based 오프셋 — applyFilter/clearFilter/sort 입력과 동일 좌표계. |
1559
- | `hiddenRowCount` (선택) | 숫자 | filterHidden 기준 숨김 행 수 (rowHidden 과 별개). 필터가 있을 때만 포함. |
1560
- | `sort` (선택) | `{ colId: number; order: string } \| null` | 정렬 상태(sortState). 필터가 있을 때만 포함하며 정렬된 적 없으면 null. colId 는 필터 범위 첫 열부터의 0-based 오프셋(sort() 입력 colId 와 왕복 대칭), order 는 "asc"\|"desc". 단일 키(1차 스코프) — 다중 정렬 키 문서는 첫 조건만 노출한다. |
1561
-
1562
- ### 부록 — 상수 목록 (Spreadsheet)
1563
-
1564
- <a id="cell-proxytype"></a>
1565
- #### `ProxyType`
1566
-
1567
- SDK proxy 엔티티 타입 — 직렬화 descriptor(`{__proxy, type, attrs}`)와
1568
- proxyInvoke payload 의 `proxyType` 값으로 사용한다.
1569
-
1570
- 문자열은 d.ts 공개명(cell-api.dts.config.json classNameMap)과 동일하며,
1571
- tfo-sdk `src/proxyConstants.ts` 의 `PROXY_TYPE` 와 수동 동기화 쌍이다.
1572
- Chart/Table 은 show ProxyType 과 동일 문자열이지만 dispatcher 가 모듈(iframe)별로
1573
- 독립이라 충돌하지 않는다.
1574
-
1575
- | 상수 | 값 | 설명 |
1576
- |---|---|---|
1577
- | `WORKBOOK` | `Workbook` | — |
1578
- | `WORKSHEET` | `Worksheet` | — |
1579
- | `RANGE` | `Range` | — |
1580
- | `CHART` | `Chart` | — |
1581
- | `TABLE` | `Table` | — |
1582
- | `FILTER` | `Filter` | — |
1583
- | `NAME` | `Name` | — |
1584
-
1585
- <a id="cell-horizontalalign"></a>
1586
- #### `HorizontalAlign`
1587
-
1588
- 셀 가로 정렬 — `ApiRange.setHorizontalAlign` 인자.
1589
-
1590
- 지정하지 않은 셀은 데이터 종류에 따라 그려진다(문자는 왼쪽, 숫자는 오른쪽). 조회는 명시 지정된
1591
- 값만 돌려주므로 기본 상태에서는 값이 없다.
1592
-
1593
- | 상수 | 값 | 설명 |
1594
- |---|---|---|
1595
- | `LEFT` | `left` | — |
1596
- | `CENTER` | `center` | — |
1597
- | `RIGHT` | `right` | — |
1598
- | `JUSTIFY` | `justify` | — |
1599
- | `DISTRIBUTED` | `distributed` | — |
1600
-
1601
- <a id="cell-verticalalign"></a>
1602
- #### `VerticalAlign`
1603
-
1604
- 셀 세로 정렬 — `ApiRange.setVerticalAlign` 인자.
1605
-
1606
- 지정하지 않은 셀은 아래쪽으로 그려진다. 조회는 명시 지정된 값만 돌려준다.
1607
-
1608
- | 상수 | 값 | 설명 |
1609
- |---|---|---|
1610
- | `TOP` | `top` | — |
1611
- | `CENTER` | `center` | — |
1612
- | `BOTTOM` | `bottom` | — |
1613
- | `JUSTIFY` | `justify` | — |
1614
-
1615
- <a id="cell-bordertype"></a>
1616
- #### `BorderType`
1617
-
1618
- 테두리를 적용할 위치 — `ApiRange.setBorder` 의 첫 인자.
1619
-
1620
- `NONE` 은 테두리 제거이며 이때 선 스타일·색은 무시된다. `CENTER`/`MIDDLE` 은 범위 내부의
1621
- 세로선/가로선, `CROSS` 는 그 둘, `RECTANGLE` 은 바깥 네 변, `ALL` 은 바깥과 내부 전체다.
1622
-
1623
- 값은 모델 어휘(`Constants.ot.BORDER_TYPE_*`)와 같은 문자열이다.
1624
-
1625
- | 상수 | 값 | 설명 |
1626
- |---|---|---|
1627
- | `ALL` | `all` | — |
1628
- | `RECTANGLE` | `rectangle` | — |
1629
- | `CROSS` | `cross` | — |
1630
- | `TOP` | `top` | — |
1631
- | `BOTTOM` | `bottom` | — |
1632
- | `LEFT` | `left` | — |
1633
- | `RIGHT` | `right` | — |
1634
- | `CENTER` | `center` | — |
1635
- | `MIDDLE` | `middle` | — |
1636
- | `DIAGONAL` | `diagonal` | — |
1637
- | `DIAGONAL_UP` | `diagonal_up` | — |
1638
- | `DIAGONAL_DOWN` | `diagonal_down` | — |
1639
- | `DIAGONAL_CROSS` | `diagonal_cross` | — |
1640
- | `NONE` | `none` | — |
1641
-
1642
- <a id="cell-borderlinestyle"></a>
1643
- #### `BorderLineStyle`
1644
-
1645
- 테두리 선 스타일 — `ApiRange.setBorder` 의 두 번째 인자(기본 `THIN`).
1646
-
1647
- 값은 렌더러가 아는 선 스타일 전부(`view/util/borderStyleUtils.js` 의 우선순위 목록 · 조건부 서식이
1648
- 쓰는 `controller/dxfStyle.js` 의 `CF_PROFILE.border.styles`)와 같아야 한다. 목록 밖의 문자열은
1649
- 검증 없이 저장되고 화면에는 테두리가 지정한 모양으로 그려지지 않는다.
1650
- 생성기가 객체 리터럴만 읽으므로 그 목록에서 파생할 수 없다 — 대신 dispatch 테스트가 어긋남을 잡는다.
1651
-
1652
- | 상수 | 값 | 설명 |
1653
- |---|---|---|
1654
- | `HAIR` | `hair` | — |
1655
- | `THIN` | `thin` | — |
1656
- | `MEDIUM` | `medium` | — |
1657
- | `THICK` | `thick` | — |
1658
- | `DOUBLE` | `double` | — |
1659
- | `DOTTED` | `dotted` | — |
1660
- | `DASHED` | `dashed` | — |
1661
- | `DASH_DOT` | `dashDot` | — |
1662
- | `DASH_DOT_DOT` | `dashDotDot` | — |
1663
- | `MEDIUM_DASHED` | `mediumDashed` | — |
1664
- | `MEDIUM_DASH_DOT` | `mediumDashDot` | — |
1665
- | `MEDIUM_DASH_DOT_DOT` | `mediumDashDotDot` | — |
1666
- | `SLANT_DASH_DOT` | `slantDashDot` | — |
1667
- | `NONE` | `none` | — |
1668
-
1669
- <a id="cell-sortorder"></a>
1670
- #### `SortOrder`
1671
-
1672
- 정렬 방향 — `ApiRange.sort` · `ApiFilter.sort` 인자.
1673
-
1674
- | 상수 | 값 | 설명 |
1675
- |---|---|---|
1676
- | `ASCENDING` | `asc` | — |
1677
- | `DESCENDING` | `desc` | — |
1678
-
1679
- <a id="cell-hyperlinktype"></a>
1680
- #### `HyperlinkType`
1681
-
1682
- 하이퍼링크 종류 — `ApiRange.setHyperlink` 의 `options.type`.
1683
-
1684
- `BOOK` 은 같은 문서 안의 위치로 이동하는 링크이며 `location` 에 시트·범위를 준다.
1685
- 목록 밖의 값이면 INVALID_HYPERLINK_TYPE 로 실패한다.
1686
-
1687
- | 상수 | 값 | 설명 |
1688
- |---|---|---|
1689
- | `WEB` | `web` | — |
1690
- | `EMAIL` | `email` | — |
1691
- | `BOOK` | `book` | — |
1692
-
1693
- <a id="cell-datavalidationtype"></a>
1694
- #### `DataValidationType`
1695
-
1696
- 데이터 유효성 규칙 종류 — `ApiRange.setDataValidation` rule 의 `type`.
1697
-
1698
- `ANY` 는 입력을 제한하지 않고 안내 메시지만 붙이는 종류이므로 수식이 필요 없다.
1699
- `LIST` 는 `formula1` 에 콤마 목록(`=` 없이) 또는 단일 열·행 범위 참조(`=` 필수)를 받고,
1700
- `CUSTOM` 은 불리언 수식을 받는다. 나머지는 `operator` 와 짝으로 경계값을 받는다.
1701
-
1702
- | 상수 | 값 | 설명 |
1703
- |---|---|---|
1704
- | `ANY` | `any` | — |
1705
- | `LIST` | `list` | — |
1706
- | `WHOLE` | `whole` | — |
1707
- | `DECIMAL` | `decimal` | — |
1708
- | `DATE` | `date` | — |
1709
- | `TIME` | `time` | — |
1710
- | `TEXT_LENGTH` | `textLength` | — |
1711
- | `CUSTOM` | `custom` | — |
1712
-
1713
- <a id="cell-datavalidationoperator"></a>
1714
- #### `DataValidationOperator`
1715
-
1716
- 데이터 유효성 비교 연산자 — `ApiRange.setDataValidation` rule 의 `operator`.
1717
-
1718
- 숫자·날짜·시간·길이 종류에서만 쓴다. `BETWEEN`/`NOT_BETWEEN` 은 `formula2` 로 두 번째
1719
- 경계를 함께 받는다.
1720
-
1721
- | 상수 | 값 | 설명 |
1722
- |---|---|---|
1723
- | `BETWEEN` | `between` | — |
1724
- | `NOT_BETWEEN` | `notBetween` | — |
1725
- | `EQUAL` | `equal` | — |
1726
- | `NOT_EQUAL` | `notEqual` | — |
1727
- | `LESS_THAN` | `lessThan` | — |
1728
- | `LESS_THAN_OR_EQUAL` | `lessThanOrEqual` | — |
1729
- | `GREATER_THAN` | `greaterThan` | — |
1730
- | `GREATER_THAN_OR_EQUAL` | `greaterThanOrEqual` | — |
1731
-
1732
- <a id="cell-datavalidationerrorstyle"></a>
1733
- #### `DataValidationErrorStyle`
1734
-
1735
- 데이터 유효성 위반 시 오류 표시 방식 — `ApiRange.setDataValidation` rule 의 `errorStyle`(기본 `STOP`).
1736
-
1737
- `STOP` 은 입력을 거부하고, `WARNING`/`INFORMATION` 은 경고 후 입력을 허용한다.
1738
-
1739
- | 상수 | 값 | 설명 |
1740
- |---|---|---|
1741
- | `STOP` | `stop` | — |
1742
- | `WARNING` | `warning` | — |
1743
- | `INFORMATION` | `information` | — |
1744
-
1745
- <a id="cell-conditionalformatruletype"></a>
1746
- #### `ConditionalFormatRuleType`
1747
-
1748
- 조건부 서식 규칙 종류 — `ApiRange.addConditionalFormat` rule 의 `rule_type`.
1749
-
1750
- `CELL_IS` 는 `operator` + 경계값, `EXPRESSION` 은 불리언 수식, 텍스트 계열은 비교 문자열,
1751
- `TOP10` 은 순위(`rank`), `TIME_PERIOD` 는 기간 토큰을 함께 받는다. 여기까지는 수식 계열로
1752
- 강조 서식을 `style` 로 직접 지정한다.
1753
-
1754
- `COLOR_SCALE`/`DATA_BAR`/`ICON_SET` 은 시각 규칙이라 `style` 을 받지 않고 색 목록 또는
1755
- 프리셋 식별자와 임계값(`cfvo`)으로 서술한다.
1756
-
1757
- 값은 모델 정본 토큰과 같은 문자열이다.
1758
-
1759
- | 상수 | 값 | 설명 |
1760
- |---|---|---|
1761
- | `CELL_IS` | `cellIs` | — |
1762
- | `EXPRESSION` | `expression` | — |
1763
- | `CONTAINS_TEXT` | `containsText` | — |
1764
- | `NOT_CONTAINS_TEXT` | `notContainsText` | — |
1765
- | `BEGINS_WITH` | `beginsWith` | — |
1766
- | `ENDS_WITH` | `endsWith` | — |
1767
- | `CONTAINS_BLANKS` | `containsBlanks` | — |
1768
- | `NOT_CONTAINS_BLANKS` | `notContainsBlanks` | — |
1769
- | `CONTAINS_ERRORS` | `containsErrors` | — |
1770
- | `NOT_CONTAINS_ERRORS` | `notContainsErrors` | — |
1771
- | `TOP10` | `top10` | — |
1772
- | `ABOVE_AVERAGE` | `aboveAverage` | — |
1773
- | `BELOW_AVERAGE` | `belowAverage` | — |
1774
- | `DUPLICATE_VALUES` | `duplicateValues` | — |
1775
- | `UNIQUE_VALUES` | `uniqueValues` | — |
1776
- | `TIME_PERIOD` | `timePeriod` | — |
1777
- | `COLOR_SCALE` | `colorScale` | — |
1778
- | `DATA_BAR` | `dataBar` | — |
1779
- | `ICON_SET` | `iconSet` | — |
1780
-
1781
- <a id="cell-conditionalformatoperator"></a>
1782
- #### `ConditionalFormatOperator`
1783
-
1784
- 조건부 서식 비교 연산자 — `cellIs` 규칙의 `operator`.
1785
-
1786
- `BETWEEN`/`NOT_BETWEEN` 은 `formula2` 로 두 번째 경계를 함께 받는다.
1787
-
1788
- | 상수 | 값 | 설명 |
1789
- |---|---|---|
1790
- | `EQUAL` | `equal` | — |
1791
- | `NOT_EQUAL` | `notEqual` | — |
1792
- | `BETWEEN` | `between` | — |
1793
- | `NOT_BETWEEN` | `notBetween` | — |
1794
- | `GREATER_THAN` | `greaterThan` | — |
1795
- | `GREATER_THAN_OR_EQUAL` | `greaterThanOrEqual` | — |
1796
- | `LESS_THAN` | `lessThan` | — |
1797
- | `LESS_THAN_OR_EQUAL` | `lessThanOrEqual` | — |
1798
-
1799
- <a id="cell-conditionalformattimeperiod"></a>
1800
- #### `ConditionalFormatTimePeriod`
1801
-
1802
- 조건부 서식 기간 토큰 — `timePeriod` 규칙의 `time_period`.
1803
-
1804
- 기준일은 문서를 여는 시점의 오늘 날짜이므로 규칙이 가리키는 셀 집합은 날짜가 바뀌면 달라진다.
1805
-
1806
- | 상수 | 값 | 설명 |
1807
- |---|---|---|
1808
- | `YESTERDAY` | `yesterday` | — |
1809
- | `TODAY` | `today` | — |
1810
- | `TOMORROW` | `tomorrow` | — |
1811
- | `LAST_7_DAYS` | `last7Days` | — |
1812
- | `LAST_WEEK` | `lastWeek` | — |
1813
- | `THIS_WEEK` | `thisWeek` | — |
1814
- | `NEXT_WEEK` | `nextWeek` | — |
1815
- | `LAST_MONTH` | `lastMonth` | — |
1816
- | `THIS_MONTH` | `thisMonth` | — |
1817
- | `NEXT_MONTH` | `nextMonth` | — |
1818
-
1819
- <a id="cell-conditionalformatvaluetype"></a>
1820
- #### `ConditionalFormatValueType`
1821
-
1822
- 조건부 서식 시각 규칙 임계값의 기준 — `cfvo[].type`.
1823
-
1824
- `NUM`/`PERCENT`/`PERCENTILE`/`FORMULA` 는 `formula` 로 값을 함께 받고, `MIN`/`MAX` 는
1825
- 범위의 최소·최대를 쓴다. `AUTO_MIN`/`AUTO_MAX` 는 데이터 막대 전용 기본 임계값이라 직접 지정하기보다
1826
- 조회 결과를 그대로 다시 넣을 때 쓰라고 열어 둔 값이다.
1827
-
1828
- | 상수 | 값 | 설명 |
1829
- |---|---|---|
1830
- | `NUM` | `num` | — |
1831
- | `MIN` | `min` | — |
1832
- | `MAX` | `max` | — |
1833
- | `PERCENT` | `percent` | — |
1834
- | `PERCENTILE` | `percentile` | — |
1835
- | `FORMULA` | `formula` | — |
1836
- | `AUTO_MIN` | `autoMin` | — |
1837
- | `AUTO_MAX` | `autoMax` | — |
1838
-
1839
- <a id="cell-filtertype"></a>
1840
- #### `FilterType`
1841
-
1842
- 필터 조건 종류 — `ApiFilter.applyFilter` criteria 의 `filterType`.
1843
-
1844
- 종류에 따라 criteria 의 나머지 필드가 달라진다 — `VALUES` 는 표시할 값 목록,
1845
- `CUSTOM` 은 조건식 1~2개, `TOP10` 은 개수/비율, `DYNAMIC` 은 평균 기준 토큰.
1846
-
1847
- `ApiFilter.getInfo` 의 `columns[].filterType` 도 같은 어휘다. 단 단일 `EQUAL` 조건으로
1848
- 적용한 `CUSTOM` 은 모델에서 값 목록으로 저장되어 조회 시 `VALUES` 로 나온다.
1849
-
1850
- | 상수 | 값 | 설명 |
1851
- |---|---|---|
1852
- | `VALUES` | `values` | — |
1853
- | `CUSTOM` | `custom` | — |
1854
- | `TOP10` | `top10` | — |
1855
- | `DYNAMIC` | `dynamic` | — |
1856
-
1857
- <a id="cell-filteroperator"></a>
1858
- #### `FilterOperator`
1859
-
1860
- 사용자 지정 필터 조건식의 연산자 — `custom` criteria 의 `conditions[].operator`.
1861
-
1862
- `EQUAL` 은 단일 조건에서만 쓸 수 있다(두 조건 조합에서는 지원하지 않는다).
1863
- "사이"·"사이 제외" 는 별도 연산자가 아니라 두 조건의 AND·OR 조합으로 표현한다.
1864
-
1865
- | 상수 | 값 | 설명 |
1866
- |---|---|---|
1867
- | `EQUAL` | `equal` | — |
1868
- | `NOT_EQUAL` | `notEqual` | — |
1869
- | `GREATER_THAN` | `greaterThan` | — |
1870
- | `GREATER_OR_EQUAL` | `greaterOrEqual` | — |
1871
- | `LESS_THAN` | `lessThan` | — |
1872
- | `LESS_OR_EQUAL` | `lessOrEqual` | — |
1873
- | `BEGINS_WITH` | `beginsWith` | — |
1874
- | `NOT_BEGINS_WITH` | `notBeginsWith` | — |
1875
- | `ENDS_WITH` | `endsWith` | — |
1876
- | `NOT_ENDS_WITH` | `notEndsWith` | — |
1877
- | `CONTAINS` | `contains` | — |
1878
- | `NOT_CONTAINS` | `notContains` | — |
1879
-
1880
- <a id="cell-filterdynamictype"></a>
1881
- #### `FilterDynamicType`
1882
-
1883
- 동적 필터의 기준 — `dynamic` criteria 의 `type`.
1884
-
1885
- | 상수 | 값 | 설명 |
1886
- |---|---|---|
1887
- | `ABOVE_AVERAGE` | `aboveAverage` | — |
1888
- | `BELOW_AVERAGE` | `belowAverage` | — |
1889
-
1890
- <a id="mod-show"></a>
1891
- ## Presentation
1892
-
1893
- Presentation 문서를 다루는 기능입니다. 슬라이드 추가·복제, 도형·이미지·표 편집, 테마 적용 등을 외부 서비스에서 호출할 수 있습니다.
1894
-
1895
- <a id="show-document"></a>
1896
- ### Document — 문서 (`Document`)
1897
-
1898
- 문서 전체를 다루는 진입점으로, 슬라이드 조회·검색(getSlide/findShapes/findText 등), 슬라이드 삽입·삭제·복제·이동(insertSlide/deleteSlide/duplicateSlide 등), 날짜·슬라이드 번호·바닥글 일괄 설정(setDate/setSlideNumber/setFooter 등), 테마 적용(setDocumentColorScheme/setFontScheme/setFmtScheme 등), 저장·다운로드·인쇄(save/download/print 등), 슬라이드 쇼 시작(startSlideShow)을 제공한다.
1899
-
1900
- | 기능 | 설명 | 입력 | 결과 |
1901
- |---|---|---|---|
1902
- | `getDocumentInfo` | 문서(캔버스) 정보를 반환한다. | — | 슬라이드 영역의 가로·세로 크기 (px) 와 전체 슬라이드 수<br>`{ width: number; height: number; slideCount: number }` |
1903
- | `getSlideSize` | 슬라이드 영역 크기 (px). 문서 내 모든 슬라이드가 공유하는 단일 값. | — | 슬라이드 영역의 가로·세로 크기 (px)<br>`{ width: number; height: number }` |
1904
- | `getSlide` | 인덱스로 슬라이드를 가져온다. | `index` 숫자 — 0-based | 해당 슬라이드 (범위를 벗어나면 null)<br>[`Slide`](#show-slide) (없을 수 있음) |
1905
- | `getSlideById` | 슬라이드 ID로 슬라이드를 가져온다. | `slideId` 문자열 — 슬라이드 ID | 해당 슬라이드 (없으면 null)<br>[`Slide`](#show-slide) (없을 수 있음) |
1906
- | `getSlideIndex` | 슬라이드의 0-based 인덱스를 찾는다. | `slideProxy` [`Slide`](#show-slide) — 대상 슬라이드 | -1 if not found<br>숫자 |
1907
- | `getSlides` | 문서의 모든 슬라이드를 순서대로 반환한다. | — | 슬라이드 목록<br>[`Slide`](#show-slide) 목록 |
1908
- | `getLayoutList` | 지정한 슬라이드가 속한 마스터의 레이아웃 목록을 반환한다.<br>레이아웃은 마스터 단위의 상위 개념이라 문서 레벨에서 조회한다. | `slideProxy` [`Slide`](#show-slide) — 대상 슬라이드 | `{ id: string; type: SlideLayoutType; name: string }[]` |
1909
- | `getSlideCount` | *설명 준비 중* | — | 문서의 전체 슬라이드 수<br>숫자 |
1910
- | `getCurrentSlide` | 현재 보기의 슬라이드를 반환한다. | — | [`Slide`](#show-slide) (없을 수 있음) |
1911
- | `findSlides` | 조건에 맞는 슬라이드를 검색한다. | `filter` (선택) [`SlideFilter`](#show-slidefilter) — 검색 조건 (기본값: 전체 슬라이드) | 조건에 맞는 슬라이드 목록<br>[`Slide`](#show-slide) 목록 |
1912
- | `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)[]` |
1913
- | `findTables` | 여러 슬라이드에서 조건에 맞는 표를 검색한다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`TableFilter`](#show-tablefilter) — 검색 조건 (Slide.findTables 와 동일) (기본값: 전체 표) | 조건에 맞는 표 목록<br>[`Table`](#show-table) 목록 |
1914
- | `findCharts` | 여러 슬라이드에서 조건에 맞는 차트를 검색한다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`ChartFilter`](#show-chartfilter) — 검색 조건 (Slide.findCharts 와 동일) (기본값: 전체 차트) | 조건에 맞는 차트 목록<br>[`Chart`](#show-chart) 목록 |
1915
- | `findComments` | 여러 슬라이드에서 조건에 맞는 댓글을 검색한다. | `slides` [`Slide`](#show-slide) 목록 — 검색 대상 슬라이드<br>`filter` (선택) [`CommentFilter`](#show-commentfilter) — 검색 조건 (Slide.findComments 와 동일) (기본값: 전체 댓글) | 조건에 맞는 댓글 목록<br>[`Comment`](#show-comment) 목록 |
1916
- | `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: { from: number; to: number }; text: string }[]` |
1917
- | `getTableStyleNames` | 적용 가능한 표 스타일 이름 목록을 반환한다.<br>여기서 얻은 이름을 slide.insertTable / table.setStyle 에 그대로 넘긴다. | — | 표 스타일 이름 목록 (편집기 '표 스타일' 갤러리와 동일)<br>문자열 목록 |
1918
- | `getColorSchemeList` | 적용 가능한 색상 테마(빌트인 + 사용자 정의) 목록을 반환한다. | — | 색상 테마 목록 (prst: 프리셋 이름, name: 표시 이름, colors: 슬롯 이름 → #RRGGBB)<br>`{ prst: string; name: string; colors: Record<string, unknown> }[]` |
1919
- | `getFontSchemeList` | 적용 가능한 테마 글꼴(빌트인 + 사용자 정의) 목록을 반환한다. | — | 테마 글꼴 목록 (prst: 프리셋 이름, name: 표시 이름)<br>`{ prst: string; name: string }[]` |
1920
- | `getFmtSchemeList` | 적용 가능한 테마 효과 목록을 반환한다. | — | 테마 효과 목록 (prst: 프리셋 이름, name: 표시 이름)<br>`{ prst: string; name: string }[]` |
1921
- | `getCommentStyleList` | 댓글 메모 스타일 프리셋 목록을 반환한다. setComment 계열에 styleIndex 를 전달할 때 name 으로 식별. | — | - styleIndex 는 1-based<br>`{ styleIndex: number; name: string }[]` |
1922
- | `getChartStyleList` | 차트 프리셋 스타일(1~12)별 계열 색 팔레트를 현재 테마 기준으로 반환한다. set_chart_style 의 style 을 고를 때 참고용.<br>style 은 색 그룹(4) × 배경/선 변형(3) 조합. 색은 그룹으로만 결정되므로 같은 그룹(예: 1~3)은 colors 가 동일하고,<br>그룹 내 차이(뒤 1/2/3)는 배경/선 변형(variant)이다. 색은 테마 accent 에 종속 — 테마가 바뀌면 값도 바뀐다. | — | `{ style: number; colors: string[]; variant: string }[]` |
1923
- | `replaceText` | 검색 텍스트를 찾아 모두 새 텍스트로 바꾼다. (모두 바꾸기) slideProxyList 를 주면 그 슬라이드들만 바꾼다.<br>병합된 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 바뀌지 않는다.<br>협업 잠금 등으로 편집할 수 없는 텍스트의 매치도 바꾸지 않고 skippedCount 로 반환한다. | `query` 문자열 — 찾을 텍스트<br>`replacement` (선택) 문자열 — 바꿀 텍스트. 빈 문자열이면 매치를 삭제한다 (기본값: "")<br>`slideProxyList` (선택) [`Slide`](#show-slide) 목록 — 치환 대상 슬라이드 (기본값: 전체 슬라이드)<br>`caseSensitive` (선택) 참/거짓 — 대소문자 구분 (기본값: false) | 치환한 매치 수 / 제외한 매치 수<br>`{ replacedCount: number; skippedCount: number }` |
1924
- | `insertSlide` | 새 슬라이드를 삽입한다. | `index` (선택) 숫자 — 삽입 위치 (0-based) (기본값: 마지막에 추가)<br>`layoutType` (선택) [`SlideLayoutType`](#show-slidelayouttype) — 레이아웃 종류. 같은 type 이 여럿이면 첫 번째. 지정한 type 미존재 시 BLANK (문서에 BLANK 가 없으면 첫 번째 마스터의 첫 번째 레이아웃) (기본값: SlideLayoutType.BLANK) | 삽입된 슬라이드<br>[`Slide`](#show-slide) |
1925
- | `uploadImageFromUrl` | 이미지(URL / data:URI)를 서버 파일 DB 에 업로드한다. (SVG 임포트의 이미지 처리)<br>업로드 해소는 ApiUtils.uploadImageLink 로 공통화돼 있다(도형/배경 setImageFill·htmlImport 공유). | `url` 문자열 — 이미지 URL 또는 data URI | `{isError:boolean, src?:string, width?:number, height?:number}` |
1926
- | `deleteSlide` | 슬라이드 하나를 삭제한다. | `slideProxy` [`Slide`](#show-slide) — 삭제할 슬라이드 | — |
1927
- | `deleteSlides` | 여러 슬라이드를 일괄 삭제한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 삭제할 슬라이드 배열 | — |
1928
- | `duplicateSlide` | 슬라이드 하나를 복제한다. | `slideProxy` [`Slide`](#show-slide) — 복제할 슬라이드 | 복제된 슬라이드 Proxy<br>[`Slide`](#show-slide) (없을 수 있음) |
1929
- | `duplicateSlides` | 여러 슬라이드를 일괄 복제한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 복제할 슬라이드 배열 | 복제된 슬라이드 Proxy 배열<br>[`Slide`](#show-slide) 목록 |
1930
- | `moveSlide` | 슬라이드를 다른 위치로 이동한다. | `fromIndex` 숫자 — 이동 원본 인덱스 (0-based)<br>`toIndex` 숫자 — 이동 대상 인덱스 (0-based) | — |
1931
- | `goToSlide` | 지정한 슬라이드로 현재 보기를 전환한다. | `slideProxy` [`Slide`](#show-slide) — 이동할 슬라이드 | — |
1932
- | `setDate` | 모든 슬라이드의 날짜 머리글/바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `date` (선택) [`HeaderFooterDate`](#show-headerfooterdate) — 날짜 설정 (기본값: 자동갱신 날짜) | — |
1933
- | `removeDate` | 모든 슬라이드의 날짜 머리글/바닥글을 제거한다. | — | — |
1934
- | `setSlideNumber` | 모든 슬라이드에 슬라이드 번호를 표시한다. | — | — |
1935
- | `removeSlideNumber` | 모든 슬라이드의 슬라이드 번호를 제거한다. | — | — |
1936
- | `setFooter` | 모든 슬라이드의 바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `text` 문자열 — 바닥글 텍스트 | — |
1937
- | `removeFooter` | 모든 슬라이드의 바닥글을 제거한다. | — | — |
1938
- | `hideSlides` | 여러 슬라이드의 숨김 상태를 일괄 변경한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열<br>`isHidden` 참/거짓 — true: 숨김, false: 표시 | — |
1939
- | `resetBackgrounds` | 여러 슬라이드의 배경을 일괄 초기화한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열 | — |
1940
- | `setTransition` | 여러 슬라이드에 전환 효과를 일괄 적용한다. (단일 undo 로 처리)<br>효과가 지원하는 옵션만 반영되며, 주지 않은 값은 기본 모델에서 채운다.<br>효과 제거는 type 으로 하지 않고 removeTransition() 을 사용한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열 (전체 적용은 getSlides() 를 넘긴다)<br>`transition` [`Transition`](#show-transition) — 전환 효과 설정 | — |
1941
- | `removeTransition` | 여러 슬라이드의 전환 효과를 제거한다. (단일 undo 로 처리) | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열 | — |
1942
- | `setDocumentColorScheme` | 문서 전체의 색상 테마를 변경한다.<br>getColorSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `colorSchemePrst` 문자열 — 색상 테마 프리셋 이름 | — |
1943
- | `setSlideColorScheme` | 지정한 슬라이드들에만 색상 테마를 적용한다.<br>이후 setDocumentColorScheme 으로 문서 전체 테마를 바꾸면 여기서 준 슬라이드별 재정의는 모두 해제된다.<br>getColorSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `slideProxyList` [`Slide`](#show-slide) 목록 — 대상 슬라이드 배열<br>`colorSchemePrst` 문자열 — 색상 테마 프리셋 이름 | — |
1944
- | `createColorScheme` | 사용자 정의 색상 테마를 생성하고 현재 문서에 적용한다. | `colorScheme` [`ColorScheme`](#show-colorscheme) — 새 색상 테마 정보 | — |
1945
- | `setFontScheme` | 문서의 테마 글꼴을 변경한다.<br>getFontSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `fontSchemePrst` 문자열 — 테마 글꼴 프리셋 이름 | — |
1946
- | `setFmtScheme` | 문서의 테마 효과를 변경한다.<br>getFmtSchemeList 로 목록을 확인한 뒤 prst 를 전달한다. | `fmtSchemePrst` 문자열 — 테마 효과 프리셋 이름 | — |
1947
- | `save` | 문서를 저장한다.<br>(서버 I/O 이므로 Actor 경유) | — | — |
1948
- | `close` | 문서를 닫는다.<br>(앱 레벨 동작이므로 Actor 경유) | — | — |
1949
- | `download` | 문서를 다운로드한다.<br>(서버 I/O 이므로 Actor 경유) | — | — |
1950
- | `downloadAsPdf` | 문서를 PDF 로 변환해 다운로드한다. 원본 형식(pptx 등)으로 받으려면 download() 를 사용한다.<br>요청만 보내고 변환 완료를 기다리지 않는다 — 변환 진행·실패는 앱 상태 UI 가 표시한다.<br>OfficeFilter 사용 시 해당 API 미지원 (미구현)<br>(서버 변환·I/O 이므로 Actor 경유) | — | — |
1951
- | `print` | 현재 문서를 인쇄한다.<br>(브라우저 인쇄/PDF 등 앱 레벨 동작이므로 Actor 경유) | — | — |
1952
- | `showComments` | 문서 전체의 댓글 표시 여부를 설정한다. | `show` 참/거짓 — true: 댓글 표시, false: 댓글 숨김 | — |
1953
- | `startSlideShow` | 슬라이드 쇼(전체화면 발표)를 시작한다. | `fromCurrent` (선택) 참/거짓 — true: 현재 슬라이드부터, false: 처음부터 (기본값: false) | — |
1954
- | `selectAll` | 지정한 범위를 모두 선택한다. | `scope` (선택) [`SelectScope`](#show-selectscope) — "shape": 현재 슬라이드의 모든 도형 - "slide": 모든 슬라이드 - "text": 현재 편집 중인 텍스트 전체 (텍스트 편집 중이 아니면 아무 것도 선택 안 함) (기본값: SelectScope.SHAPE) | 선택 대상이 없으면 false<br>참/거짓 |
1955
- | `setViewMode` | 편집 화면의 보기 배율/맞춤을 변경한다. | `mode` [`ViewMode`](#show-viewmode) — 보기 배율 또는 창 맞춤. 허용값은 ViewMode 의 8개뿐이다. | — |
1956
-
1957
- <a id="show-slide"></a>
1958
- ### Slide — 슬라이드 (`Slide`)
1959
-
1960
- 슬라이드 한 장을 다루는 핸들로, 도형·표·차트·댓글 조회와 검색(getShapes/findShapes/findText 등), 개체 삽입(insertShape/insertTable/insertImage 등), 도형 그룹·복제·삭제·배분(groupShapes/duplicateShape/deleteShape 등), 배경 채우기(setFill 계열), 레이아웃·전환 효과(setLayout/setTransition 등), 슬라이드 노트 편집(setSlideNoteText 등)을 제공한다.
1961
-
1962
- | 기능 | 설명 | 입력 | 결과 |
1963
- |---|---|---|---|
1964
- | `getShapes` | 슬라이드의 모든 도형을 반환한다. | — | 도형 목록<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
1965
- | `getShape` | 인덱스로 도형을 가져온다. | `index` 숫자 — 0-based | 해당 도형 (범위를 벗어나면 null)<br>`Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control \| null` |
1966
- | `getShapeById` | 도형 ID로 도형을 가져온다. | `shapeId` 문자열 — 도형 ID | 해당 도형 (없으면 null)<br>`Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control \| null` |
1967
- | `findShapes` | 조건에 맞는 도형을 검색한다. | `filter` (선택) [`ShapeFilter`](#show-shapefilter) — 검색 조건 (기본값: 전체 도형) | 조건에 맞는 도형 목록<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
1968
- | `findTables` | 조건에 맞는 표를 검색한다. | `filter` (선택) [`TableFilter`](#show-tablefilter) — 검색 조건 (기본값: 전체 표) | 조건에 맞는 표 목록<br>[`Table`](#show-table) 목록 |
1969
- | `getComments` | 슬라이드의 최상위 댓글(답글 제외) 목록을 반환한다. | — | 댓글 목록<br>[`Comment`](#show-comment) 목록 |
1970
- | `getComment` | 댓글 ID로 댓글을 가져온다. | `commentId` 문자열 — 댓글 ID | 해당 댓글 (없으면 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
1971
- | `getPrevComment` | UI의 메모 탐색 기준으로 이전 최상위 댓글을 반환한다. | `commentProxy` [`Comment`](#show-comment) — 기준 최상위 댓글 | 이전 댓글 (없으면 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
1972
- | `getNextComment` | UI의 메모 탐색 기준으로 다음 최상위 댓글을 반환한다. | `commentProxy` [`Comment`](#show-comment) — 기준 최상위 댓글 | 다음 댓글 (없으면 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
1973
- | `findComments` | 조건에 맞는 댓글을 검색한다. | `filter` (선택) [`CommentFilter`](#show-commentfilter) — 검색 조건 (기본값: 전체 댓글) | 조건에 맞는 댓글 목록<br>[`Comment`](#show-comment) 목록 |
1974
- | `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: { from: number; to: number }; text: string }[]` |
1975
- | `getSlideNoteText` | 슬라이드 노트의 텍스트를 plain text 로 반환한다.<br>노트 슬라이드가 없으면 생성하지 않고 빈 문자열을 반환한다. | — | 문자열 |
1976
- | `getBackgroundFill` | 슬라이드에 명시적으로 설정된 배경 채우기를 반환한다. (setSolidFill/setGradientFill/setImageFill 대칭)<br>레이아웃/마스터 상속 배경은 포함하지 않으며, 슬라이드 자체 배경이 없으면 `{ type: "none" }`. | — | 배경 채우기 정보<br>[`Fill`](#show-fill) |
1977
- | `getLayoutType` | 슬라이드에 적용된 레이아웃 종류를 반환한다. (setLayout 대칭) | — | 레이아웃 종류. 없으면 null<br>[`SlideLayoutType`](#show-slidelayouttype) (없을 수 있음) |
1978
- | `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) (없을 수 있음) |
1979
- | `replaceText` | 이 슬라이드에서 검색 텍스트를 찾아 모두 새 텍스트로 바꾼다. (모두 바꾸기)<br>병합된 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 바뀌지 않는다.<br>협업 잠금 등으로 편집할 수 없는 텍스트의 매치도 바꾸지 않고 skippedCount 로 반환한다. | `query` 문자열 — 찾을 텍스트<br>`replacement` (선택) 문자열 — 바꿀 텍스트. 빈 문자열이면 매치를 삭제한다 (기본값: "")<br>`caseSensitive` (선택) 참/거짓 — 대소문자 구분 (기본값: false) | 치환한 매치 수 / 제외한 매치 수<br>`{ replacedCount: number; skippedCount: number }` |
1980
- | `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` |
1981
- | `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) |
1982
- | `insertTable` | 표를 삽입한다. | `rowNum` 숫자 — 행 수<br>`colNum` 숫자 — 열 수<br>`styleName` (선택) 문자열 — 표 스타일 이름 (doc.getTableStyleNames() 결과). 목록에 없는 이름이면 throw (기본값: 문서 기본 스타일) | 삽입된 표<br>[`Table`](#show-table) |
1983
- | `findCharts` | 조건에 맞는 차트 배열을 반환한다. | `filter` (선택) [`ChartFilter`](#show-chartfilter) — 검색 조건 (기본값: 전체 차트) | [`Chart`](#show-chart) 목록 |
1984
- | `insertImage` | 웹 이미지를 삽입한다. | `url` 문자열 — 이미지 URL | 삽입된 이미지 도형 Proxy<br>[`Image`](#show-image) |
1985
- | `insertWebVideo` | 웹 동영상(YouTube / 3DS)을 삽입한다. | `url` 문자열 — 웹 동영상 URL (YouTube watch/embed/shorts/youtu.be, 3DS media) | 삽입된 웹 동영상 도형 Proxy<br>[`Image`](#show-image) |
1986
- | `saveAsPicture` | 슬라이드의 도형들을 하나의 이미지로 저장한다. (기존 UI 동작과 동일) | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 이미지로 저장할 도형 Proxy 배열 | — |
1987
- | `groupShapes` | 여러 도형을 하나의 그룹으로 묶는다. | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 그룹화할 도형 Proxy 배열 | 생성된 그룹 도형<br>[`Group`](#show-group) |
1988
- | `ungroupShapes` | 그룹을 해제해 자식 도형으로 분리한다. | `shapeProxy` [`Group`](#show-group) — 그룹 해제할 그룹 도형 Proxy | 분리된 자식 도형 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
1989
- | `deleteShape` | 도형 하나를 삭제한다. | `shapeProxy` `Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control` — 삭제할 도형 Proxy | — |
1990
- | `deleteShapes` | 여러 도형을 일괄 삭제한다. | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 삭제할 도형 Proxy 배열 | — |
1991
- | `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` |
1992
- | `duplicateShapes` | 도형을 복제한다. 차트는 복제할 수 없어 결과에서 제외된다. | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 복제할 도형 Proxy 배열 | 새로 생성된 도형 Proxy 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
1993
- | `distributeShapes` | 여러 도형을 균등하게 분배(distribute) 한다.<br>bbox 중심 기준으로 정렬한 뒤, 양 끝 도형 사이 간격이 모두 같아지도록 재배치한다. (2개 미만이면 변경 없음) | `shapeProxyList` `(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` — 분배할 도형 Proxy 배열<br>`direction` [`DistributeDirection`](#show-distributedirection) — 분배 방향 | — |
1994
- | `hide` | 이 슬라이드의 숨김 상태를 설정한다. | `isHidden` 참/거짓 — true: 슬라이드 숨김, false: 슬라이드 표시 | — |
1995
- | `setLayout` | 슬라이드에 레이아웃을 적용한다.<br>같은 type 이 여럿이면 마스터 순서상 첫 번째 레이아웃이 선택된다. | `layoutType` [`SlideLayoutType`](#show-slidelayouttype) — 레이아웃 종류. doc.getLayoutList(slide) 로 사용 가능한 type 확인 | 적용 여부 (해당 type 이 이 슬라이드의 마스터에 없으면 false)<br>참/거짓 |
1996
- | `resetLayout` | 슬라이드 레이아웃을 초기화한다. | — | — |
1997
- | `resetBackground` | 슬라이드 배경을 초기화한다. | — | — |
1998
- | `setShowMasterShapes` | 마스터(레이아웃)의 배경 도형 표시 여부를 설정한다. | `show` 참/거짓 — true: 마스터 도형 표시, false: 숨김 | — |
1999
- | `setSolidFill` | 슬라이드 배경을 단색으로 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100) (기본값: 0(불투명)) | — |
2000
- | `setGradientFill` | 슬라이드 배경을 그라데이션으로 설정한다.<br><br><b>Example</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) | — |
2001
- | `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<br>— |
2002
- | `removeFill` | 슬라이드 배경 채우기를 제거한다. | — | — |
2003
- | `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(불투명)) | — |
2004
- | `setFill` | getBackgroundFill() 이 반환한 채우기 객체를 그대로 슬라이드 배경에 적용한다. (getBackgroundFill 대칭)<br>type 으로 분기해 대응 setter 를 호출한다. image 는 readback 의 embed 를 재사용해 같은 문서 안에서 복원한다.<br>embed 가 없는 image 입력은 무시된다(새 이미지는 개별 setImageFill 사용). | `fill` [`Fill`](#show-fill) — getBackgroundFill() 반환값 | — |
2005
- | `insertComment` | 댓글을 추가한다. | `text` 문자열 — 댓글 텍스트 | 생성된 댓글 (실패 시 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
2006
- | `replyComment` | 댓글에 답글을 추가한다. | `commentProxy` [`Comment`](#show-comment) — 부모 댓글<br>`text` 문자열 — 답글 텍스트 | 생성된 답글 (실패 시 null)<br>[`Comment`](#show-comment) (없을 수 있음) |
2007
- | `deleteComment` | 댓글 하나를 삭제한다. 부모 댓글이면 그 답글도 함께 삭제된다. | `commentProxy` [`Comment`](#show-comment) — 삭제할 댓글 | — |
2008
- | `deleteComments` | 여러 댓글을 일괄 삭제한다. 부모 댓글이 포함되면 그 답글도 함께 삭제된다. (UI 동작과 일치) | `commentProxyList` [`Comment`](#show-comment) 목록 — 삭제할 댓글 배열 | — |
2009
- | `setTransition` | 슬라이드 전환 효과를 설정한다. 평면 입력을 모델 포맷으로 변환해 적용한다.<br>효과가 지원하는 옵션만 반영되며, 주지 않은 값은 기본 모델에서 채운다.<br>효과 제거는 type 으로 하지 않고 removeTransition() 을 사용한다. | `transition` [`Transition`](#show-transition) — 전환 효과 설정 | — |
2010
- | `removeTransition` | 전환 효과를 제거한다. | — | — |
2011
- | `previewTransition` | 이 슬라이드에 설정된 전환 효과 미리보기를 화면에서 재생한다.<br>미리보기는 현재 보고 있는 슬라이드에서만 동작하므로, 이 슬라이드가 현재 슬라이드가<br>아니면 재생하지 않고 예외를 던진다. 다른 슬라이드는 먼저 goToSlide 로 이동한 뒤 호출한다.<br>문서를 변경하지 않는 표시용 동작이다. | `autoPreview` (선택) 참/거짓 — 지정하면 재생 대신 '자동 미리보기 설정'을 on/off 로 토글한다 (전환 효과 설정 시 자동으로 미리보기를 재생할지 여부, 앱 전역 설정) (기본값: 없음(즉시 미리보기 재생)) | — |
2012
- | `setDate` | 이 슬라이드의 날짜 머리글/바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `date` (선택) [`HeaderFooterDate`](#show-headerfooterdate) — 날짜 설정 (기본값: 자동갱신 날짜) | — |
2013
- | `removeDate` | 이 슬라이드의 날짜 머리글/바닥글을 제거한다. | — | — |
2014
- | `setSlideNumber` | 이 슬라이드에 슬라이드 번호를 표시한다. | — | — |
2015
- | `removeSlideNumber` | 이 슬라이드의 슬라이드 번호를 제거한다. | — | — |
2016
- | `setFooter` | 이 슬라이드의 바닥글을 설정한다. (없으면 생성, 있으면 갱신) | `text` 문자열 — 바닥글 텍스트 | — |
2017
- | `removeFooter` | 이 슬라이드의 바닥글을 제거한다. | — | — |
2018
- | `setSlideNoteText` | 슬라이드 노트 텍스트를 설정한다. (기존 노트 내용은 대체됨) | `text` 문자열 — 노트 텍스트 | — |
2019
- | `appendSlideNoteText` | 슬라이드 노트 끝에 텍스트를 이어 붙인다. | `text` 문자열 — 추가할 노트 텍스트 | — |
2020
-
2021
- <a id="show-basepathshape"></a>
2022
- ### BasePathShape — 도형 (패스) (`BasePathShape`)
2023
-
2024
- 채우기·선·효과를 지원하는 도형들의 공통 API 로, 채우기(setSolidFill/setGradientFill/setImageFill 등), 선 서식(setLineColor/setLineWidth/setLineDash 등), 그림자·네온·부드러운 가장자리·반사 효과(setOuterShadow/setGlow/setSoftEdge 등), 3D 서식(set3d/remove3d)을 제공한다.
2025
-
2026
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2027
-
2028
- | 기능 | 설명 | 입력 | 결과 |
2029
- |---|---|---|---|
2030
- | `getFill` | 도형 채우기를 반환한다. (setFill 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>type 별 개별 setter 는 setSolidFill/setGradientFill/setImageFill/setPatternFill/removeFill 이다. | — | 채우기 정보. noFill 이면 `{ type: FillType.NONE }`, 대상 도형이 없으면(협업 중 삭제 등) null<br>[`Fill`](#show-fill) (없을 수 있음) |
2031
- | `getLineStyle` | 선 스타일을 반환한다. (setLineStyle 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>개별 setter 는 setLineColor/setLineGradient/setLineWidth/setLineDash/setLineCap/setLineJoin 이다.<br><br>선 채우기는 getFill 과 같은 형태로 담는다. | — | 선 스타일. 대상 도형이 없으면 null<br>[`LineStyle`](#show-linestyle) (없을 수 있음) |
2032
- | `getLineColor` | 선 색상을 반환한다. (setLineColor 대칭. 투명도까지 필요하면 getLineStyle 사용) | — | 선 색상 (hex "#RRGGBB" — scheme color 도 hex 로 풀려서 나온다). 선이 없거나 대상 도형이 없으면 null<br>문자열 (없을 수 있음) |
2033
- | `getLineWidth` | 선 두께(pt)를 반환한다. (setLineWidth 대칭) | — | 선 두께 (pt). 선 없음(noFill)이어도 두께는 그대로 반환한다. 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2034
- | `getLineDash` | 선 대시 유형을 반환한다. (setLineDash 대칭) | — | 선 대시 유형. LineDash enum 이 아니거나 대상 도형이 없으면 null<br>[`LineDash`](#common-linedash) (없을 수 있음) |
2035
- | `getLineCap` | 선 끝 모양(cap)을 반환한다. (setLineCap 대칭) | — | 선 끝 모양. 설정이 없거나 대상 도형이 없으면 null<br>[`LineCap`](#show-linecap) (없을 수 있음) |
2036
- | `getLineJoin` | 선 연결 유형(join)을 반환한다. (setLineJoin 대칭) | — | 선 연결(모서리) 유형. 설정이 없거나 대상 도형이 없으면 null<br>[`LineJoin`](#show-linejoin) (없을 수 있음) |
2037
- | `getEffects` | 도형에 적용된 효과를 반환한다. 적용된 효과만 키로 포함된다.<br>각 값은 대응 setter(setOuterShadow/setInnerShadow/setGlow/setSoftEdge/setReflection/set3d) 의 인자와 같은 형태다.<br>그림자·네온의 alpha 는 불투명(0)이어도 항상 포함되고, 길이(pt)·비율(%)은 소수 첫째 자리로 반올림된다.<br>outerShadow·innerShadow 가 함께 실린 문서면 둘 다 담는다 (setter 로는 하나만 넣을 수 있다). | — | 효과 정보. 적용된 효과가 없으면 빈 객체 `{}`, 대상 도형이 없으면(협업 중 삭제 등) null<br>[`Effects`](#show-effects) (없을 수 있음) |
2038
- | `setSolidFill` | 도형 채우기를 단색으로 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지) | — |
2039
- | `setGradientFill` | 그라데이션 채우기를 설정한다.<br><br><b>Example</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) | — |
2040
- | `setImageFill` | 이미지 채우기를 설정한다.<br><br><b>Example</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 로 reject<br>— |
2041
- | `removeFill` | 채우기를 제거한다 (noFill). | — | — |
2042
- | `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) | — |
2043
- | `setFill` | getFill() 이 반환한 채우기 객체를 그대로 적용한다. (getFill 대칭 — 도형→도형 채우기 복사)<br>image 는 조회 결과의 embed 를 재사용하므로 같은 문서 안에서만 복원된다.<br>embed 없는 image 는 적용할 그림이 없어 거부한다 (새 이미지는 setImageFill). | `fill` (선택) [`Fill`](#show-fill) — getFill() 반환값. 생략하면 아무것도 변경하지 않는다 | — |
2044
- | `setLineColor` | 선 색상을 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지) | — |
2045
- | `setLineGradient` | 선(테두리) 그라데이션 채우기를 설정한다.<br><br><b>Example</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) | — |
2046
- | `removeLineColor` | 선 색상을 제거한다 (noFill). | — | — |
2047
- | `setLineWidth` | 선 두께를 설정한다. | `lineWidth` 숫자 — 선 두께 (pt 단위) | — |
2048
- | `setLineDash` | 선 스타일(대시)을 설정한다. | `lineDash` [`LineDash`](#common-linedash) — 선 대시 스타일 | — |
2049
- | `setLineCap` | 선 끝 모양(cap)을 설정한다. | `lineCap` [`LineCap`](#show-linecap) — 선 끝 모양 | — |
2050
- | `setLineJoin` | 선 연결 유형(join)을 설정한다. | `lineJoin` [`LineJoin`](#show-linejoin) — 선 연결(모서리) 유형 | — |
2051
- | `setLineStyle` | getLineStyle() 이 반환한 선 스타일 객체를 그대로 적용한다. (getLineStyle 대칭 — 도형→도형 선 복사) | `style` (선택) [`LineStyle`](#show-linestyle) — getLineStyle() 반환값. 생략하면 아무것도 변경하지 않는다 | — |
2052
- | `setOuterShadow` | 외부 그림자를 적용한다. (getEffects().outerShadow 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 OuterShadow 참조).<br>도형이 갖는 그림자는 하나다 - 내부 그림자가 걸려 있으면 외부 그림자로 바뀐다. | `shadow` (선택) [`OuterShadow`](#show-outershadow) — 그림자 설정 | — |
2053
- | `setInnerShadow` | 내부 그림자를 적용한다. (getEffects().innerShadow 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 InnerShadow 참조).<br>도형이 갖는 그림자는 하나다 - 외부 그림자가 걸려 있으면 내부 그림자로 바뀐다. | `shadow` (선택) [`InnerShadow`](#show-innershadow) — 그림자 설정 | — |
2054
- | `setGlow` | 네온(광선) 효과를 적용한다. (getEffects().glow 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 Glow 참조). | `glow` (선택) [`Glow`](#show-glow) — 네온(광선) 설정 | — |
2055
- | `setSoftEdge` | 옅은 테두리(softEdge) 효과를 적용한다. (getEffects().softEdge 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 SoftEdge 참조). | `softEdge` (선택) [`SoftEdge`](#show-softedge) — 옅은 테두리 설정 | — |
2056
- | `setReflection` | 반사 효과를 적용한다. (getEffects().reflection 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>생략한 필드는 기본값으로 채운다 (필드별 기본값은 Reflection 참조). | `reflection` (선택) [`Reflection`](#show-reflection) — 반사 설정 | — |
2057
- | `removeEffect` | 효과를 제거한다. 그 효과가 걸려 있지 않으면 아무 일도 하지 않는다.<br>도형이 직접 가진 효과만 제거한다 - 도형 스타일(effectRef)에서 상속받은 효과는 제거할 수 없어,<br>getEffects() 가 돌려주는데도 아무 일도 하지 않는 경우가 있다. | `effectType` [`EffectType`](#show-effecttype) — 제거할 효과 타입 | — |
2058
- | `set3d` | 도형에 3D 효과를 적용한다. scene3d 와 sp3d 중 비어 있는 인자는 적용하지 않는다. | `scene3d` (선택) [`Scene3d`](#show-scene3d) — 카메라(회전) 설정. 생략하면 적용하지 않음<br>`sp3d` (선택) [`Sp3d`](#show-sp3d) — 입체(깊이) 설정. 생략하면 적용하지 않음 | — |
2059
- | `remove3d` | 도형의 3D 효과를 제거한다. | — | — |
2060
- | `setEffects` | getEffects() 가 반환한 효과 객체를 그대로 적용한다. (getEffects 대칭 — 도형→도형 효과 복사)<br>포함된 효과 키만 대응 setter 로 적용한다. scene3d/sp3d 는 set3d 로 함께 넘긴다.<br>대상의 기존 효과를 지우지는 않는다 - 완전 복사하려면 removeEffect/remove3d 로 먼저 제거한 뒤 적용한다.<br>outerShadow 와 innerShadow 를 함께 넘기면 거부하지 않고 순서대로 적용해 나중 것만 남는다. | `effects` (선택) [`Effects`](#show-effects) — getEffects() 반환값. 생략하면 아무것도 변경하지 않는다 | — |
2061
-
2062
- <a id="show-baseshape"></a>
2063
- ### BaseShape — 도형 공통 (`BaseShape`)
2064
-
2065
- 모든 도형 종류가 공유하는 공통 API 로, 위치·크기·회전 조회와 변경(getTransform/moveBy/setRotation 등), 정렬·순서·뒤집기(align/reorder/flip), 하이퍼링크(getHyperlink/setHyperlink/removeHyperlink), 도형 종류 판별 가드(isShape/isImage/isChart 등)를 제공한다.
2066
-
2067
- | 기능 | 설명 | 입력 | 결과 |
2068
- |---|---|---|---|
2069
- | `isShape` | 이 핸들이 `Shape` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Shape` |
2070
- | `isImage` | 이 핸들이 `Image` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Image` |
2071
- | `isLine` | 이 핸들이 `Line` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Line` |
2072
- | `isGroup` | 이 핸들이 `Group` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Group` |
2073
- | `isChart` | 이 핸들이 `Chart` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Chart` |
2074
- | `isTable` | 이 핸들이 `Table` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Table` |
2075
- | `isDiagram` | 이 핸들이 `Diagram` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Diagram` |
2076
- | `isOleObject` | 이 핸들이 `OleObject` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is OleObject` |
2077
- | `isControl` | 이 핸들이 `Control` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Control` |
2078
- | `getTransform` | 도형의 위치, 크기, 회전 정보를 반환한다.<br>x/y 는 반전(flip) 여부와 무관하게 도형의 좌상단이라, 반환값을 다른 도형의 setTransform 에 그대로 넘기면<br>두 도형이 같은 자리에 놓인다.<br>값은 에디터 입력 단위로 반올림해 반환한다 - 크기는 소수 한 자리, 위치는 정수.<br>setter 도 같은 단위로 넣으므로, 임포트 문서처럼 더 잘게 놓인 도형은 되넘길 때 그만큼 움직인다. | — | 도형의 위치·크기·회전 정보. 대상 도형이 없으면(협업 중 삭제 등) null<br>[`ShapeTransform`](#show-shapetransform) (없을 수 있음) |
2079
- | `getWidth` | 도형의 너비를 반환한다. (setWidth 대칭) | — | 너비 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2080
- | `getHeight` | 도형의 높이를 반환한다. (setHeight 대칭) | — | 높이 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2081
- | `getX` | 도형의 X 좌표를 반환한다. (setX 대칭) | — | X 좌표 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2082
- | `getY` | 도형의 Y 좌표를 반환한다. (setY 대칭) | — | Y 좌표 (px 단위). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2083
- | `getRotation` | 도형의 회전 각도를 반환한다. (setRotation 대칭) | — | 회전 각도 (degree). 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2084
- | `getPresetId` | 도형의 OOXML preset id (prst) 를 반환한다. | — | preset id (prst), 없으면 null<br>문자열 (없을 수 있음) |
2085
- | `isPlaceholder` | 도형이 placeholder(제목 · 본문 틀 등)인지 반환한다. | — | placeholder 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2086
- | `getPlaceholderType` | 도형의 placeholder 종류를 반환한다. | — | placeholder 종류. placeholder 가 아니거나 대상 도형이 없으면 null<br>[`PlaceholderType`](#show-placeholdertype) (없을 수 있음) |
2087
- | `hasText` | 도형이 텍스트를 담고 있는지 반환한다. 에디터가 텍스트를 비었다고 보는 기준과 같다 —<br>공백만 있거나 빈 문단이 둘 이상(개행만 넣은 상태)이면 true, 빈 문단 하나뿐이면 false 다.<br>도형 레벨 텍스트가 없는 종류(표·그룹·차트)는 항상 false 다. (표는 셀 단위로 조회) | — | 텍스트 존재 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2088
- | `getZOrderIndex` | 부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다. 0 이 맨 뒤이며, 클수록 앞이다. | — | z-order 순번. 대상 도형이 없으면 null<br>숫자 (없을 수 있음) |
2089
- | `isFlippedH` | 도형이 좌우로 반전된 상태인지 반환한다. (flip(FlipDirection.HORIZONTAL) 을 호출하면 이 값이 뒤집힌다) | — | 좌우 반전 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2090
- | `isFlippedV` | 도형이 상하로 반전된 상태인지 반환한다. (flip(FlipDirection.VERTICAL) 을 호출하면 이 값이 뒤집힌다) | — | 상하 반전 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2091
- | `getHyperlink` | 도형에 설정된 하이퍼링크를 반환한다. 반환 객체를 그대로 setHyperlink 에 넘길 수 있다.<br>지원하지 않는 종류(프로그램 실행·매크로 등)가 걸려 있으면 null 이다. | — | 하이퍼링크 정보. 하이퍼링크(action)가 없으면 null<br>[`Hyperlink`](#show-hyperlink) (없을 수 있음) |
2092
- | `setWidth` | 도형의 너비를 설정한다. 크기 조정이 불가능한 도형이면 무시된다. | `width` 숫자 — 너비 (px 단위, 소수 한 자리로 반올림) | — |
2093
- | `setHeight` | 도형의 높이를 설정한다. 크기 조정이 불가능한 도형이면 무시된다. | `height` 숫자 — 높이 (px 단위, 소수 한 자리로 반올림) | — |
2094
- | `setX` | 도형의 X 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. (상대 이동은 moveBy) | `x` 숫자 — X 좌표 (px 단위, 정수로 반올림) | — |
2095
- | `setY` | 도형의 Y 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. | `y` 숫자 — Y 좌표 (px 단위, 정수로 반올림) | — |
2096
- | `moveBy` | 도형을 현재 위치 기준으로 x, y 만큼 상대 이동한다. (절대 좌표 설정은 setX / setY) | `distance` [`ShapeMoveDistance`](#show-shapemovedistance) — 이동량 (px 단위) | — |
2097
- | `setRotation` | 도형의 회전 각도를 절대값으로 설정한다. 회전이 불가능한 도형이면 무시된다. (getRotation 대칭) | `rotation` 숫자 — 회전 각도 (degree) | — |
2098
- | `setTransform` | 도형의 위치·크기·회전을 한 번에 설정한다. getTransform() 반환값을 그대로 넘길 수 있다. (getTransform 대칭)<br>값을 준 필드만 크기→위치→회전 순으로 적용하고, 생략한 필드는 현재 값을 유지한다.<br>각 필드는 개별 setter 와 같이 해당 조작(크기/이동/회전)이 불가능한 도형에서 무시된다. | `transform` (선택) `Partial<ShapeTransform>` — 위치/크기 (px) · 회전 (degree) | — |
2099
- | `flip` | 도형을 상하 또는 좌우로 반전한다. 현재 반전 상태를 뒤집는 토글이며, 지금 반전돼 있는지는<br>isFlippedH()/isFlippedV() 로 읽는다. 회전이 불가능한 도형에서는 반전도 무시된다.<br>회전된 도형은 각도도 거울상으로 함께 바뀐다 (getRotation() 값이 360 - 기존 각도 로 바뀐다). | `direction` [`FlipDirection`](#show-flipdirection) — 반전 방향 | — |
2100
- | `reorder` | 도형의 정렬 순서(앞으로/뒤로)를 변경한다. 이미 목표 위치라 바뀔 것이 없으면 무시된다. | `order` [`ShapeZOrder`](#common-shapezorder) — 순서 변경 타입 | — |
2101
- | `align` | 도형을 슬라이드 기준으로 정렬한다. 이동이 불가능한 도형이면 무시된다.<br>그룹 자식도 그룹 안이 아니라 슬라이드를 기준으로 움직인다(에디터와 같다).<br>자식이 그룹 밖으로 나가면 그룹이 자식을 담도록 함께 넓어진다. | `alignType` [`AlignType`](#show-aligntype) — 정렬 타입 | — |
2102
- | `setHyperlink` | 도형에 하이퍼링크를 설정한다. (getHyperlink 대칭 — 반환 객체를 그대로 넘겨 하이퍼링크를 복사할 수 있다)<br>지원하지 않는 종류나 유효하지 않은 대상(없는 슬라이드 id 등)은 무시한다. | `hyperlink` [`Hyperlink`](#show-hyperlink) — getHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다 | — |
2103
- | `removeHyperlink` | 도형의 하이퍼링크를 제거한다. | — | — |
2104
-
2105
- <a id="show-chart"></a>
2106
- ### Chart — 차트 (`Chart`)
2107
-
2108
- 차트 도형을 다루는 핸들로, 차트 종류·스타일(setType/setStyle), 제목·축 제목(setTitle/setAxisTitle), 범례·데이터 라벨 위치(setLegendPosition/setDataLabelPosition), 눈금선(setGridLine) 편집과 현재 서식 상태 조회(getType/getTitle/getState 등)를 제공한다.
2109
-
2110
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2111
-
2112
- | 기능 | 설명 | 입력 | 결과 |
2113
- |---|---|---|---|
2114
- | `getType` | 차트 타입을 enum 문자열로 반환한다. 미지원/미매핑 타입(파일 로드 stock/surface 등)은 "unknown". | — | 문자열 |
2115
- | `isEditable` | 차트가 편집 가능한지 반환한다. 대상 부재·복원 불가·외부 데이터 차트는 false (throw 하지 않는다). | — | 참/거짓 |
2116
- | `getTitle` | 차트 제목을 반환한다. 미설정 시 빈 문자열. | — | 문자열 |
2117
- | `getAxisTitle` | 축 제목을 반환한다. 미설정 시 빈 문자열,<br>축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw. | 문자열 (없을 수 있음) |
2118
- | `getLegendPosition` | 범례 위치를 반환한다. 범례가 없으면 "none". | — | [`ChartLegendPosition`](#common-chartlegendposition) |
2119
- | `getDataLabelPosition` | 데이터레이블 위치를 반환한다. 레이블이 없으면 "none". | — | [`ChartDataLabelPosition`](#common-chartdatalabelposition) |
2120
- | `getGridLine` | 축별 눈금선 종류를 반환한다. 꺼져 있으면 "none",<br>해당 눈금선을 갖지 않는 차트 종류는 null. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw. | [`ChartGridLineType`](#common-chartgridlinetype) (없을 수 있음) |
2121
- | `getState` | 차트의 공통 서식 상태를 모델 조회 1회로 반환한다. 각 값은 동명 getter 와 같은 규약이다 —<br>axisTitle/gridLine 의 null 은 그 차트 종류에 해당 축의 제목·눈금선이 없다는 뜻이고,<br>"none" 은 지원하지만 꺼져 있다는 뜻이다.<br><br>개별 getter 는 호출마다 대상 실존 확인(hasChart)을 반복하므로, 여러 값을 함께 읽을 때는 이 쪽을 쓴다. | — | `{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string \| null; vertical: string \| null }; gridLine: { horizontal: ChartGridLineType \| null; vertical: ChartGridLineType \| null } }` |
2122
- | `setType` | 차트 종류를 변경한다. 현재 종류와 같으면 아무것도 하지 않는다 —<br>종류가 그대로인데 스타일 미지정 차트의 스타일만 기본값으로 바뀌는 부작용을 막는다. | `chartType` [`ChartType`](#common-charttype) — 차트 종류 enum 값(= enum 문자열, 예: "clustered_column"). 미정의/미지원이면 CHART_TYPE_UNSUPPORTED throw. | — |
2123
- | `setStyle` | 차트 프리셋 스타일을 변경한다. 번호별 실제 색은 문서 테마에 종속된다. | `style` 숫자 — 스타일 번호 (1~12 정수). 3개 단위로 색 그룹이 나뉘고(1~3=그룹1, 4~6=그룹2, 7~9=그룹3, 10~12=그룹4), 그룹 내 순서는 배경 변형이다(1번째=반투명 배경, 2번째=흰색 배경, 3번째=색상 배경+계열 테두리 — 정의는 chartInfo.setStyle JSDoc). 형태 위반 시 CHART_STYLE_INVALID throw. | — |
2124
- | `setTitle` | 차트 제목을 설정한다. | `title` 문자열 | — |
2125
- | `setAxisTitle` | 축 제목을 설정한다. 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는<br>CHART_AXIS_TITLE_UNSUPPORTED throw. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw.<br>`title` 문자열 | — |
2126
- | `setLegendPosition` | 범례 위치를 설정한다. "none"이면 범례를 숨긴다. | `position` [`ChartLegendPosition`](#common-chartlegendposition) — 그 외 CHART_LEGEND_POSITION_INVALID throw. | — |
2127
- | `setDataLabelPosition` | 데이터레이블 위치를 설정한다. "none"이면 숨긴다.<br>차트 타입별 유효 위치까지 검증한다 — 타입 그룹 미정의는 CHART_DATALABEL_UNSUPPORTED,<br>그룹에 없는 위치는 CHART_DATALABEL_POSITION_INVALID throw. "none"은 전 타입 허용. | `position` [`ChartDataLabelPosition`](#common-chartdatalabelposition) — 그 외 CHART_DATALABEL_POSITION_INVALID throw. | — |
2128
- | `setGridLine` | 차트 눈금선을 설정한다. "none"이면 해당 축 눈금선을 숨긴다.<br>차트 타입별 지원 여부까지 검증한다 — 원형 계열·도넛은 양축, 방사형은 세로 축이<br>CHART_GRID_LINE_UNSUPPORTED throw. | `axis` [`ChartAxis`](#common-chartaxis) — 그 외 CHART_AXIS_INVALID throw.<br>`gridType` [`ChartGridLineType`](#common-chartgridlinetype) — 그 외 CHART_GRID_LINE_INVALID throw. | — |
2129
-
2130
- <a id="show-comment"></a>
2131
- ### Comment — 댓글 (`Comment`)
2132
-
2133
- 댓글 하나를 다루는 핸들로, 내용·작성자·작성 시각·위치 조회(getText/getAuthorName/getDateTime 등), 답글 관계 조회(isReply/getParentId/getReplies 등), 내용 수정(setText/appendText), 위치 이동(moveBy/setPosition), 표시 스타일 변경(setStyle)을 제공한다.
2134
-
2135
- | 기능 | 설명 | 입력 | 결과 |
2136
- |---|---|---|---|
2137
- | `getText` | 댓글 텍스트를 반환한다. | — | 댓글 텍스트<br>문자열 |
2138
- | `getAuthorName` | 댓글 작성자 이름을 반환한다. | — | 작성자 이름 (작성자 정보가 없으면 빈 문자열)<br>문자열 |
2139
- | `getDateTime` | 댓글 작성 일시를 반환한다. | — | 작성 일시 'YYYY-MM-DDTHH:mm:ss.SSS'<br>문자열 |
2140
- | `getPosition` | 댓글 메모 아이콘의 슬라이드 기준 위치를 반환합니다. | — | 댓글 메모 아이콘의 위치 (px 단위)<br>[`CommentPosition`](#show-commentposition) |
2141
- | `isReply` | 이 댓글이 답글인지 여부를 반환한다. | — | 답글이면 true<br>참/거짓 |
2142
- | `getParentId` | 부모 댓글 ID를 반환한다. | — | 부모 댓글 ID (답글이 아니면 빈 문자열)<br>문자열 |
2143
- | `hasReplies` | 답글이 하나라도 있는지 여부를 반환한다. | — | 답글이 있으면 true<br>참/거짓 |
2144
- | `getReplies` | 이 댓글의 답글 목록을 반환한다. | — | 답글 목록<br>[`Comment`](#show-comment) 목록 |
2145
- | `setText` | 댓글 텍스트를 설정한다. (기존 내용은 대체됨) | `text` 문자열 — 댓글 텍스트 | — |
2146
- | `appendText` | 댓글 텍스트 끝에 이어 붙인다. | `text` 문자열 — 추가할 텍스트 | — |
2147
- | `moveBy` | 댓글 메모를 x, y 만큼 상대 이동시킵니다. | `distance` 객체 — { x, y } (px 단위 이동량). 양수 = 오른쪽/아래 | — |
2148
- | `setPosition` | 댓글 메모를 슬라이드 기준 절대 위치로 이동시킵니다. (상대 이동은 moveBy) | `position` [`CommentPosition`](#show-commentposition) — { x, y } (px 단위 절대 좌표). 생략한 축은 현재값 유지 | — |
2149
- | `setStyle` | 댓글 메모 스타일을 변경합니다.<br>적용 가능한 styleIndex 와 색 이름은 Document.getCommentStyleList() 로 조회 | `styleIndex` 숫자 — 스타일 인덱스 (1-based, getCommentStyleList 의 styleIndex) | — |
2150
-
2151
- <a id="show-control"></a>
2152
- ### Control (`Control`)
2153
-
2154
- 컨트롤 개체를 다루는 핸들로, 내용 편집은 지원하지 않으며 위치·크기·정렬·순서 등 BaseShape 공통 API 만 제공한다.
2155
-
2156
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2157
-
2158
- | 기능 | 설명 | 입력 | 결과 |
2159
- |---|---|---|---|
2160
-
2161
- <a id="show-diagram"></a>
2162
- ### Diagram (`Diagram`)
2163
-
2164
- 다이어그램 개체를 다루는 핸들로, 내용 편집은 지원하지 않으며 위치·크기·정렬·순서 등 BaseShape 공통 API 만 제공한다.
2165
-
2166
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2167
-
2168
- | 기능 | 설명 | 입력 | 결과 |
2169
- |---|---|---|---|
2170
-
2171
- <a id="show-group"></a>
2172
- ### Group — 그룹 (`Group`)
2173
-
2174
- 그룹 도형을 다루는 핸들로, 하위 도형 조회(getChildren)와 그룹 해제(ungroup)를 제공하며, 위치·크기·정렬·순서는 BaseShape 공통 API 를 그대로 쓴다.
2175
-
2176
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2177
-
2178
- | 기능 | 설명 | 입력 | 결과 |
2179
- |---|---|---|---|
2180
- | `getChildren` | 그룹의 자식 도형 목록을 반환한다. | — | 자식 도형 목록. 그룹 도형이 없으면(협업 중 삭제 등) 빈 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2181
- | `ungroup` | 그룹을 해제하여 자식 도형을 슬라이드 최상위로 분리한다.<br>해제 후 이 Group 인스턴스와 미리 얻어 둔 자식 프록시는 무효가 된다 (자식이 새 id 를 받는다). | — | 분리된 자식 도형 배열<br>`(Shape \| Image \| Line \| Group \| Chart \| Table \| Diagram \| OleObject \| Control)[]` |
2182
-
2183
- <a id="show-image"></a>
2184
- ### Image — 이미지 (`Image`)
2185
-
2186
- 이미지 도형을 다루는 핸들로, 원본 크기 되돌리기(resetSize)와 이미지 자르기 조회·설정(getCrop/setCrop)을 제공하며, 위치·크기·채우기·선·효과는 BasePathShape 공통 API 를 그대로 쓴다.
2187
-
2188
- > 📎 [**BasePathShape**](#show-basepathshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2189
-
2190
- | 기능 | 설명 | 입력 | 결과 |
2191
- |---|---|---|---|
2192
- | `getCrop` | 이미지에 적용된 자르기(crop) 상태를 반환한다. (setCrop 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>모든 값의 단위는 퍼센트다 (-100~100). 자르지 않은 방향은 0 이고, 음수는 바깥 여백이다. | — | 자르기 상태. 대상 이미지가 없으면 null<br>[`ImageCrop`](#show-imagecrop) (없을 수 있음) |
2193
- | `resetSize` | 이미지를 문서에 실린 원본 크기로 되돌린다. 자르기(crop)가 있으면 함께 제거한다. | — | — |
2194
- | `setCrop` | 이미지를 지정한 방향으로 자른다. (getCrop 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>지정한 방향만 적용하고 생략한 방향은 기존 값을 유지한다. 자르기를 없애려면 0 을 명시한다.<br>모든 값의 단위는 퍼센트다 (-100~100). 양수는 그 방향을 잘라 내고, 음수는 바깥 여백을 만든다.<br>병합 결과가 지금 값과 같으면 아무것도 하지 않는다. | `crop` `Partial<ImageCrop>` — 자르기 설정 | — |
2195
-
2196
- <a id="show-line"></a>
2197
- ### Line — 선 (`Line`)
2198
-
2199
- 연결선을 다루는 핸들로, 시작·끝 화살표 조회·설정(getHeadEnd/getTailEnd/setHeadEnd/setTailEnd)을 제공하고 선 색·두께·점선 등 선 서식은 BasePathShape 공통 API 를 그대로 쓰며, 회전·반전은 지원하지 않아(에디터 UI 도 같은 제약) 물려받은 setRotation/flip 은 액션을 만들지 않고 무시된다.
2200
-
2201
- > 📎 [**BasePathShape**](#show-basepathshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2202
-
2203
- | 기능 | 설명 | 입력 | 결과 |
2204
- |---|---|---|---|
2205
- | `getHeadEnd` | 연결선의 시작 화살표(headEnd)를 반환한다. (setHeadEnd 대칭 - 반환 객체를 그대로 넘길 수 있다) | — | 시작 화살표 설정. 대상 연결선이 없으면 null. 화살표가 없는 상태는 null 이 아니라 type 이 LineEndType.NONE 인 객체다<br>[`LineEnd`](#show-lineend) (없을 수 있음) |
2206
- | `getTailEnd` | 연결선의 끝 화살표(tailEnd)를 반환한다. (setTailEnd 대칭 - 반환 객체를 그대로 넘길 수 있다) | — | 끝 화살표 설정. 대상 연결선이 없으면 null. 화살표가 없는 상태는 null 이 아니라 type 이 LineEndType.NONE 인 객체다<br>[`LineEnd`](#show-lineend) (없을 수 있음) |
2207
- | `setHeadEnd` | 연결선의 시작 화살표(headEnd)를 설정한다. (getHeadEnd 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>화살표를 없애려면 type 에 LineEndType.NONE 을 준다.<br>width/length 를 생략하면 기존 크기가 아니라 기본값(MEDIUM)이 적용된다. | `lineEnd` `Partial<LineEnd> & {type: LineEndType}` — 화살표 설정 | — |
2208
- | `setTailEnd` | 연결선의 끝 화살표(tailEnd)를 설정한다. (getTailEnd 대칭 - 반환 객체를 그대로 넘길 수 있다)<br>화살표를 없애려면 type 에 LineEndType.NONE 을 준다.<br>width/length 를 생략하면 기존 크기가 아니라 기본값(MEDIUM)이 적용된다. | `lineEnd` `Partial<LineEnd> & {type: LineEndType}` — 화살표 설정 | — |
2209
-
2210
- <a id="show-oleobject"></a>
2211
- ### OleObject (`OleObject`)
2212
-
2213
- OLE 개체를 다루는 핸들로, 내용 편집은 지원하지 않으며 위치·크기·정렬·순서 등 BaseShape 공통 API 만 제공한다.
2214
-
2215
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2216
-
2217
- | 기능 | 설명 | 입력 | 결과 |
2218
- |---|---|---|---|
2219
-
2220
- <a id="show-shape"></a>
2221
- ### Shape — 도형 (`Shape`)
2222
-
2223
- 일반 도형과 텍스트 상자를 다루는 핸들로, 텍스트 조회·편집(getText/setText/insertText 등), 글자 서식(setFontStyle/setBold/setFontSize 등), 문단 서식(setAlignH/setLineSpacing/setBulletStyle 등), 텍스트 상자 옵션(setAlignV/setTextboxAutoFit), 도형 모양 조절값(getAdjustValues/setAdjustValue 등)을 제공한다.
2224
-
2225
- > 📎 [**BasePathShape**](#show-basepathshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2226
-
2227
- | 기능 | 설명 | 입력 | 결과 |
2228
- |---|---|---|---|
2229
- | `getParagraphStyle` | 대표 단락(range 가 걸친 첫 단락)의 단락 서식을 반환한다. (setParagraphStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setParagraphStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이라 단락이 직접 지정한 값만 골라낼 수는 없고,<br>같은 단락에 그대로 다시 넘기면 상속값과 같은 속성은 직접 지정으로 남지 않는다.<br>목록 수준은 서식 값이 아니라 상속 프리셋이라 담지 않는다. (getLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 서식. 텍스트/단락 없으면 null<br>[`ParagraphStyle`](#show-paragraphstyle) (없을 수 있음) |
2230
- | `getAlignH` | 대표 단락의 가로 정렬을 반환한다. (setAlignH 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 가로 정렬. 텍스트/단락 없으면 null<br>[`TextAlignH`](#show-textalignh) (없을 수 있음) |
2231
- | `getLineSpacing` | 대표 단락의 줄 간격 값을 반환한다. (setLineSpacing 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2232
- | `getLineSpacingType` | 대표 단락의 줄 간격 유형을 반환한다. (setLineSpacing 의 type 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 유형. 텍스트/단락 없으면 null<br>[`LineSpacingType`](#show-linespacingtype) (없을 수 있음) |
2233
- | `getSpaceBefore` | 대표 단락의 단락 앞 간격(UI "문단 위")을 반환한다. (setSpaceBefore 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 앞 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2234
- | `getSpaceAfter` | 대표 단락의 단락 뒤 간격(UI "문단 아래")을 반환한다. (setSpaceAfter 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 뒤 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2235
- | `getMarginLeft` | 대표 단락의 왼쪽 여백(UI "텍스트 앞")을 반환한다. (setMarginLeft 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 왼쪽 여백 (pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2236
- | `getFirstLineIndent` | 대표 단락의 첫 줄 들여쓰기(UI "첫 줄")를 반환한다. (setFirstLineIndent 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 첫 줄 들여쓰기 (pt, 음수는 내어쓰기). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2237
- | `getLevel` | 대표 단락의 목록 수준을 반환한다. (setLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 목록 수준 (1~9). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2238
- | `getBulletStyle` | 대표 단락의 글머리 기호 스타일을 반환한다. 반환 필드를 풀어서 setBulletStyle(type, subType, startAt) 에 넘길 수 있다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이고, 없는 값(시작 번호)과 되넘길 수 없는 값(프리셋 밖 번호 유형)은 키를 담지 않는다.<br>그림 글머리·프리셋 밖 문자는 조회 전용이라 그대로는 적용되지 않는다. (제약은 setBulletStyle 참조) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글머리 기호 스타일. 텍스트/단락 없으면 null<br>[`BulletStyle`](#show-bulletstyle) (없을 수 있음) |
2239
- | `getText` | 텍스트를 plain text로 반환한다. 문단 사이의 개행은 그대로 들어가지만,<br>마지막 문단을 끝맺는 개행은 글자가 아니라 담지 않는다 (빈 텍스트는 ""). | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (UTF-16 코드 단위 offset) (기본값: 전체 텍스트) | 해당 구간의 텍스트 (plain text). 텍스트 모델이 없거나 빈 구간이면 ""<br>문자열 |
2240
- | `getFontStyle` | 대표 run(range 가 걸친 첫 run)의 글꼴 스타일을 반환한다. (setFontStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setFontStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터/표 스타일 상속까지 반영해 실제 적용된 값이라 run 이 직접 지정한 값만 골라낼 수는 없다. | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 스타일. run/스타일 없으면 빈 객체 `{}`, 대상 텍스트가 없거나(협업 중 삭제 등) 유효하지 않은 구간이면 null<br>[`FontStyle`](#show-fontstyle) (없을 수 있음) |
2241
- | `getBold` | 대표 run 의 굵게 여부를 반환한다. (setBold 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 굵게 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2242
- | `getItalic` | 대표 run 의 기울임 여부를 반환한다. (setItalic 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 기울임 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2243
- | `getUnderline` | 대표 run 의 밑줄 유형을 반환한다. (setUnderline 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 밑줄 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Underline`](#show-underline) (없을 수 있음) |
2244
- | `getStrike` | 대표 run 의 취소선 유형을 반환한다. (setStrike 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 취소선 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Strike`](#show-strike) (없을 수 있음) |
2245
- | `getFontSize` | 대표 run 의 글자 크기(pt)를 반환한다. (setFontSize 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 크기 (pt). 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>숫자 (없을 수 있음) |
2246
- | `getFontFamily` | 대표 run 의 글꼴 이름을 반환한다. (setFontFamily 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 이름. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2247
- | `getTextColor` | 대표 run 의 글자 색상을 반환한다. (setTextColor 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 색상 (hex "#RRGGBB" — scheme color 도 hex 로 풀려서 나온다). solid 채우기가 아니거나 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2248
- | `getTextHyperlink` | 텍스트 구간의 하이퍼링크를 반환한다. (setTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 복사할 수 있다)<br>range 를 주면 그 구간의 첫 글자, range 가 없으면 텍스트의 첫 글자가 속한 run 을 기준으로 한다.<br>도형 자체에 걸린 하이퍼링크는 getHyperlink 로 읽는다. | `range` (선택) [`TextRange`](#show-textrange) — 조회할 텍스트 구간 (기본값: 텍스트 첫 글자) | 하이퍼링크 정보 (getHyperlink 와 같은 Hyperlink 객체). 링크 없음/텍스트 없음/미노출 action 이면 null<br>[`Hyperlink`](#show-hyperlink) (없을 수 있음) |
2249
- | `getTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 반환한다. (setTextboxAutoFit 대칭) | — | 자동 맞춤 유형. 대상 텍스트가 없으면 null<br>[`AutoFitType`](#show-autofittype) (없을 수 있음) |
2250
- | `getAlignV` | 텍스트 세로 정렬을 반환한다. (setAlignV 대칭)<br>TextAlignV 는 TOP 이 0 인 숫자 enum 이라, 값이 있는지는 truthy 검사가 아니라 null 비교로 본다. | — | 세로 정렬. 대상 텍스트가 없으면 null<br>[`TextAlignV`](#show-textalignv) (없을 수 있음) |
2251
- | `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 도 같다) (기본값: 전체 텍스트) | — |
2252
- | `insertText` | 텍스트를 삽입한다.<br>삽입한 글자의 서식은 삽입 지점 바로 앞 글자의 런 서식을 따른다. | `text` 문자열 — 삽입할 텍스트<br>`textOffset` (선택) 숫자 — 삽입 위치 offset (기본값: 텍스트 끝) | — |
2253
- | `setFontStyle` | 글꼴 스타일을 설정한다. 단일 속성은 setBold/setItalic/setFontSize/setFontFamily/setTextColor 사용 권장. | `style` [`FontStyle`](#show-fontstyle) — 글꼴 스타일 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2254
- | `setBold` | 글자를 굵게 설정한다. | `enabled` 참/거짓 — true: 굵게, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2255
- | `setItalic` | 글자 기울임을 설정한다. | `enabled` 참/거짓 — true: 기울임, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2256
- | `setUnderline` | 글자 밑줄을 설정한다. | `underline` [`Underline`](#show-underline) — 밑줄 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2257
- | `setStrike` | 글자 취소선을 설정한다. | `strike` [`Strike`](#show-strike) — 취소선 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2258
- | `setFontSize` | 글자 크기를 설정한다. | `fontSize` 숫자 — pt 단위<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2259
- | `setFontFamily` | 글꼴을 설정한다. | `fontFamily` 문자열 — 글꼴 이름<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2260
- | `setTextColor` | 글자 색상을 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2261
- | `setTextHyperlink` | 텍스트에 하이퍼링크를 설정한다. (getTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 링크를 복사할 수 있다)<br>도형 전체에 링크를 거는 setHyperlink 와 달리 링크가 글자(run) 단위로 걸리며 하이퍼링크 서식으로 표시된다.<br>지원하지 않는 종류나 유효하지 않은 대상(없는 슬라이드 id 등)은 무시한다. | `hyperlink` [`Hyperlink`](#show-hyperlink) — getTextHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2262
- | `removeTextHyperlink` | 텍스트의 하이퍼링크를 제거한다. (도형 자체에 걸린 하이퍼링크는 removeHyperlink) | `range` (선택) [`TextRange`](#show-textrange) — 제거할 텍스트 구간 (기본값: 전체 텍스트) | — |
2263
- | `insertSymbol` | 지정한 offset 위치에 특수문자(symbol)를 삽입한다. | `textOffset` 숫자 — 삽입 위치 offset<br>`symbol` 문자열 — 삽입할 특수문자 | — |
2264
- | `setAlignH` | 텍스트 가로 정렬을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다. | `align` [`TextAlignH`](#show-textalignh) — 가로 정렬<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2265
- | `setParagraphStyle` | 단락 서식을 한 번에 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.<br>값을 준 속성만 바뀐다. null/undefined 는 "변경 없음"으로 무시하며, 지정한 값을 상속 상태로 되돌리는 방법은 아직 없다.<br>단일 속성은 setLineSpacing/setMarginLeft/setFirstLineIndent/setSpaceBefore/setSpaceAfter 사용 권장.<br>목록 수준은 바꿀 때 딸려오는 부수 효과(글머리 기호·글자 크기)가 있어 여기 담지 않는다. (setLevel 참고) | `style` [`ParagraphStyle`](#show-paragraphstyle) — 단락 서식 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2266
- | `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) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2267
- | `setSpaceBefore` | 단락 앞 간격(UI "문단 위")을 설정한다. | `spaceBefore` 숫자 — 단락 앞 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2268
- | `setSpaceAfter` | 단락 뒤 간격(UI "문단 아래")을 설정한다. | `spaceAfter` 숫자 — 단락 뒤 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2269
- | `setMarginLeft` | 단락 전체의 왼쪽 여백(UI "텍스트 앞")을 설정한다. 첫 줄만 들여쓰려면 setFirstLineIndent 를 사용한다. | `marginLeft` 숫자 — 왼쪽 여백 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2270
- | `setFirstLineIndent` | 단락 첫 줄의 들여쓰기(UI "첫 줄")를 설정한다. 둘째 줄부터는 marginLeft 를 따른다.<br>양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음이다.<br>글머리 기호 목록의 계층 깊이를 바꾸려면 setLevel 을 사용한다. | `firstLineIndent` 숫자 — 첫 줄 들여쓰기 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2271
- | `setLevel` | 목록 수준(개요 계층 깊이)을 설정한다. range 가 걸친 단락을 모두 같은 수준으로 맞춘다.<br>pt 단위 들여쓰기(setFirstLineIndent/setMarginLeft)와 달리 수준은 상속 프리셋 선택이라,<br>바꾸면 그 수준의 글머리 기호·글자 크기가 따라오고 marginLeft 는 새 수준의 값으로 덮인다.<br>setMarginLeft 로 지정한 값도 버려지므로 둘을 함께 쓸 때는 setLevel 을 먼저 호출한다. (firstLineIndent 는 유지)<br>대상 텍스트가 허용하는 범위(제목 개체는 1 수준뿐)로 제한한다. | `level` 숫자 — 목록 수준 (1=최상위 ~ 9)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2272
- | `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) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2273
- | `setAlignV` | 텍스트 세로 정렬을 설정한다. (getAlignV 대칭) | `align` [`TextAlignV`](#show-textalignv) — 세로 정렬 | — |
2274
- | `setTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 설정한다. 이미 같은 유형이면 아무것도 하지 않는다. | `autoAlignType` [`AutoFitType`](#show-autofittype) — 자동 맞춤 유형 | — |
2275
- | `getAdjustValues` | 일반 도형에 정의된 조절값과 조절 가능한 범위를 반환한다. 반환된 name 은 조절값 조회와 변경 API 에서 사용한다. | — | 조절값 목록. 대상 도형이 없으면(협업 중 삭제 등) null<br>`AdjustValue[] \| null` |
2276
- | `isFlatTx` | 3D 회전 시 텍스트를 평면으로 유지하는지 반환한다. (setFlatTx 대칭) | — | 텍스트 평면 유지 여부. 대상 도형이 없으면 null<br>`boolean \| null` |
2277
- | `setFlatTx` | 3D 회전 시 텍스트를 평면으로 유지할지 설정한다. (isFlatTx 대칭) | `enabled` 참/거짓 — true 이면 텍스트 평면 유지, false 이면 해제 | — |
2278
- | `setAdjustValue` | 일반 도형의 조절값(adjust value) 하나를 변경한다. 여러 조절값을 함께 변경하려면 setAdjustValues 를 사용한다. | `name` 문자열 — 조절값 이름(getAdjustValues 결과)<br>`value` 숫자 — 조절값. 정수로 반올림되며 허용 범위를 벗어나면 최솟값 또는 최댓값으로 제한됨 (getAdjustValues 의 min/max 가 null 인 경우처럼 범위를 알 수 없으면 제한하지 않는다) | — |
2279
- | `setAdjustValues` | 일반 도형의 여러 조절값(adjust value)을 한 번에 변경한다. | `avList` [`AdjustValueUpdate`](#show-adjustvalueupdate) 목록 — 변경할 조절값 목록 | — |
2280
-
2281
- <a id="show-table"></a>
2282
- ### Table — 표 (`Table`)
2283
-
2284
- 표 도형을 다루는 핸들로, 셀·행·열 조회와 검색(getCell/getCells/findCells 등), 행·열 삽입·삭제(insertRow/deleteRow/insertCol 등), 셀 병합·해제(mergeCell/unmergeCell), 표 스타일(setStyle/setStyleOption), 행 높이·열 너비 조정(setRowHeight/setColWidth)을 제공한다.
2285
-
2286
- > 📎 [**BaseShape**](#show-baseshape)의 모든 기능을 포함합니다 (아래는 추가 기능).
2287
-
2288
- | 기능 | 설명 | 입력 | 결과 |
2289
- |---|---|---|---|
2290
- | `getRowCount` | 표의 행 개수를 반환한다. | — | 행 개수. 표가 없으면 0<br>숫자 |
2291
- | `getColCount` | 표의 열 개수를 반환한다. | — | 열 개수. 표가 없으면 0<br>숫자 |
2292
- | `getCell` | 지정 좌표의 셀을 반환한다. 병합 영역 내부 좌표를 지정하면 그 병합 영역의 대표 셀을 반환한다. | `row` 숫자 — 행 인덱스 (0-based)<br>`col` 숫자 — 열 인덱스 (0-based) | 해당 셀 (범위를 벗어나면 null)<br>[`TableCell`](#show-tablecell) (없을 수 있음) |
2293
- | `getCells` | 모든 셀을 배열로 반환한다.<br>병합된 셀은 대표 셀 하나만 포함한다. | — | 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2294
- | `findCells` | 조건에 맞는 셀 배열을 반환한다.<br>복수 조건은 AND 로 결합한다. range 는 셀 본체가 범위와 겹치면 매칭된다<br>(병합 대표 셀이 범위 밖에 있어도 셀 일부가 범위 안이면 결과에 포함된다).<br>그 외 조건은 병합된 셀의 대표 셀 좌표/속성 기준으로 평가한다. | `filter` (선택) [`CellFilter`](#show-cellfilter) — 검색 조건. null 도 조건 없음으로 본다 (기본값: 전체 셀) | 조건에 맞는 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2295
- | `getColWidth` | 지정 열의 너비를 반환한다. (setColWidth 대칭) | `colIndex` 숫자 — 열 인덱스 (0-based) | 너비 (px 단위), 범위 밖이면 null<br>숫자 (없을 수 있음) |
2296
- | `getRowHeight` | 지정 행의 높이를 반환한다. (setRowHeight 대칭) | `rowIndex` 숫자 — 행 인덱스 (0-based) | 높이 (px 단위), 범위 밖이면 null<br>숫자 (없을 수 있음) |
2297
- | `getRow` | 지정 행의 셀 배열을 반환한다.<br>병합된 셀은 대표 셀 하나만 포함한다. | `rowIndex` 숫자 — 0-based 행 인덱스 | 해당 행의 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2298
- | `getColumn` | 지정 열의 셀 배열을 반환한다.<br>병합된 셀은 대표 셀 하나만 포함한다. | `colIndex` 숫자 — 0-based 열 인덱스 | 해당 열의 셀 목록<br>[`TableCell`](#show-tablecell) 목록 |
2299
- | `getStyleName` | 표에 적용된 스타일 이름을 반환한다. (setStyle 대칭)<br>반환한 이름은 그대로 setStyle 에 되먹일 수 있다. 다만 문서에만 실려 있고 편집기 갤러리에는<br>없는 스타일이면 doc.getTableStyleNames() 목록에는 나오지 않는다. | — | 표 스타일 이름. 스타일이 없거나 이름이 없는 스타일(문서가 이름을 싣지 않은 경우)이면 null<br>문자열 (없을 수 있음) |
2300
- | `getStyleOption` | 표 스타일 옵션(머리글 행, 줄무늬 행 등)의 활성화 여부를 반환한다. (setStyleOption 대칭) | `option` [`TableStyleOption`](#show-tablestyleoption) — 옵션 유형 (apiConstants.TableStyleOption) | 활성화 여부. 표나 표 속성을 읽을 수 없으면 null<br>`boolean \| null` |
2301
- | `setStyle` | 표 스타일을 변경한다. (getStyleName 대칭) | `styleName` 문자열 — 표 스타일 이름 (doc.getTableStyleNames() 결과) | — |
2302
- | `setStyleOption` | 표 스타일 옵션(머리글 행, 줄무늬 행 등)을 변경한다. (getStyleOption 대칭) | `option` [`TableStyleOption`](#show-tablestyleoption) — 옵션 유형 (apiConstants.TableStyleOption)<br>`enabled` 참/거짓 — 활성화 여부 | — |
2303
- | `mergeCell` | 지정 범위의 셀을 병합한다. | `startRow` 숫자 — 병합 시작 행 인덱스 (0-based)<br>`startCol` 숫자 — 병합 시작 열 인덱스 (0-based)<br>`endRow` 숫자 — 병합 끝 행 인덱스 (0-based, inclusive)<br>`endCol` 숫자 — 병합 끝 열 인덱스 (0-based, inclusive) | — |
2304
- | `unmergeCell` | 지정 범위의 병합된 셀을 해제한다. | `startRow` 숫자 — 해제 시작 행 인덱스 (0-based)<br>`startCol` 숫자 — 해제 시작 열 인덱스 (0-based)<br>`endRow` 숫자 — 해제 끝 행 인덱스 (0-based, inclusive)<br>`endCol` 숫자 — 해제 끝 열 인덱스 (0-based, inclusive) | — |
2305
- | `insertRow` | 기준 행의 위 또는 아래에 행을 삽입한다.<br>새 행은 기준 행의 서식을 상속한다. | `baseRowIndex` 숫자 — 삽입 기준 행 인덱스 (0-based)<br>`position` [`InsertPosition`](#show-insertposition) — InsertPosition.ABOVE \| InsertPosition.BELOW<br>`insertNum` 숫자 — 삽입할 행 개수 | — |
2306
- | `deleteRow` | 지정 범위의 행을 삭제한다. 모든 행을 지울 수는 없다 - 한 행짜리 표에서 그 행을 지우려 하면 오류가 난다.<br>표 자체를 없애려면 Slide.deleteShape 를 쓴다. | `startRow` 숫자 — 삭제 시작 행 인덱스 (0-based)<br>`endRow` 숫자 — 삭제 끝 행 인덱스 (0-based, inclusive) | — |
2307
- | `insertCol` | 기준 열의 왼쪽 또는 오른쪽에 열을 삽입한다.<br>새 열은 기준 열의 서식을 상속한다. | `baseColIndex` 숫자 — 삽입 기준 열 인덱스 (0-based)<br>`position` [`InsertPosition`](#show-insertposition) — InsertPosition.LEFT \| InsertPosition.RIGHT<br>`insertNum` 숫자 — 삽입할 열 개수 | — |
2308
- | `deleteCol` | 지정 범위의 열을 삭제한다. 모든 열을 지울 수는 없다 - 한 열짜리 표에서 그 열을 지우려 하면 오류가 난다.<br>표 자체를 없애려면 Slide.deleteShape 를 쓴다. | `startCol` 숫자 — 삭제 시작 열 인덱스 (0-based)<br>`endCol` 숫자 — 삭제 끝 열 인덱스 (0-based, inclusive) | — |
2309
- | `setRowHeight` | 지정 행의 높이를 변경한다. | `rowIndex` 숫자 — 행 인덱스 (0-based)<br>`newHeight` 숫자 — 새 높이 (px 단위). rowIndex 가 표의 행 수를 벗어나면 무시된다 | — |
2310
- | `setColWidth` | 지정 열의 너비를 변경한다. | `colIndex` 숫자 — 열 인덱스 (0-based)<br>`newWidth` 숫자 — 새 너비 (px 단위). colIndex 가 표의 열 수를 벗어나면 무시된다 | — |
2311
-
2312
- <a id="show-tablecell"></a>
2313
- ### TableCell — 표 셀 (`TableCell`)
2314
-
2315
- 표 셀 하나를 다루는 핸들로, 셀 텍스트 조회·편집과 글자·문단 서식(getText/setText/setFontStyle 등), 셀 배경 채우기(setSolidFill/setFill), 테두리(getBorderStyle/setBorderStyle), 행·열 위치 조회(getRowIndex/getColIndex)를 제공한다.
2316
-
2317
- | 기능 | 설명 | 입력 | 결과 |
2318
- |---|---|---|---|
2319
- | `isShape` | 이 핸들이 `Shape` 인지 판별한다 (union 좁히기용 type guard).<br>SDK 핸들의 내부 판별값을 동기 검사한다 — postMessage 왕복 없음, await 불필요. | — | `this is Shape` |
2320
- | `getParagraphStyle` | 대표 단락(range 가 걸친 첫 단락)의 단락 서식을 반환한다. (setParagraphStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setParagraphStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이라 단락이 직접 지정한 값만 골라낼 수는 없고,<br>같은 단락에 그대로 다시 넘기면 상속값과 같은 속성은 직접 지정으로 남지 않는다.<br>목록 수준은 서식 값이 아니라 상속 프리셋이라 담지 않는다. (getLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 서식. 텍스트/단락 없으면 null<br>[`ParagraphStyle`](#show-paragraphstyle) (없을 수 있음) |
2321
- | `getAlignH` | 대표 단락의 가로 정렬을 반환한다. (setAlignH 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 가로 정렬. 텍스트/단락 없으면 null<br>[`TextAlignH`](#show-textalignh) (없을 수 있음) |
2322
- | `getLineSpacing` | 대표 단락의 줄 간격 값을 반환한다. (setLineSpacing 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2323
- | `getLineSpacingType` | 대표 단락의 줄 간격 유형을 반환한다. (setLineSpacing 의 type 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 줄 간격 유형. 텍스트/단락 없으면 null<br>[`LineSpacingType`](#show-linespacingtype) (없을 수 있음) |
2324
- | `getSpaceBefore` | 대표 단락의 단락 앞 간격(UI "문단 위")을 반환한다. (setSpaceBefore 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 앞 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2325
- | `getSpaceAfter` | 대표 단락의 단락 뒤 간격(UI "문단 아래")을 반환한다. (setSpaceAfter 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 단락 뒤 간격 (pt). 배수(%) 저장/텍스트 없음이면 null<br>숫자 (없을 수 있음) |
2326
- | `getMarginLeft` | 대표 단락의 왼쪽 여백(UI "텍스트 앞")을 반환한다. (setMarginLeft 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 왼쪽 여백 (pt). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2327
- | `getFirstLineIndent` | 대표 단락의 첫 줄 들여쓰기(UI "첫 줄")를 반환한다. (setFirstLineIndent 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 첫 줄 들여쓰기 (pt, 음수는 내어쓰기). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2328
- | `getLevel` | 대표 단락의 목록 수준을 반환한다. (setLevel 대칭) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 목록 수준 (1~9). 텍스트/단락 없으면 null<br>숫자 (없을 수 있음) |
2329
- | `getBulletStyle` | 대표 단락의 글머리 기호 스타일을 반환한다. 반환 필드를 풀어서 setBulletStyle(type, subType, startAt) 에 넘길 수 있다.<br>값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이고, 없는 값(시작 번호)과 되넘길 수 없는 값(프리셋 밖 번호 유형)은 키를 담지 않는다.<br>그림 글머리·프리셋 밖 문자는 조회 전용이라 그대로는 적용되지 않는다. (제약은 setBulletStyle 참조) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글머리 기호 스타일. 텍스트/단락 없으면 null<br>[`BulletStyle`](#show-bulletstyle) (없을 수 있음) |
2330
- | `getText` | 텍스트를 plain text로 반환한다. 문단 사이의 개행은 그대로 들어가지만,<br>마지막 문단을 끝맺는 개행은 글자가 아니라 담지 않는다 (빈 텍스트는 ""). | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (UTF-16 코드 단위 offset) (기본값: 전체 텍스트) | 해당 구간의 텍스트 (plain text). 텍스트 모델이 없거나 빈 구간이면 ""<br>문자열 |
2331
- | `getFontStyle` | 대표 run(range 가 걸친 첫 run)의 글꼴 스타일을 반환한다. (setFontStyle 대칭)<br>반환 객체를 그대로 다른 개체의 setFontStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다.<br>값은 레이아웃/마스터/표 스타일 상속까지 반영해 실제 적용된 값이라 run 이 직접 지정한 값만 골라낼 수는 없다. | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 스타일. run/스타일 없으면 빈 객체 `{}`, 대상 텍스트가 없거나(협업 중 삭제 등) 유효하지 않은 구간이면 null<br>[`FontStyle`](#show-fontstyle) (없을 수 있음) |
2332
- | `getBold` | 대표 run 의 굵게 여부를 반환한다. (setBold 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 굵게 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2333
- | `getItalic` | 대표 run 의 기울임 여부를 반환한다. (setItalic 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 기울임 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>`boolean \| null` |
2334
- | `getUnderline` | 대표 run 의 밑줄 유형을 반환한다. (setUnderline 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 밑줄 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Underline`](#show-underline) (없을 수 있음) |
2335
- | `getStrike` | 대표 run 의 취소선 유형을 반환한다. (setStrike 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 취소선 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>[`Strike`](#show-strike) (없을 수 있음) |
2336
- | `getFontSize` | 대표 run 의 글자 크기(pt)를 반환한다. (setFontSize 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 크기 (pt). 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>숫자 (없을 수 있음) |
2337
- | `getFontFamily` | 대표 run 의 글꼴 이름을 반환한다. (setFontFamily 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글꼴 이름. 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2338
- | `getTextColor` | 대표 run 의 글자 색상을 반환한다. (setTextColor 대칭 — 상속까지 반영된 실제 적용값) | `range` (선택) [`TextRange`](#show-textrange) — 읽을 텍스트 구간 (기본값: 전체 텍스트) | 글자 색상 (hex "#RRGGBB" — scheme color 도 hex 로 풀려서 나온다). solid 채우기가 아니거나 대상 텍스트가 없거나 유효하지 않은 구간이면 null<br>문자열 (없을 수 있음) |
2339
- | `getTextHyperlink` | 텍스트 구간의 하이퍼링크를 반환한다. (setTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 복사할 수 있다)<br>range 를 주면 그 구간의 첫 글자, range 가 없으면 텍스트의 첫 글자가 속한 run 을 기준으로 한다.<br>도형 자체에 걸린 하이퍼링크는 getHyperlink 로 읽는다. | `range` (선택) [`TextRange`](#show-textrange) — 조회할 텍스트 구간 (기본값: 텍스트 첫 글자) | 하이퍼링크 정보 (getHyperlink 와 같은 Hyperlink 객체). 링크 없음/텍스트 없음/미노출 action 이면 null<br>[`Hyperlink`](#show-hyperlink) (없을 수 있음) |
2340
- | `getTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 반환한다. (setTextboxAutoFit 대칭) | — | 자동 맞춤 유형. 대상 텍스트가 없으면 null<br>[`AutoFitType`](#show-autofittype) (없을 수 있음) |
2341
- | `getAlignV` | 텍스트 세로 정렬을 반환한다. (setAlignV 대칭)<br>TextAlignV 는 TOP 이 0 인 숫자 enum 이라, 값이 있는지는 truthy 검사가 아니라 null 비교로 본다. | — | 세로 정렬. 대상 텍스트가 없으면 null<br>[`TextAlignV`](#show-textalignv) (없을 수 있음) |
2342
- | `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 도 같다) (기본값: 전체 텍스트) | — |
2343
- | `insertText` | 텍스트를 삽입한다.<br>삽입한 글자의 서식은 삽입 지점 바로 앞 글자의 런 서식을 따른다. | `text` 문자열 — 삽입할 텍스트<br>`textOffset` (선택) 숫자 — 삽입 위치 offset (기본값: 텍스트 끝) | — |
2344
- | `setFontStyle` | 글꼴 스타일을 설정한다. 단일 속성은 setBold/setItalic/setFontSize/setFontFamily/setTextColor 사용 권장. | `style` [`FontStyle`](#show-fontstyle) — 글꼴 스타일 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2345
- | `setBold` | 글자를 굵게 설정한다. | `enabled` 참/거짓 — true: 굵게, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2346
- | `setItalic` | 글자 기울임을 설정한다. | `enabled` 참/거짓 — true: 기울임, false: 해제<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2347
- | `setUnderline` | 글자 밑줄을 설정한다. | `underline` [`Underline`](#show-underline) — 밑줄 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2348
- | `setStrike` | 글자 취소선을 설정한다. | `strike` [`Strike`](#show-strike) — 취소선 유형<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2349
- | `setFontSize` | 글자 크기를 설정한다. | `fontSize` 숫자 — pt 단위<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2350
- | `setFontFamily` | 글꼴을 설정한다. | `fontFamily` 문자열 — 글꼴 이름<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2351
- | `setTextColor` | 글자 색상을 설정한다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2352
- | `setTextHyperlink` | 텍스트에 하이퍼링크를 설정한다. (getTextHyperlink 대칭 — 반환 객체를 그대로 넘겨 링크를 복사할 수 있다)<br>도형 전체에 링크를 거는 setHyperlink 와 달리 링크가 글자(run) 단위로 걸리며 하이퍼링크 서식으로 표시된다.<br>지원하지 않는 종류나 유효하지 않은 대상(없는 슬라이드 id 등)은 무시한다. | `hyperlink` [`Hyperlink`](#show-hyperlink) — getTextHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2353
- | `removeTextHyperlink` | 텍스트의 하이퍼링크를 제거한다. (도형 자체에 걸린 하이퍼링크는 removeHyperlink) | `range` (선택) [`TextRange`](#show-textrange) — 제거할 텍스트 구간 (기본값: 전체 텍스트) | — |
2354
- | `insertSymbol` | 지정한 offset 위치에 특수문자(symbol)를 삽입한다. | `textOffset` 숫자 — 삽입 위치 offset<br>`symbol` 문자열 — 삽입할 특수문자 | — |
2355
- | `setAlignH` | 텍스트 가로 정렬을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다. | `align` [`TextAlignH`](#show-textalignh) — 가로 정렬<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2356
- | `setParagraphStyle` | 단락 서식을 한 번에 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.<br>값을 준 속성만 바뀐다. null/undefined 는 "변경 없음"으로 무시하며, 지정한 값을 상속 상태로 되돌리는 방법은 아직 없다.<br>단일 속성은 setLineSpacing/setMarginLeft/setFirstLineIndent/setSpaceBefore/setSpaceAfter 사용 권장.<br>목록 수준은 바꿀 때 딸려오는 부수 효과(글머리 기호·글자 크기)가 있어 여기 담지 않는다. (setLevel 참고) | `style` [`ParagraphStyle`](#show-paragraphstyle) — 단락 서식 설정<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2357
- | `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) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2358
- | `setSpaceBefore` | 단락 앞 간격(UI "문단 위")을 설정한다. | `spaceBefore` 숫자 — 단락 앞 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2359
- | `setSpaceAfter` | 단락 뒤 간격(UI "문단 아래")을 설정한다. | `spaceAfter` 숫자 — 단락 뒤 간격 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2360
- | `setMarginLeft` | 단락 전체의 왼쪽 여백(UI "텍스트 앞")을 설정한다. 첫 줄만 들여쓰려면 setFirstLineIndent 를 사용한다. | `marginLeft` 숫자 — 왼쪽 여백 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2361
- | `setFirstLineIndent` | 단락 첫 줄의 들여쓰기(UI "첫 줄")를 설정한다. 둘째 줄부터는 marginLeft 를 따른다.<br>양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음이다.<br>글머리 기호 목록의 계층 깊이를 바꾸려면 setLevel 을 사용한다. | `firstLineIndent` 숫자 — 첫 줄 들여쓰기 (pt)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2362
- | `setLevel` | 목록 수준(개요 계층 깊이)을 설정한다. range 가 걸친 단락을 모두 같은 수준으로 맞춘다.<br>pt 단위 들여쓰기(setFirstLineIndent/setMarginLeft)와 달리 수준은 상속 프리셋 선택이라,<br>바꾸면 그 수준의 글머리 기호·글자 크기가 따라오고 marginLeft 는 새 수준의 값으로 덮인다.<br>setMarginLeft 로 지정한 값도 버려지므로 둘을 함께 쓸 때는 setLevel 을 먼저 호출한다. (firstLineIndent 는 유지)<br>대상 텍스트가 허용하는 범위(제목 개체는 1 수준뿐)로 제한한다. | `level` 숫자 — 목록 수준 (1=최상위 ~ 9)<br>`range` (선택) [`TextRange`](#show-textrange) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2363
- | `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) — 적용할 텍스트 구간 (기본값: 전체 텍스트) | — |
2364
- | `setAlignV` | 텍스트 세로 정렬을 설정한다. (getAlignV 대칭) | `align` [`TextAlignV`](#show-textalignv) — 세로 정렬 | — |
2365
- | `setTextboxAutoFit` | 텍스트 상자 자동 맞춤 유형을 설정한다. 이미 같은 유형이면 아무것도 하지 않는다. | `autoAlignType` [`AutoFitType`](#show-autofittype) — 자동 맞춤 유형 | — |
2366
- | `getRowIndex` | 셀의 행 인덱스를 반환한다. | — | 행 인덱스 (0-based)<br>숫자 |
2367
- | `getColIndex` | 셀의 열 인덱스를 반환한다. | — | 열 인덱스 (0-based)<br>숫자 |
2368
- | `getColSpan` | 셀이 가로로 차지하는 열 수를 반환한다. 병합되지 않았으면 1 이다. | — | 열 병합 수. 표가 없거나 해당 위치에 셀이 없으면 null<br>숫자 (없을 수 있음) |
2369
- | `getRowSpan` | 셀이 세로로 차지하는 행 수를 반환한다. 병합되지 않았으면 1 이다. | — | 행 병합 수. 표가 없거나 해당 위치에 셀이 없으면 null<br>숫자 (없을 수 있음) |
2370
- | `getFill` | 셀에 명시적으로 설정된 배경 채우기를 반환한다. (setSolidFill 대칭)<br>스타일 상속분은 포함하지 않으며(셀에 직접 지정한 채우기만), alpha 는 setSolidFill 과 같은<br>투명도(0~100, 0=불투명)로 반환한다. | — | 채우기 정보. 명시적 fill 없으면 `{ type: FillType.NONE }`, 표가 없으면 null<br>[`Fill`](#show-fill) (없을 수 있음) |
2371
- | `getBorderStyle` | 지정 위치의 셀 테두리 스타일을 반환한다. (setBorderStyle 대칭)<br>ALL 일괄 조회는 지원하지 않는다 - 한 변씩 조회한다. | `position` `Exclude<BorderPosition, "all">` — 테두리 위치 | 테두리 스타일. 해당 위치에 명시적 테두리가 없으면 null<br>[`BorderStyle`](#show-borderstyle) (없을 수 있음) |
2372
- | `deleteText` | 셀 안의 모든 텍스트를 제거한다. | — | — |
2373
- | `setSolidFill` | 셀 배경을 단색으로 채운다. | `color` 문자열 — hex (#RRGGBB) 또는 scheme color<br>`alpha` (선택) 숫자 — 투명도 (0~100, 0=불투명, 100=완전 투명). 생략하면 기존 투명도 유지 | — |
2374
- | `setFill` | getFill() 이 반환한 채우기 객체를 그대로 적용한다. (getFill 대칭 — 셀 채우기 복사)<br>셀 채우기 설정은 단색만 지원한다 — getFill() 이 다른 타입(none/gradient 등)을 돌려준 셀의 값은 되넘길 수 없다. | `fill` `Fill & { type: "solidFill" }` — 적용할 단색 채우기 | — |
2375
- | `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) — 선 대시 유형 | — |
2376
-
2377
- ### 부록 — 입출력 데이터 형식 (Presentation)
2378
-
2379
- <a id="show-slidefilter"></a>
2380
- #### `SlideFilter`
2381
-
2382
- | 항목 | 형식 | 설명 |
2383
- |---|---|---|
2384
- | `indexes` (선택) | 숫자 목록 | 0-based 인덱스 목록 |
2385
- | `isHidden` (선택) | 참/거짓 | 숨김 슬라이드 여부 |
2386
- | `layoutType` (선택) | [`SlideLayoutType`](#show-slidelayouttype) | 레이아웃 종류 |
2387
- | `textContains` (선택) | 문자열 | 슬라이드 내 포함 텍스트 |
2388
- | `hasComment` (선택) | 참/거짓 | 댓글 존재 여부 |
2389
- | `hasTransition` (선택) | 참/거짓 | 전환 효과 존재 여부 |
2390
-
2391
- <a id="show-headerfooterdate"></a>
2392
- #### `HeaderFooterDate`
2393
-
2394
- | 항목 | 형식 | 설명 |
2395
- |---|---|---|
2396
- | `format` (선택) | [`DateFormat`](#show-dateformat) | 자동갱신 날짜 형식 (text 지정 시 무시) (기본값: DateFormat.Datetime1) |
2397
- | `language` (선택) | [`DateLanguage`](#show-datelanguage) | 자동갱신 날짜 언어 (text 지정 시 무시) (기본값: DateLanguage.ENGLISH) |
2398
- | `text` (선택) | 문자열 | 지정 시 고정 텍스트로 처리 (자동갱신 안 함) |
2399
-
2400
- <a id="show-colorscheme"></a>
2401
- #### `ColorScheme`
2402
-
2403
- | 항목 | 형식 | 설명 |
2404
- |---|---|---|
2405
- | `name` | 문자열 | 사용자 정의 색상 테마 이름 |
2406
- | `tb_color_dark_1` | 문자열 | 텍스트/배경 어두운 색 1 (#RRGGBB) |
2407
- | `tb_color_light_1` | 문자열 | 텍스트/배경 밝은 색 1 (#RRGGBB) |
2408
- | `tb_color_dark_2` | 문자열 | 텍스트/배경 어두운 색 2 (#RRGGBB) |
2409
- | `tb_color_light_2` | 문자열 | 텍스트/배경 밝은 색 2 (#RRGGBB) |
2410
- | `accent_1` | 문자열 | 강조 색 1 (#RRGGBB) |
2411
- | `accent_2` | 문자열 | 강조 색 2 (#RRGGBB) |
2412
- | `accent_3` | 문자열 | 강조 색 3 (#RRGGBB) |
2413
- | `accent_4` | 문자열 | 강조 색 4 (#RRGGBB) |
2414
- | `accent_5` | 문자열 | 강조 색 5 (#RRGGBB) |
2415
- | `accent_6` | 문자열 | 강조 색 6 (#RRGGBB) |
2416
- | `hyperlink` | 문자열 | 하이퍼링크 색 (#RRGGBB) |
2417
- | `opened_hyperlink` | 문자열 | 방문한 하이퍼링크 색 (#RRGGBB) |
2418
-
2419
- <a id="show-shapefilter"></a>
2420
- #### `ShapeFilter`
2421
-
2422
- | 항목 | 형식 | 설명 |
2423
- |---|---|---|
2424
- | `excludePlaceholder` (선택) | 참/거짓 | placeholder 제외 여부 |
2425
- | `placeholderType` (선택) | [`PlaceholderType`](#show-placeholdertype) | placeholder 유형 |
2426
- | `shapeType` (선택) | [`ShapeType`](#show-shapetype) | 도형 종류 |
2427
- | `presetId` (선택) | `ShapePreset \| ShapePresetFamily \| string \| (ShapePreset \| ShapePresetFamily \| string)[]` | 도형 프리셋. ShapePreset 값(정확 매칭) 또는 ShapePresetFamily 키(계열 매칭). 배열로 여러 개 지정 가능 |
2428
- | `textContains` (선택) | 문자열 | 도형 텍스트에 포함된 문자열 |
2429
- | `hasText` (선택) | 참/거짓 | 텍스트 존재 여부 |
2430
- | `fillType` (선택) | [`FillType`](#show-filltype) | 채우기 유형 |
2431
- | `fillColor` (선택) | 문자열 | 채우기 색상 (hex) |
2432
- | `hasLine` (선택) | 참/거짓 | 선 존재 여부 |
2433
- | `lineColor` (선택) | 문자열 | 선 색상 (hex) |
2434
- | `position` (선택) | [`GridPosition`](#show-gridposition) | 슬라이드 9등분 기준 위치 |
2435
- | `size` (선택) | [`SizeCategory`](#show-sizecategory) | 슬라이드 대비 상대 크기 |
2436
- | `hasHyperlink` (선택) | 참/거짓 | 하이퍼링크 존재 여부 |
2437
- | `hasEffect` (선택) | 참/거짓 | 효과 적용 여부 |
2438
-
2439
- <a id="show-tablefilter"></a>
2440
- #### `TableFilter`
2441
-
2442
- | 항목 | 형식 | 설명 |
2443
- |---|---|---|
2444
- | `textContains` (선택) | 문자열 | 셀 텍스트에 포함된 문자열 |
2445
- | `rowCount` (선택) | 숫자 | 행 수 |
2446
- | `colCount` (선택) | 숫자 | 열 수 |
2447
-
2448
- <a id="show-commentfilter"></a>
2449
- #### `CommentFilter`
2450
-
2451
- | 항목 | 형식 | 설명 |
2452
- |---|---|---|
2453
- | `textContains` (선택) | 문자열 | 댓글 텍스트에 포함된 문자열 |
2454
- | `isReply` (선택) | 참/거짓 | 답글 여부 |
2455
- | `parentCommentId` (선택) | 문자열 | 특정 부모의 답글만 필터 |
2456
-
2457
- <a id="show-transition"></a>
2458
- #### `Transition`
2459
-
2460
- | 항목 | 형식 | 설명 |
2461
- |---|---|---|
2462
- | `type` | [`TransitionType`](#show-transitiontype) | 전환 효과 종류 |
2463
- | `speed` (선택) | [`SpeedType`](#show-speedtype) | 전환 속도 (기본값: 효과별 기본 속도) |
2464
- | `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 (기본값: 효과별 기본 방향) |
2465
- | `orient` (선택) | [`TransitionEffectDir`](#show-transitioneffectdir) | 분할 방향 (SPLIT 효과 전용: horz\|vert) (기본값: 효과 기본값) |
2466
- | `thruBlack` (선택) | 참/거짓 | 검은 화면을 거쳐 전환 (FADE/CUT 효과 전용) (기본값: false) |
2467
- | `advTm` (선택) | 숫자 | 자동 진행 시간 (s) (기본값: 자동 진행 안 함) |
2468
- | `advClick` (선택) | 참/거짓 | 클릭으로 진행 여부 (기본값: true) |
2469
-
2470
- <a id="show-chartfilter"></a>
2471
- #### `ChartFilter`
2472
-
2473
- | 항목 | 형식 | 설명 |
2474
- |---|---|---|
2475
- | `chartType` (선택) | [`ChartType`](#common-charttype) | 차트 종류 필터 |
2476
-
2477
- <a id="show-commentposition"></a>
2478
- #### `CommentPosition`
2479
-
2480
- | 항목 | 형식 | 설명 |
2481
- |---|---|---|
2482
- | `x` | 숫자 | X 좌표 (px 단위) |
2483
- | `y` | 숫자 | Y 좌표 (px 단위) |
2484
-
2485
- <a id="show-shapetransform"></a>
2486
- #### `ShapeTransform`
2487
-
2488
- | 항목 | 형식 | 설명 |
2489
- |---|---|---|
2490
- | `x` | 숫자 | 좌상단 X 좌표 (px 단위, 반전·회전과 무관한 모델 기준) |
2491
- | `y` | 숫자 | 좌상단 Y 좌표 (px 단위, 반전·회전과 무관한 모델 기준) |
2492
- | `width` | 숫자 | 너비 (px 단위) |
2493
- | `height` | 숫자 | 높이 (px 단위) |
2494
- | `angle` | 숫자 | 회전 각도 (degree) |
2495
-
2496
- <a id="show-hyperlink"></a>
2497
- #### `Hyperlink`
2498
-
2499
- | 항목 | 형식 | 설명 |
2500
- |---|---|---|
2501
- | `type` | [`HyperlinkType`](#show-hyperlinktype) | 하이퍼링크 타입 (url/email/slideJump/showJump/file) |
2502
- | `urlOrEmail` (선택) | 문자열 | url/email 일 때의 대상 (email 은 mailto 접두어 제거) |
2503
- | `slideId` (선택) | 문자열 | slideJump 일 때 대상 슬라이드 id |
2504
- | `showJumpType` (선택) | [`ShowJumpType`](#show-showjumptype) | showJump 일 때 쇼 점프 유형 |
2505
- | `path` (선택) | 문자열 | file 일 때 파일 경로 |
2506
-
2507
- <a id="show-shapemovedistance"></a>
2508
- #### `ShapeMoveDistance`
2509
-
2510
- | 항목 | 형식 | 설명 |
2511
- |---|---|---|
2512
- | `x` (선택) | 숫자 | X 이동량 (px 단위, 양수 = 오른쪽). 생략하면 X 는 이동하지 않음 |
2513
- | `y` (선택) | 숫자 | Y 이동량 (px 단위, 양수 = 아래). 생략하면 Y 는 이동하지 않음 |
2514
-
2515
- <a id="show-fill"></a>
2516
- #### `Fill`
2517
-
2518
- | 항목 | 형식 | 설명 |
2519
- |---|---|---|
2520
- | `type` | [`FillType`](#show-filltype) | 채우기 종류 (apiConstants.FillType). getFill 출력과 findShapes({fillType}) 필터가 같은 어휘를 쓴다 |
2521
- | `color` (선택) | 문자열 | solid: hex "#RRGGBB" 또는 scheme color |
2522
- | `alpha` (선택) | 숫자 | solid/image: 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2523
- | `gradientType` (선택) | [`GradientType`](#show-gradienttype) | gradient: 그라데이션 유형(lin/circle/rect/shape) |
2524
- | `angle` (선택) | 숫자 | gradient: 각도(degree). 조회값은 0.1도 단위이며 [0, 360) 으로 정규화된다(360 은 0) |
2525
- | `stops` (선택) | `{ color: string; pos?: number; alpha?: number }[]` | gradient: 색상 변화점 |
2526
- | `fillMode` (선택) | [`ImageFillMode`](#show-imagefillmode) | image: 이미지 채우기 방식 |
2527
- | `embed` (선택) | 문자열 | image: 같은 문서 안 setFill 왕복용 업로드 리소스 id |
2528
- | `width` (선택) | 숫자 | image: 원본 이미지 너비 (px) |
2529
- | `height` (선택) | 숫자 | image: 원본 이미지 높이 (px) |
2530
- | `offset` (선택) | `{ x: number; y: number }` | image: 바둑판 오프셋 (pt). fillMode=ImageFillMode.TILE 일 때만 존재 |
2531
- | `scale` (선택) | `{ x: number; y: number }` | image: 바둑판 배율 (%). fillMode=ImageFillMode.TILE 일 때만 존재 |
2532
- | `mirror` (선택) | [`ImageTileFlip`](#show-imagetileflip) | image: 바둑판 대칭. fillMode=ImageFillMode.TILE 일 때만 존재 |
2533
- | `align` (선택) | [`RectAlign`](#show-rectalign) | image: 바둑판 정렬 기준점. fillMode=ImageFillMode.TILE 일 때만 존재 |
2534
- | `rotateWithShape` (선택) | 참/거짓 | image: 도형과 함께 회전 여부 (tile/stretch 공통) |
2535
- | `preset` (선택) | [`PatternPreset`](#show-patternpreset) | pattern: 무늬 프리셋 (apiConstants.PatternPreset) |
2536
- | `foreColor` (선택) | 문자열 | pattern: 전경색 (hex "#RRGGBB"/scheme) |
2537
- | `backColor` (선택) | 문자열 | pattern: 배경색 (hex "#RRGGBB"/scheme) |
2538
- | `foreAlpha` (선택) | 숫자 | pattern: 전경색 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2539
- | `backAlpha` (선택) | 숫자 | pattern: 배경색 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2540
-
2541
- <a id="show-linestyle"></a>
2542
- #### `LineStyle`
2543
-
2544
- | 항목 | 형식 | 설명 |
2545
- |---|---|---|
2546
- | `type` | [`FillType`](#show-filltype) | 선 채우기 종류 (apiConstants.FillType). getFill 출력과 같은 어휘 |
2547
- | `color` (선택) | 문자열 (없을 수 있음) | solid: 선 색상 (hex "#RRGGBB"/scheme) |
2548
- | `alpha` (선택) | 숫자 | solid: 투명도 (0~100, 0=불투명). 불투명이면 키를 생략한다 |
2549
- | `gradientType` (선택) | [`GradientType`](#show-gradienttype) | gradient: 그라데이션 유형(lin/circle/rect/shape) |
2550
- | `stops` (선택) | `{ color: string; pos?: number; alpha?: number }[]` | gradient: 색상 변화점 |
2551
- | `angle` (선택) | 숫자 | gradient: 각도(degree). 조회값은 0.1도 단위이며 [0, 360) 으로 정규화된다(360 은 0) |
2552
- | `width` | 숫자 (없을 수 있음) | 선 두께 (pt). 선 없음(noFill)이어도 두께는 그대로 담긴다 |
2553
- | `dash` | [`LineDash`](#common-linedash) (없을 수 있음) | 선 대시 유형 |
2554
- | `cap` | [`LineCap`](#show-linecap) (없을 수 있음) | 선 끝 모양 |
2555
- | `join` | [`LineJoin`](#show-linejoin) (없을 수 있음) | 선 연결(모서리) 유형 |
2556
-
2557
- <a id="show-lineend"></a>
2558
- #### `LineEnd`
2559
-
2560
- | 항목 | 형식 | 설명 |
2561
- |---|---|---|
2562
- | `type` | [`LineEndType`](#show-lineendtype) | 화살표 타입 |
2563
- | `width` | [`LineEndSize`](#show-lineendsize) | 화살표 너비 |
2564
- | `length` | [`LineEndSize`](#show-lineendsize) | 화살표 길이 |
2565
-
2566
- <a id="show-imagecrop"></a>
2567
- #### `ImageCrop`
2568
-
2569
- | 항목 | 형식 | 설명 |
2570
- |---|---|---|
2571
- | `left` | 숫자 | 왼쪽 crop 퍼센트 |
2572
- | `top` | 숫자 | 위쪽 crop 퍼센트 |
2573
- | `right` | 숫자 | 오른쪽 crop 퍼센트 |
2574
- | `bottom` | 숫자 | 아래쪽 crop 퍼센트 |
2575
-
2576
- <a id="show-bulletstyle"></a>
2577
- #### `BulletStyle`
2578
-
2579
- | 항목 | 형식 | 설명 |
2580
- |---|---|---|
2581
- | `type` | [`BulletType`](#show-bullettype) | 글머리 기호 유형 |
2582
- | `subType` (선택) | `NumberedType \| CharType` | BulletType.AUTO_NUM: 번호 매기기 유형, BulletType.CHAR: 글머리 문자 유형 (CharType 7종 프리셋의 문자와 글꼴이 모두 일치할 때만 포함) |
2583
- | `startAt` (선택) | 숫자 | 시작 번호 (BulletType.AUTO_NUM 일 때만 포함) |
2584
- | `char` (선택) | 문자열 | 글머리 문자 원문 (BulletType.CHAR 일 때만 포함. 프리셋 밖의 문자도 그대로 반환) |
2585
-
2586
- <a id="show-outershadow"></a>
2587
- #### `OuterShadow`
2588
-
2589
- | 항목 | 형식 | 설명 |
2590
- |---|---|---|
2591
- | `color` (선택) | 문자열 | hex (#RRGGBB) 또는 scheme color (기본값: "#000000") |
2592
- | `alpha` (선택) | 숫자 | 투명도 (0~100, 0=불투명) (기본값: 50) |
2593
- | `blur` (선택) | 숫자 | 흐림 반경 (pt) (기본값: 6) |
2594
- | `dist` (선택) | 숫자 | 거리 (pt) (기본값: 6) |
2595
- | `dir` (선택) | 숫자 | 방향 (degree) (기본값: 90) |
2596
- | `sx` (선택) | 숫자 | 가로 배율 (%) (기본값: 100) |
2597
- | `sy` (선택) | 숫자 | 세로 배율 (%) (기본값: 100) |
2598
- | `kx` (선택) | 숫자 | 가로 기울임 (degree) (기본값: 0) |
2599
- | `ky` (선택) | 숫자 | 세로 기울임 (degree) (기본값: 0) |
2600
- | `algn` (선택) | [`RectAlign`](#show-rectalign) | 정렬 기준 (기본값: RectAlign.CENTER) |
2601
- | `rotWithShape` (선택) | 참/거짓 | 도형 회전 연동 (기본값: false) |
2602
-
2603
- <a id="show-innershadow"></a>
2604
- #### `InnerShadow`
2605
-
2606
- | 항목 | 형식 | 설명 |
2607
- |---|---|---|
2608
- | `color` (선택) | 문자열 | hex (#RRGGBB) 또는 scheme color (기본값: "#000000") |
2609
- | `alpha` (선택) | 숫자 | 투명도 (0~100, 0=불투명) (기본값: 50) |
2610
- | `blur` (선택) | 숫자 | 흐림 반경 (pt) (기본값: 6) |
2611
- | `dist` (선택) | 숫자 | 거리 (pt) (기본값: 6) |
2612
- | `dir` (선택) | 숫자 | 방향 (degree) (기본값: 90) |
2613
-
2614
- <a id="show-glow"></a>
2615
- #### `Glow`
2616
-
2617
- | 항목 | 형식 | 설명 |
2618
- |---|---|---|
2619
- | `color` (선택) | 문자열 | hex (#RRGGBB) 또는 scheme color (기본값: "#356FFF") |
2620
- | `alpha` (선택) | 숫자 | 투명도 (0~100, 0=불투명) (기본값: 50) |
2621
- | `rad` (선택) | 숫자 | 광선 반경 (pt) (기본값: 10) |
2622
-
2623
- <a id="show-softedge"></a>
2624
- #### `SoftEdge`
2625
-
2626
- | 항목 | 형식 | 설명 |
2627
- |---|---|---|
2628
- | `rad` (선택) | 숫자 | 반경 (pt) (기본값: 5) |
2629
-
2630
- <a id="show-reflection"></a>
2631
- #### `Reflection`
2632
-
2633
- | 항목 | 형식 | 설명 |
2634
- |---|---|---|
2635
- | `blur` (선택) | 숫자 | 흐림 반경 (pt) (기본값: 0.5) |
2636
- | `dist` (선택) | 숫자 | 거리 (pt) (기본값: 0) |
2637
- | `stPos` (선택) | 숫자 | 시작 위치 (0~100). 렌더링에는 반영되지 않는다 (기본값: 0) |
2638
- | `endPos` (선택) | 숫자 | 반사 크기 (0~100) (기본값: 50) |
2639
- | `startAlpha` (선택) | 숫자 | 시작 투명도 (0~100, 0=불투명) (기본값: 50) |
2640
- | `endAlpha` (선택) | 숫자 | 끝 투명도 (0~100, 0=불투명) (기본값: 99.7) |
2641
- | `dir` (선택) | 숫자 | 방향 (degree). 렌더링에는 반영되지 않는다 (기본값: 90) |
2642
- | `fadeDir` (선택) | 숫자 | 페이드 방향 (degree). 렌더링에는 반영되지 않는다 (기본값: 90) |
2643
- | `sx` (선택) | 숫자 | 가로 배율 (%) (기본값: 100) |
2644
- | `sy` (선택) | 숫자 | 세로 배율 (%) (기본값: -100) |
2645
- | `kx` (선택) | 숫자 | 가로 기울임 (degree) (기본값: 0) |
2646
- | `ky` (선택) | 숫자 | 세로 기울임 (degree) (기본값: 0) |
2647
- | `algn` (선택) | [`RectAlign`](#show-rectalign) | 정렬 기준 (기본값: RectAlign.BOTTOM_LEFT) |
2648
- | `rotWithShape` (선택) | 참/거짓 | 도형 회전 연동 (기본값: false) |
2649
-
2650
- <a id="show-effects"></a>
2651
- #### `Effects`
2652
-
2653
- | 항목 | 형식 | 설명 |
2654
- |---|---|---|
2655
- | `outerShadow` (선택) | [`OuterShadow`](#show-outershadow) | 외부 그림자 |
2656
- | `innerShadow` (선택) | [`InnerShadow`](#show-innershadow) | 내부 그림자 |
2657
- | `glow` (선택) | [`Glow`](#show-glow) | 네온(광선) |
2658
- | `softEdge` (선택) | [`SoftEdge`](#show-softedge) | 옅은 테두리 |
2659
- | `reflection` (선택) | [`Reflection`](#show-reflection) | 반사 |
2660
- | `scene3d` (선택) | [`Scene3d`](#show-scene3d) | 카메라(회전) 3D |
2661
- | `sp3d` (선택) | [`Sp3d`](#show-sp3d) | 입체(깊이) 3D |
2662
-
2663
- <a id="show-imagefilldetail"></a>
2664
- #### `ImageFillDetail`
2665
-
2666
- | 항목 | 형식 | 설명 |
2667
- |---|---|---|
2668
- | `offset` (선택) | `{ x?: number; y?: number }` | 바둑판 오프셋 (pt) (기본값: {x: 0, y: 0}) |
2669
- | `scale` (선택) | `{ x?: number; y?: number }` | 바둑판 배율 (%) (기본값: {x: 100, y: 100}) |
2670
- | `mirror` (선택) | [`ImageTileFlip`](#show-imagetileflip) | 바둑판 대칭 (기본값: ImageTileFlip.NONE) |
2671
- | `align` (선택) | [`RectAlign`](#show-rectalign) | 바둑판 정렬 기준점 (기본값: RectAlign.TOP_LEFT) |
2672
- | `rotateWithShape` (선택) | 참/거짓 | 도형과 함께 회전 여부. 생략하면 기존 동작 유지 (모델 기본 true) |
2673
-
2674
- <a id="show-scene3d"></a>
2675
- #### `Scene3d`
2676
-
2677
- | 항목 | 형식 | 설명 |
2678
- |---|---|---|
2679
- | `prst` (선택) | 문자열 | camera 프리셋 (orthographicFront, isometricLeftDown 등) |
2680
- | `x` (선택) | 숫자 | longitude (degree) |
2681
- | `y` (선택) | 숫자 | latitude (degree) |
2682
- | `z` (선택) | 숫자 | revolution (degree) |
2683
-
2684
- <a id="show-sp3d"></a>
2685
- #### `Sp3d`
2686
-
2687
- | 항목 | 형식 | 설명 |
2688
- |---|---|---|
2689
- | `z` (선택) | 숫자 | z 값 (pt 단위) |
2690
-
2691
- <a id="show-adjustvalue"></a>
2692
- #### `AdjustValue`
2693
-
2694
- | 항목 | 형식 | 설명 |
2695
- |---|---|---|
2696
- | `name` | 문자열 | 조절값 이름 |
2697
- | `value` | 숫자 | 현재 조절값(단위 기준 정수) |
2698
- | `min` | 숫자 (없을 수 있음) | 설정 가능한 최솟값, 범위를 알 수 없으면 null |
2699
- | `max` | 숫자 (없을 수 있음) | 설정 가능한 최댓값, 범위를 알 수 없으면 null |
2700
- | `unit` | 문자열 (없을 수 있음) | 값의 단위 (pct 는 1/1000%, ang 는 1/60000도). 범위를 알 수 없으면 null |
2701
-
2702
- <a id="show-adjustvalueupdate"></a>
2703
- #### `AdjustValueUpdate`
2704
-
2705
- | 항목 | 형식 | 설명 |
2706
- |---|---|---|
2707
- | `name` | 문자열 | 조절값 이름(getAdjustValues 결과) |
2708
- | `value` | 숫자 | 조절값. 정수로 반올림되며 허용 범위를 벗어나면 최솟값 또는 최댓값으로 제한됨 |
2709
-
2710
- <a id="show-cellfilter"></a>
2711
- #### `CellFilter`
2712
-
2713
- | 항목 | 형식 | 설명 |
2714
- |---|---|---|
2715
- | `range` (선택) | `{ startRow: number; startCol: number; endRow: number; endCol: number }` | 셀 범위 (0-based, inclusive) |
2716
- | `rowIndex` (선택) | 숫자 | 특정 행만 (0-based, 대표 셀 기준) |
2717
- | `colIndex` (선택) | 숫자 | 특정 열만 (0-based, 대표 셀 기준) |
2718
- | `isEmpty` (선택) | 참/거짓 | true: 텍스트가 비어 있는 셀, false: 텍스트가 있는 셀 |
2719
- | `isMerged` (선택) | 참/거짓 | true: 병합 대표 셀, false: 단일 셀 |
2720
- | `textContains` (선택) | 문자열 | 셀 텍스트에 포함된 문자열 |
2721
- | `fillColor` (선택) | 문자열 | 셀 배경색 일치 (hex "#RRGGBB", 대소문자 무시, 스타일 상속분 미포함) |
2722
- | `hasFill` (선택) | 참/거짓 | tcPr 에 fill 이 명시적으로 설정됐는지 (스타일 상속분 미포함) |
2723
- | `hasBorder` (선택) | 참/거짓 | tcPr 에 상하좌우 테두리 1개 이상 명시적으로 설정됐는지 (스타일 상속분 미포함) |
2724
-
2725
- <a id="show-borderstyle"></a>
2726
- #### `BorderStyle`
2727
-
2728
- | 항목 | 형식 | 설명 |
2729
- |---|---|---|
2730
- | `color` | 문자열 (없을 수 있음) | 테두리 색상 (hex "#RRGGBB"). 색 없음이면 null |
2731
- | `width` | 숫자 (없을 수 있음) | 선 두께 (pt) |
2732
- | `dash` | [`LineDash`](#common-linedash) (없을 수 있음) | 선 대시 유형 |
2733
-
2734
- <a id="show-textrange"></a>
2735
- #### `TextRange`
2736
-
2737
- | 항목 | 형식 | 설명 |
2738
- |---|---|---|
2739
- | `from` | 숫자 | 시작 글자 offset (0-based) |
2740
- | `to` | 숫자 | 끝 글자 offset (포함) |
2741
-
2742
- <a id="show-fontstyle"></a>
2743
- #### `FontStyle`
2744
-
2745
- | 항목 | 형식 | 설명 |
2746
- |---|---|---|
2747
- | `fontSize` (선택) | 숫자 | 글자 크기 (pt) |
2748
- | `bold` (선택) | 참/거짓 | 굵게 여부 |
2749
- | `italic` (선택) | 참/거짓 | 기울임 여부 |
2750
- | `underline` (선택) | [`Underline`](#show-underline) | 밑줄 유형 |
2751
- | `strike` (선택) | [`Strike`](#show-strike) | 취소선 유형 |
2752
- | `textColor` (선택) | 문자열 | 글자 색상 (hex #RRGGBB 또는 scheme color) |
2753
- | `fontFamily` (선택) | 문자열 | 글꼴 이름 |
2754
- | `baselineShift` (선택) | 숫자 | 기준선 이동 (양수: 위 첨자, 음수: 아래 첨자) |
2755
-
2756
- <a id="show-paragraphstyle"></a>
2757
- #### `ParagraphStyle`
2758
-
2759
- | 항목 | 형식 | 설명 |
2760
- |---|---|---|
2761
- | `alignH` (선택) | [`TextAlignH`](#show-textalignh) | 가로 정렬 |
2762
- | `lineSpacing` (선택) | 숫자 | 줄 간격 값. MULTIPLE 이면 배수 백분율(150=1.5배), EXACT 이면 pt |
2763
- | `lineSpacingType` (선택) | [`LineSpacingType`](#show-linespacingtype) | 줄 간격 유형 (기본값: LineSpacingType.MULTIPLE) |
2764
- | `marginLeft` (선택) | 숫자 | 단락 전체의 왼쪽 여백 (pt) |
2765
- | `firstLineIndent` (선택) | 숫자 | 첫 줄에만 적용되는 들여쓰기 (pt). 양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음 |
2766
- | `spaceBefore` (선택) | 숫자 | 단락 앞 간격 (pt) |
2767
- | `spaceAfter` (선택) | 숫자 | 단락 뒤 간격 (pt) |
2768
-
2769
- ### 부록 — 상수 목록 (Presentation)
2770
-
2771
- <a id="show-shapetype"></a>
2772
- #### `ShapeType`
2773
-
2774
- | 상수 | 값 | 설명 |
2775
- |---|---|---|
2776
- | `SHAPE` | `sp` | — |
2777
- | `IMAGE` | `pic` | — |
2778
- | `CONNECTOR` | `cxnSp` | — |
2779
- | `GROUP` | `grpSp` | — |
2780
- | `CHART` | `chart` | — |
2781
- | `TABLE` | `tbl` | — |
2782
- | `DIAGRAM` | `diagram` | — |
2783
- | `OLE_OBJECT` | `ole` | — |
2784
- | `CONTROL` | `control` | — |
2785
-
2786
- <a id="show-placeholdertype"></a>
2787
- #### `PlaceholderType`
2788
-
2789
- | 상수 | 값 | 설명 |
2790
- |---|---|---|
2791
- | `TITLE` | `title` | — |
2792
- | `CTR_TITLE` | `ctrTitle` | — |
2793
- | `SUB_TITLE` | `subTitle` | — |
2794
- | `BODY` | `body` | — |
2795
- | `OBJECT` | `obj` | — |
2796
- | `CHART` | `chart` | — |
2797
- | `TABLE` | `tbl` | — |
2798
- | `CLIP_ART` | `clipArt` | — |
2799
- | `DIAGRAM` | `dgm` | — |
2800
- | `MEDIA` | `media` | — |
2801
- | `DATE` | `dt` | — |
2802
- | `SLIDE_NUM` | `sldNum` | — |
2803
- | `FOOTER` | `ftr` | — |
2804
- | `HEADER` | `hdr` | — |
2805
- | `PICTURE` | `pic` | — |
2806
- | `SLIDE_IMAGE` | `sldImg` | — |
2807
-
2808
- <a id="show-slidelayouttype"></a>
2809
- #### `SlideLayoutType`
2810
-
2811
- 슬라이드 레이아웃 종류 (OOXML ST_SlideLayoutType).
2812
- setLayout/insertSlide/findSlides 에서 레이아웃을 지정·필터하는 값으로 사용한다.
2813
- 한 마스터에 같은 type 이 여럿일 수 있으며, 이때는 순서상 첫 번째가 선택된다.
2814
-
2815
- | 상수 | 값 | 설명 |
2816
- |---|---|---|
2817
- | `TITLE` | `title` | — |
2818
- | `TX` | `tx` | — |
2819
- | `TWO_COL_TX` | `twoColTx` | — |
2820
- | `TBL` | `tbl` | — |
2821
- | `TX_AND_CHART` | `txAndChart` | — |
2822
- | `CHART_AND_TX` | `chartAndTx` | — |
2823
- | `DGM` | `dgm` | — |
2824
- | `CHART` | `chart` | — |
2825
- | `TX_AND_CLIP_ART` | `txAndClipArt` | — |
2826
- | `CLIP_ART_AND_TX` | `clipArtAndTx` | — |
2827
- | `TITLE_ONLY` | `titleOnly` | — |
2828
- | `BLANK` | `blank` | — |
2829
- | `TX_AND_OBJ` | `txAndObj` | — |
2830
- | `OBJ_AND_TX` | `objAndTx` | — |
2831
- | `OBJ_ONLY` | `objOnly` | — |
2832
- | `OBJ` | `obj` | — |
2833
- | `TX_AND_MEDIA` | `txAndMedia` | — |
2834
- | `MEDIA_AND_TX` | `mediaAndTx` | — |
2835
- | `OBJ_OVER_TX` | `objOverTx` | — |
2836
- | `TX_OVER_OBJ` | `txOverObj` | — |
2837
- | `TX_AND_TWO_OBJ` | `txAndTwoObj` | — |
2838
- | `TWO_OBJ_AND_TX` | `twoObjAndTx` | — |
2839
- | `TWO_OBJ_OVER_TX` | `twoObjOverTx` | — |
2840
- | `FOUR_OBJ` | `fourObj` | — |
2841
- | `VERT_TX` | `vertTx` | — |
2842
- | `CLIP_ART_AND_VERT_TX` | `clipArtAndVertTx` | — |
2843
- | `VERT_TITLE_AND_TX` | `vertTitleAndTx` | — |
2844
- | `VERT_TITLE_AND_TX_OVER_CHART` | `vertTitleAndTxOverChart` | — |
2845
- | `TWO_OBJ` | `twoObj` | — |
2846
- | `OBJ_AND_TWO_OBJ` | `objAndTwoObj` | — |
2847
- | `TWO_OBJ_AND_OBJ` | `twoObjAndObj` | — |
2848
- | `CUST` | `cust` | — |
2849
- | `SEC_HEAD` | `secHead` | — |
2850
- | `TWO_TX_TWO_OBJ` | `twoTxTwoObj` | — |
2851
- | `OBJ_TX` | `objTx` | — |
2852
- | `PIC_TX` | `picTx` | — |
2853
-
2854
- <a id="show-viewmode"></a>
2855
- #### `ViewMode`
2856
-
2857
- 보기 배율/맞춤.
2858
-
2859
- | 상수 | 값 | 설명 |
2860
- |---|---|---|
2861
- | `FIT_IN_WINDOW` | `fitInWindow` | — |
2862
- | `ZOOM_50` | `50` | — |
2863
- | `ZOOM_75` | `75` | — |
2864
- | `ZOOM_100` | `100` | — |
2865
- | `ZOOM_150` | `150` | — |
2866
- | `ZOOM_200` | `200` | — |
2867
- | `ZOOM_300` | `300` | — |
2868
- | `ZOOM_400` | `400` | — |
2869
-
2870
- <a id="show-selectscope"></a>
2871
- #### `SelectScope`
2872
-
2873
- 모두 선택(select_all) 범위.
2874
-
2875
- | 상수 | 값 | 설명 |
2876
- |---|---|---|
2877
- | `SHAPE` | `shape` | — |
2878
- | `SLIDE` | `slide` | — |
2879
- | `TEXT` | `text` | — |
2880
-
2881
- <a id="show-runproperty"></a>
2882
- #### `RunProperty`
2883
-
2884
- | 상수 | 값 | 설명 |
2885
- |---|---|---|
2886
- | `FONT_SIZE` | `fontSize` | — |
2887
- | `BOLD` | `bold` | — |
2888
- | `ITALIC` | `italic` | — |
2889
- | `UNDERLINE` | `underline` | — |
2890
- | `STRIKE` | `strike` | — |
2891
- | `FONT_FAMILY` | `fontFamily` | — |
2892
- | `BASELINE_SHIFT` | `baselineShift` | — |
2893
-
2894
- <a id="show-flipdirection"></a>
2895
- #### `FlipDirection`
2896
-
2897
- | 상수 | 값 | 설명 |
2898
- |---|---|---|
2899
- | `HORIZONTAL` | `horizontal` | — |
2900
- | `VERTICAL` | `vertical` | — |
2901
-
2902
- <a id="show-effecttype"></a>
2903
- #### `EffectType`
2904
-
2905
- | 상수 | 값 | 설명 |
2906
- |---|---|---|
2907
- | `OUTER_SHADOW` | `outerShdw` | — |
2908
- | `INNER_SHADOW` | `innerShdw` | — |
2909
- | `REFLECTION` | `reflection` | — |
2910
- | `GLOW` | `glow` | — |
2911
- | `SOFT_EDGE` | `softEdge` | — |
2912
-
2913
- <a id="show-linecap"></a>
2914
- #### `LineCap`
2915
-
2916
- | 상수 | 값 | 설명 |
2917
- |---|---|---|
2918
- | `FLAT` | `flat` | — |
2919
- | `ROUND` | `rnd` | — |
2920
- | `SQUARE` | `sq` | — |
2921
-
2922
- <a id="show-linejoin"></a>
2923
- #### `LineJoin`
2924
-
2925
- | 상수 | 값 | 설명 |
2926
- |---|---|---|
2927
- | `ROUND` | `round` | — |
2928
- | `BEVEL` | `bevel` | — |
2929
- | `MITER` | `miter` | — |
2930
-
2931
- <a id="show-lineendtype"></a>
2932
- #### `LineEndType`
2933
-
2934
- | 상수 | 값 | 설명 |
2935
- |---|---|---|
2936
- | `NONE` | `none` | — |
2937
- | `TRIANGLE` | `triangle` | — |
2938
- | `STEALTH` | `stealth` | — |
2939
- | `DIAMOND` | `diamond` | — |
2940
- | `OVAL` | `oval` | — |
2941
- | `ARROW` | `arrow` | — |
2942
-
2943
- <a id="show-lineendsize"></a>
2944
- #### `LineEndSize`
2945
-
2946
- | 상수 | 값 | 설명 |
2947
- |---|---|---|
2948
- | `SMALL` | `sm` | — |
2949
- | `MEDIUM` | `med` | — |
2950
- | `LARGE` | `lg` | — |
2951
-
2952
- <a id="show-textalignh"></a>
2953
- #### `TextAlignH`
2954
-
2955
- | 상수 | 값 | 설명 |
2956
- |---|---|---|
2957
- | `LEFT` | `l` | — |
2958
- | `CENTER` | `ctr` | — |
2959
- | `RIGHT` | `r` | — |
2960
- | `JUSTIFY` | `just` | — |
2961
- | `DISTRIBUTE` | `dist` | — |
2962
-
2963
- <a id="show-linespacingtype"></a>
2964
- #### `LineSpacingType`
2965
-
2966
- | 상수 | 값 | 설명 |
2967
- |---|---|---|
2968
- | `MULTIPLE` | `multiple` | — |
2969
- | `EXACT` | `exact` | — |
2970
-
2971
- <a id="show-speedtype"></a>
2972
- #### `SpeedType`
2973
-
2974
- | 상수 | 값 | 설명 |
2975
- |---|---|---|
2976
- | `SLOW` | `slow` | — |
2977
- | `MED` | `med` | — |
2978
- | `FAST` | `fast` | — |
2979
-
2980
- <a id="show-transitiontype"></a>
2981
- #### `TransitionType`
2982
-
2983
- | 상수 | 값 | 설명 |
2984
- |---|---|---|
2985
- | `NONE` | `none` | — |
2986
- | `RANDOM` | `random` | — |
2987
- | `FADE` | `fade` | — |
2988
- | `PUSH` | `push` | — |
2989
- | `COVER` | `cover` | — |
2990
- | `CUT` | `cut` | — |
2991
- | `SPLIT` | `split` | — |
2992
- | `WIPE` | `wipe` | — |
2993
- | `STRIPS` | `strips` | — |
2994
- | `PULL` | `pull` | — |
2995
- | `COMB` | `comb` | — |
2996
- | `CIRCLE` | `circle` | — |
2997
- | `DIAMOND` | `diamond` | — |
2998
- | `PLUS` | `plus` | — |
2999
- | `ZOOM` | `zoom` | — |
3000
- | `WHEEL` | `wheel` | — |
3001
- | `WHEEL_REVERSE` | `wheelReverse` | — |
3002
- | `WEDGE` | `wedge` | — |
3003
- | `FLIP` | `flip` | — |
3004
-
3005
- <a id="show-transitioneffectdir"></a>
3006
- #### `TransitionEffectDir`
3007
-
3008
- | 상수 | 값 | 설명 |
3009
- |---|---|---|
3010
- | `DOWN` | `d` | — |
3011
- | `LEFT` | `l` | — |
3012
- | `RIGHT` | `r` | — |
3013
- | `UP` | `u` | — |
3014
- | `LEFT_DOWN` | `ld` | — |
3015
- | `LEFT_UP` | `lu` | — |
3016
- | `RIGHT_DOWN` | `rd` | — |
3017
- | `RIGHT_UP` | `ru` | — |
3018
- | `IN` | `in` | — |
3019
- | `OUT` | `out` | — |
3020
- | `HORIZONTAL` | `horz` | — |
3021
- | `VERTICAL` | `vert` | — |
3022
-
3023
- <a id="show-dateformat"></a>
3024
- #### `DateFormat`
3025
-
3026
- 머리글/바닥글 날짜 자동갱신(update) 모드의 날짜 표시 형식 (모델 fldType 값).
3027
- 실제 출력 문자열은 언어(DateLanguage)에 따라 달라진다.
3028
- 값은 Const.FldType 에서 파생하며, 날짜 형식이 아닌 SlideNum 과
3029
- datetime1 과 동일한 기본 sentinel 인 DatetimeFigureOut 은 제외한다.
3030
-
3031
- 형식 참고(기본 언어): datetime1=2026-06-30, datetime2=전체 날짜+요일, datetime3=특수 연호,
3032
- datetime4=년 월 일, datetime5=2026/6/30, datetime6=년 월, datetime7=특수 연호 년 월,
3033
- datetime8=날짜+시:분:초, datetime9=날짜+오전/오후 시:분, datetime10=시:분,
3034
- datetime11=시:분:초, datetime12=오전/오후 시:분, datetime13=오전/오후 시:분:초
3035
-
3036
- | 상수 | 값 | 설명 |
3037
- |---|---|---|
3038
- | `Datetime1` | `datetime1` | — |
3039
- | `Datetime2` | `datetime2` | — |
3040
- | `Datetime3` | `datetime3` | — |
3041
- | `Datetime4` | `datetime4` | — |
3042
- | `Datetime5` | `datetime5` | — |
3043
- | `Datetime6` | `datetime6` | — |
3044
- | `Datetime7` | `datetime7` | — |
3045
- | `Datetime8` | `datetime8` | — |
3046
- | `Datetime9` | `datetime9` | — |
3047
- | `Datetime10` | `datetime10` | — |
3048
- | `Datetime11` | `datetime11` | — |
3049
- | `Datetime12` | `datetime12` | — |
3050
- | `Datetime13` | `datetime13` | — |
3051
-
3052
- <a id="show-datelanguage"></a>
3053
- #### `DateLanguage`
3054
-
3055
- | 상수 | 값 | 설명 |
3056
- |---|---|---|
3057
- | `ENGLISH` | `en-US` | — |
3058
- | `KOREAN` | `ko-KR` | — |
3059
- | `JAPANESE` | `ja-JP` | — |
3060
- | `RUSSIAN` | `ru-RU` | — |
3061
-
3062
- <a id="show-bullettype"></a>
3063
- #### `BulletType`
3064
-
3065
- | 상수 | 값 | 설명 |
3066
- |---|---|---|
3067
- | `NONE` | `buNone` | — |
3068
- | `CHAR` | `buChar` | — |
3069
- | `AUTO_NUM` | `buAutoNum` | — |
3070
- | `BLIP` | `buBlip` | — |
3071
-
3072
- <a id="show-underline"></a>
3073
- #### `Underline`
3074
-
3075
- | 상수 | 값 | 설명 |
3076
- |---|---|---|
3077
- | `NONE` | `none` | — |
3078
- | `WORDS` | `words` | — |
3079
- | `SINGLE` | `sng` | — |
3080
- | `DOUBLE` | `dbl` | — |
3081
- | `HEAVY` | `heavy` | — |
3082
- | `DOTTED` | `dotted` | — |
3083
- | `DOTTED_HEAVY` | `dottedHeavy` | — |
3084
- | `DASH` | `dash` | — |
3085
- | `DASH_HEAVY` | `dashHeavy` | — |
3086
- | `DASH_LONG` | `dashLong` | — |
3087
- | `DASH_LONG_HEAVY` | `dashLongHeavy` | — |
3088
- | `DOT_DASH` | `dotDash` | — |
3089
- | `DOT_DASH_HEAVY` | `dotDashHeavy` | — |
3090
- | `DOT_DOT_DASH` | `dotDotDash` | — |
3091
- | `DOT_DOT_DASH_HEAVY` | `dotDotDashHeavy` | — |
3092
- | `WAVY` | `wavy` | — |
3093
- | `WAVY_HEAVY` | `wavyHeavy` | — |
3094
- | `WAVY_DOUBLE` | `wavyDbl` | — |
3095
-
3096
- <a id="show-strike"></a>
3097
- #### `Strike`
3098
-
3099
- | 상수 | 값 | 설명 |
3100
- |---|---|---|
3101
- | `NONE` | `noStrike` | — |
3102
- | `SINGLE` | `sngStrike` | — |
3103
- | `DOUBLE` | `dblStrike` | — |
3104
-
3105
- <a id="show-autofittype"></a>
3106
- #### `AutoFitType`
3107
-
3108
- | 상수 | 값 | 설명 |
3109
- |---|---|---|
3110
- | `NO_AUTOFIT` | `noAutofit` | — |
3111
- | `NORMAL` | `normAutofit` | — |
3112
- | `SHAPE_AUTOFIT` | `spAutoFit` | — |
3113
-
3114
- <a id="show-writemode"></a>
3115
- #### `WriteMode`
3116
-
3117
- | 상수 | 값 | 설명 |
3118
- |---|---|---|
3119
- | `HORIZONTAL` | `horz` | — |
3120
- | `VERTICAL_EAST` | `eaVert` | — |
3121
- | `VERTICAL` | `vert` | — |
3122
- | `VERTICAL_270` | `vert270` | — |
3123
- | `WORDART_VERTICAL_RTL` | `wordArtVertRtl` | — |
3124
- | `WORDART_VERTICAL` | `wordArtVert` | — |
3125
- | `MONGOLIAN_VERTICAL` | `mongolianVert` | — |
3126
-
3127
- <a id="show-textalignv"></a>
3128
- #### `TextAlignV`
3129
-
3130
- | 상수 | 값 | 설명 |
3131
- |---|---|---|
3132
- | `TOP` | `0` | — |
3133
- | `MIDDLE` | `1` | — |
3134
- | `BOTTOM` | `2` | — |
3135
- | `TOP_CENTER` | `3` | — |
3136
- | `MIDDLE_CENTER` | `4` | — |
3137
- | `BOTTOM_CENTER` | `5` | — |
3138
-
3139
- <a id="show-numberedtype"></a>
3140
- #### `NumberedType`
3141
-
3142
- 번호 매기기 유형 (BulletType.AUTO_NUM 용).
3143
- 값은 Const.Bullet.Numbered.Type 에서 파생하며, 내부 sentinel 인 NOT_SUPPORTED 는 제외한다.
3144
-
3145
- | 상수 | 값 | 설명 |
3146
- |---|---|---|
3147
- | `NUMBER_WITH_DOT` | `arabicPeriod` | — |
3148
- | `CIRCLE_NUMBER` | `circleNumDbPlain` | — |
3149
- | `ROMAN_NUMERAL_UPPERCASE` | `romanUcPeriod` | — |
3150
- | `UPPERCASE_ALPHABET` | `alphaUcPeriod` | — |
3151
- | `NUMBER_WITH_ROUND_BRACKET` | `arabicParenR` | — |
3152
- | `LOWERCASE_ALPHABET` | `alphaLcPeriod` | — |
3153
- | `CHINESE` | `ea1JpnKorPeriod` | — |
3154
- | `ROMAN_NUMERAL_LOWERCASE` | `romanLcPeriod` | — |
3155
- | `LOWERCASE_ALPHABET_WITH_ROUND_BRACKET` | `alphaLcParenR` | — |
3156
-
3157
- <a id="show-chartype"></a>
3158
- #### `CharType`
3159
-
3160
- 글머리 문자 스타일 (BulletType.CHAR 용, Const.Bullet.Char.InfoMap 의 키와 동일)
3161
-
3162
- | 상수 | 값 | 설명 |
3163
- |---|---|---|
3164
- | `DOT` | `1` | — |
3165
- | `DIAMOND` | `2` | — |
3166
- | `SQUARE` | `3` | — |
3167
- | `CIRCLE` | `4` | — |
3168
- | `FOUR_DIAMONDS` | `5` | — |
3169
- | `ARROW` | `6` | — |
3170
- | `CHECK` | `7` | — |
3171
-
3172
- <a id="show-hyperlinktype"></a>
3173
- #### `HyperlinkType`
3174
-
3175
- | 상수 | 값 | 설명 |
3176
- |---|---|---|
3177
- | `URL` | `url` | — |
3178
- | `EMAIL` | `email` | — |
3179
- | `SLIDE_JUMP` | `slideJump` | — |
3180
- | `SHOW_JUMP` | `showJump` | — |
3181
- | `FILE` | `file` | — |
3182
-
3183
- <a id="show-showjumptype"></a>
3184
- #### `ShowJumpType`
3185
-
3186
- | 상수 | 값 | 설명 |
3187
- |---|---|---|
3188
- | `FIRST` | `first` | — |
3189
- | `LAST` | `last` | — |
3190
- | `NEXT` | `next` | — |
3191
- | `PREV` | `prev` | — |
3192
- | `EXIT` | `endShow` | — |
3193
- | `LAST_VIEWED` | `lastSlideViewed` | — |
3194
-
3195
- <a id="show-gradienttype"></a>
3196
- #### `GradientType`
3197
-
3198
- | 상수 | 값 | 설명 |
3199
- |---|---|---|
3200
- | `LINEAR` | `lin` | — |
3201
- | `CIRCLE` | `circle` | — |
3202
- | `RECT` | `rect` | — |
3203
- | `SHAPE` | `shape` | — |
3204
-
3205
- <a id="show-filltype"></a>
3206
- #### `FillType`
3207
-
3208
- | 상수 | 값 | 설명 |
3209
- |---|---|---|
3210
- | `SOLID` | `solidFill` | — |
3211
- | `GRADIENT` | `gradFill` | — |
3212
- | `NONE` | `noFill` | — |
3213
- | `IMAGE` | `blipFill` | — |
3214
- | `PATTERN` | `pattFill` | — |
3215
-
3216
- <a id="show-imagefillmode"></a>
3217
- #### `ImageFillMode`
3218
-
3219
- | 상수 | 값 | 설명 |
3220
- |---|---|---|
3221
- | `STRETCH` | `stretch` | — |
3222
- | `TILE` | `tile` | — |
3223
-
3224
- <a id="show-imagetileflip"></a>
3225
- #### `ImageTileFlip`
3226
-
3227
- | 상수 | 값 | 설명 |
3228
- |---|---|---|
3229
- | `NONE` | `none` | — |
3230
- | `HORIZONTAL` | `x` | — |
3231
- | `VERTICAL` | `y` | — |
3232
- | `BOTH` | `xy` | — |
3233
-
3234
- <a id="show-rectalign"></a>
3235
- #### `RectAlign`
3236
-
3237
- | 상수 | 값 | 설명 |
3238
- |---|---|---|
3239
- | `TOP_LEFT` | `tl` | — |
3240
- | `TOP` | `t` | — |
3241
- | `TOP_RIGHT` | `tr` | — |
3242
- | `LEFT` | `l` | — |
3243
- | `CENTER` | `ctr` | — |
3244
- | `RIGHT` | `r` | — |
3245
- | `BOTTOM_LEFT` | `bl` | — |
3246
- | `BOTTOM` | `b` | — |
3247
- | `BOTTOM_RIGHT` | `br` | — |
3248
-
3249
- <a id="show-patternpreset"></a>
3250
- #### `PatternPreset`
3251
-
3252
- | 상수 | 값 | 설명 |
3253
- |---|---|---|
3254
- | `PERCENT_5` | `pct5` | — |
3255
- | `PERCENT_10` | `pct10` | — |
3256
- | `PERCENT_20` | `pct20` | — |
3257
- | `PERCENT_25` | `pct25` | — |
3258
- | `PERCENT_30` | `pct30` | — |
3259
- | `PERCENT_40` | `pct40` | — |
3260
- | `PERCENT_50` | `pct50` | — |
3261
- | `PERCENT_60` | `pct60` | — |
3262
- | `PERCENT_70` | `pct70` | — |
3263
- | `PERCENT_75` | `pct75` | — |
3264
- | `PERCENT_80` | `pct80` | — |
3265
- | `PERCENT_90` | `pct90` | — |
3266
- | `LIGHT_DOWNWARD_DIAGONAL` | `ltDnDiag` | — |
3267
- | `LIGHT_UPWARD_DIAGONAL` | `ltUpDiag` | — |
3268
- | `DARK_DOWNWARD_DIAGONAL` | `dkDnDiag` | — |
3269
- | `DARK_UPWARD_DIAGONAL` | `dkUpDiag` | — |
3270
- | `WIDE_DOWNWARD_DIAGONAL` | `wdDnDiag` | — |
3271
- | `WIDE_UPWARD_DIAGONAL` | `wdUpDiag` | — |
3272
- | `LIGHT_VERTICAL` | `ltVert` | — |
3273
- | `LIGHT_HORIZONTAL` | `ltHorz` | — |
3274
- | `NARROW_VERTICAL` | `narVert` | — |
3275
- | `NARROW_HORIZONTAL` | `narHorz` | — |
3276
- | `DARK_VERTICAL` | `dkVert` | — |
3277
- | `DARK_HORIZONTAL` | `dkHorz` | — |
3278
- | `DASHED_DOWNWARD_DIAGONAL` | `dashDnDiag` | — |
3279
- | `DASHED_UPWARD_DIAGONAL` | `dashUpDiag` | — |
3280
- | `DASHED_HORIZONTAL` | `dashHorz` | — |
3281
- | `DASHED_VERTICAL` | `dashVert` | — |
3282
- | `SMALL_CONFETTI` | `smConfetti` | — |
3283
- | `LARGE_CONFETTI` | `lgConfetti` | — |
3284
- | `ZIGZAG` | `zigZag` | — |
3285
- | `WAVE` | `wave` | — |
3286
- | `DIAGONAL_BRICK` | `diagBrick` | — |
3287
- | `HORIZONTAL_BRICK` | `horzBrick` | — |
3288
- | `WEAVE` | `weave` | — |
3289
- | `PLAID` | `plaid` | — |
3290
- | `DIVOT` | `divot` | — |
3291
- | `DOTTED_GRID` | `dotGrid` | — |
3292
- | `DOTTED_DIAMOND` | `dotDmnd` | — |
3293
- | `SHINGLE` | `shingle` | — |
3294
- | `TRELLIS` | `trellis` | — |
3295
- | `SPHERE` | `sphere` | — |
3296
- | `SMALL_GRID` | `smGrid` | — |
3297
- | `LARGE_GRID` | `lgGrid` | — |
3298
- | `SMALL_CHECKER_BOARD` | `smCheck` | — |
3299
- | `LARGE_CHECKER_BOARD` | `lgCheck` | — |
3300
- | `OUTLINED_DIAMOND` | `openDmnd` | — |
3301
- | `SOLID_DIAMOND` | `solidDmnd` | — |
3302
- | `HORIZONTAL` | `horz` | — |
3303
- | `VERTICAL` | `vert` | — |
3304
- | `CROSS` | `cross` | — |
3305
- | `DOWNWARD_DIAGONAL` | `dnDiag` | — |
3306
- | `UPWARD_DIAGONAL` | `upDiag` | — |
3307
- | `DIAGONAL_CROSS` | `diagCross` | — |
3308
-
3309
- <a id="show-aligntype"></a>
3310
- #### `AlignType`
3311
-
3312
- | 상수 | 값 | 설명 |
3313
- |---|---|---|
3314
- | `LEFT` | `left` | — |
3315
- | `CENTER` | `center` | — |
3316
- | `RIGHT` | `right` | — |
3317
- | `TOP` | `top` | — |
3318
- | `MIDDLE` | `middle` | — |
3319
- | `BOTTOM` | `bottom` | — |
3320
-
3321
- <a id="show-distributedirection"></a>
3322
- #### `DistributeDirection`
3323
-
3324
- | 상수 | 값 | 설명 |
3325
- |---|---|---|
3326
- | `HORIZONTAL` | `horizontal` | — |
3327
- | `VERTICAL` | `vertical` | — |
3328
-
3329
- <a id="show-gridposition"></a>
3330
- #### `GridPosition`
3331
-
3332
- | 상수 | 값 | 설명 |
3333
- |---|---|---|
3334
- | `TOP_LEFT` | `top-left` | — |
3335
- | `TOP_CENTER` | `top-center` | — |
3336
- | `TOP_RIGHT` | `top-right` | — |
3337
- | `CENTER_LEFT` | `center-left` | — |
3338
- | `CENTER` | `center` | — |
3339
- | `CENTER_RIGHT` | `center-right` | — |
3340
- | `BOTTOM_LEFT` | `bottom-left` | — |
3341
- | `BOTTOM_CENTER` | `bottom-center` | — |
3342
- | `BOTTOM_RIGHT` | `bottom-right` | — |
3343
-
3344
- <a id="show-sizecategory"></a>
3345
- #### `SizeCategory`
3346
-
3347
- | 상수 | 값 | 설명 |
3348
- |---|---|---|
3349
- | `SMALL` | `small` | — |
3350
- | `MEDIUM` | `medium` | — |
3351
- | `LARGE` | `large` | — |
3352
-
3353
- <a id="show-borderposition"></a>
3354
- #### `BorderPosition`
3355
-
3356
- | 상수 | 값 | 설명 |
3357
- |---|---|---|
3358
- | `TOP` | `top` | — |
3359
- | `BOTTOM` | `bottom` | — |
3360
- | `LEFT` | `left` | — |
3361
- | `RIGHT` | `right` | — |
3362
- | `DIAGONAL_DOWN` | `diagonalDown` | — |
3363
- | `DIAGONAL_UP` | `diagonalUp` | — |
3364
- | `ALL` | `all` | — |
3365
-
3366
- <a id="show-insertposition"></a>
3367
- #### `InsertPosition`
3368
-
3369
- | 상수 | 값 | 설명 |
3370
- |---|---|---|
3371
- | `ABOVE` | `0` | — |
3372
- | `BELOW` | `1` | — |
3373
- | `LEFT` | `2` | — |
3374
- | `RIGHT` | `3` | — |
3375
-
3376
- <a id="show-tablestyleoption"></a>
3377
- #### `TableStyleOption`
3378
-
3379
- | 상수 | 값 | 설명 |
3380
- |---|---|---|
3381
- | `FIRST_ROW` | `0` | — |
3382
- | `LAST_ROW` | `1` | — |
3383
- | `BAND_ROW` | `2` | — |
3384
- | `FIRST_COL` | `3` | — |
3385
- | `LAST_COL` | `4` | — |
3386
- | `BAND_COL` | `5` | — |
3387
-
3388
- <a id="show-tablestylecolor"></a>
3389
- #### `TableStyleColor`
3390
-
3391
- 표 프리셋 스타일 색상 그룹.
3392
-
3393
- | 상수 | 값 | 설명 |
3394
- |---|---|---|
3395
- | `TX1` | `tx1` | — |
3396
- | `ACCENT1` | `accent1` | — |
3397
- | `ACCENT2` | `accent2` | — |
3398
- | `ACCENT3` | `accent3` | — |
3399
- | `ACCENT4` | `accent4` | — |
3400
- | `ACCENT5` | `accent5` | — |
3401
- | `ACCENT6` | `accent6` | — |
3402
-
3403
- <a id="show-tablestyletype"></a>
3404
- #### `TableStyleType`
3405
-
3406
- 표 프리셋 스타일 명도 타입.
3407
-
3408
- | 상수 | 값 | 설명 |
3409
- |---|---|---|
3410
- | `GENERIC1` | `generic1` | — |
3411
- | `GENERIC2` | `generic2` | — |
3412
- | `LIGHT1` | `light1` | — |
3413
- | `LIGHT2` | `light2` | — |
3414
- | `LIGHT3` | `light3` | — |
3415
- | `NORMAL1` | `normal1` | — |
3416
- | `NORMAL2` | `normal2` | — |
3417
- | `NORMAL3` | `normal3` | — |
3418
- | `NORMAL4` | `normal4` | — |
3419
- | `DARK1` | `dark1` | — |
3420
- | `DARK2` | `dark2` | — |
3421
-
3422
- <a id="show-shapepresetfamily"></a>
3423
- #### `ShapePresetFamily`
3424
-
3425
- ShapePreset family 정의 (family ID → preset 목록).
3426
- findShapes 의 presetId 에 family 키("rectangle" 등)를 전달하면 해당 계열 전체를, ShapePreset 값("rect" 등)을 전달하면 그 도형만 매칭한다.
3427
-
3428
- | 상수 | 값 | 설명 |
3429
- |---|---|---|
3430
- | `rectangle` | `["rect", "roundRect", "snip1Rect", "snip2SameRect", "snip2DiagRect", "snipRoundRect", "round1Rect", "round2SameRect", "round2DiagRect"]` | — |
3431
- | `arrow` | `["rightArrow", "leftArrow", "upArrow", "downArrow", "leftRightArrow", "upDownArrow", "quadArrow", "leftRightUpArrow", "bentArrow", "uturnArrow", "leftUpArrow", "bentUpArrow", "curvedRightArrow", "curvedLeftArrow", "curvedUpArrow", "curvedDownArrow", "stripedRightArrow", "notchedRightArrow", "homePlate", "chevron", "rightArrowCallout", "leftArrowCallout", "upArrowCallout", "downArrowCallout", "leftRightArrowCallout", "upDownArrowCallout", "quadArrowCallout", "circularArrow", "leftCircularArrow", "swooshArrow", "leftRightRibbon"]` | — |
3432
- | `basicShape` | `["ellipse", "triangle", "rtTriangle", "parallelogram", "trapezoid", "diamond", "pentagon", "hexagon", "heptagon", "octagon", "decagon", "dodecagon", "pieWedge", "pie", "chord", "teardrop", "frame", "halfFrame", "corner", "diagStripe", "plus", "plaque", "can", "cube", "bevel", "donut", "noSmoking", "blockArc", "foldedCorner", "smileyFace", "heart", "funnel", "gear6", "gear9", "lightningBolt", "sun", "moon", "cloud", "arc", "bracketPair", "bracePair", "leftBracket", "rightBracket", "leftBrace", "rightBrace"]` | — |
3433
- | `star` | `["irregularSeal1", "irregularSeal2", "star4", "star5", "star6", "star7", "star8", "star10", "star12", "star16", "star24", "star32"]` | — |
3434
- | `banner` | `["ribbon2", "ribbon", "ellipseRibbon2", "ellipseRibbon", "verticalScroll", "horizontalScroll", "wave", "doubleWave"]` | — |
3435
- | `callout` | `["wedgeRectCallout", "wedgeRoundRectCallout", "wedgeEllipseCallout", "cloudCallout", "callout1", "callout2", "callout3", "accentCallout1", "accentCallout2", "accentCallout3", "borderCallout1", "borderCallout2", "borderCallout3", "accentBorderCallout1", "accentBorderCallout2", "accentBorderCallout3"]` | — |
3436
- | `flowchart` | `["flowChartProcess", "flowChartAlternateProcess", "flowChartDecision", "flowChartInputOutput", "flowChartPredefinedProcess", "flowChartInternalStorage", "flowChartDocument", "flowChartMultidocument", "flowChartTerminator", "flowChartPreparation", "flowChartManualInput", "flowChartManualOperation", "flowChartConnector", "flowChartOffpageConnector", "flowChartPunchedCard", "flowChartPunchedTape", "flowChartSummingJunction", "flowChartOr", "flowChartCollate", "flowChartSort", "flowChartExtract", "flowChartMerge", "flowChartOnlineStorage", "flowChartDelay", "flowChartMagneticTape", "flowChartMagneticDisk", "flowChartMagneticDrum", "flowChartDisplay"]` | — |
3437
- | `actionButton` | `["actionButtonBackPrevious", "actionButtonForwardNext", "actionButtonBeginning", "actionButtonEnd", "actionButtonHome", "actionButtonInformation", "actionButtonReturn", "actionButtonMovie", "actionButtonDocument", "actionButtonSound", "actionButtonHelp", "actionButtonBlank"]` | — |
3438
- | `equation` | `["mathPlus", "mathMinus", "mathMultiply", "mathDivide", "mathEqual", "mathNotEqual"]` | — |
3439
- | `line` | `["line", "bentConnector3", "curvedConnector3"]` | — |
3440
-
3441
- <a id="mod-common"></a>
3442
- ## Common — 모듈 공통 상수
3443
-
3444
- 모든 모듈(Word·Cell·Show)에서 동일하게 쓰는 공통 상수입니다. SDK 에서 모듈 구분 없이 flat 이름 하나로 import 해서 사용합니다.
3445
-
3446
- ### 부록 — 상수 목록 (Common)
3447
-
3448
- <a id="common-linedash"></a>
3449
- #### `LineDash`
3450
-
3451
- 선 대시(점선) 스타일 (OOXML a:prstDash).
3452
-
3453
- | 상수 | 값 | 설명 |
3454
- |---|---|---|
3455
- | `SOLID` | `solid` | — |
3456
- | `DOT` | `dot` | — |
3457
- | `DASH` | `dash` | — |
3458
- | `LG_DASH` | `lgDash` | — |
3459
- | `DASH_DOT` | `dashDot` | — |
3460
- | `LG_DASH_DOT` | `lgDashDot` | — |
3461
- | `LG_DASH_DOT_DOT` | `lgDashDotDot` | — |
3462
- | `SYS_DASH` | `sysDash` | — |
3463
- | `SYS_DOT` | `sysDot` | — |
3464
- | `SYS_DASH_DOT` | `sysDashDot` | — |
3465
- | `SYS_DASH_DOT_DOT` | `sysDashDotDot` | — |
3466
-
3467
- <a id="common-shapepreset"></a>
3468
- #### `ShapePreset`
3469
-
3470
- 클라이언트가 지원하는 OOXML preset geometry 전체 목록.
3471
- insertShape 의 preset 에 전달해 해당 모양의 도형을 만든다.
3472
-
3473
- | 상수 | 값 | 설명 |
3474
- |---|---|---|
3475
- | `LINE` | `line` | — |
3476
- | `BENT_CONNECTOR` | `bentConnector3` | — |
3477
- | `CURVED_CONNECTOR` | `curvedConnector3` | — |
3478
- | `RECT` | `rect` | — |
3479
- | `ROUND_RECT` | `roundRect` | — |
3480
- | `SNIP_1_RECT` | `snip1Rect` | — |
3481
- | `SNIP_2_SAME_RECT` | `snip2SameRect` | — |
3482
- | `SNIP_2_DIAG_RECT` | `snip2DiagRect` | — |
3483
- | `SNIP_ROUND_RECT` | `snipRoundRect` | — |
3484
- | `ROUND_1_RECT` | `round1Rect` | — |
3485
- | `ROUND_2_SAME_RECT` | `round2SameRect` | — |
3486
- | `ROUND_2_DIAG_RECT` | `round2DiagRect` | — |
3487
- | `ELLIPSE` | `ellipse` | — |
3488
- | `TRIANGLE` | `triangle` | — |
3489
- | `RT_TRIANGLE` | `rtTriangle` | — |
3490
- | `PARALLELOGRAM` | `parallelogram` | — |
3491
- | `TRAPEZOID` | `trapezoid` | — |
3492
- | `DIAMOND` | `diamond` | — |
3493
- | `PENTAGON` | `pentagon` | — |
3494
- | `HEXAGON` | `hexagon` | — |
3495
- | `HEPTAGON` | `heptagon` | — |
3496
- | `OCTAGON` | `octagon` | — |
3497
- | `DECAGON` | `decagon` | — |
3498
- | `DODECAGON` | `dodecagon` | — |
3499
- | `PIE_WEDGE` | `pieWedge` | — |
3500
- | `PIE` | `pie` | — |
3501
- | `CHORD` | `chord` | — |
3502
- | `TEARDROP` | `teardrop` | — |
3503
- | `FRAME` | `frame` | — |
3504
- | `HALF_FRAME` | `halfFrame` | — |
3505
- | `CORNER` | `corner` | — |
3506
- | `DIAG_STRIPE` | `diagStripe` | — |
3507
- | `PLUS` | `plus` | — |
3508
- | `PLAQUE` | `plaque` | — |
3509
- | `CAN` | `can` | — |
3510
- | `CUBE` | `cube` | — |
3511
- | `BEVEL` | `bevel` | — |
3512
- | `DONUT` | `donut` | — |
3513
- | `NO_SMOKING` | `noSmoking` | — |
3514
- | `BLOCK_ARC` | `blockArc` | — |
3515
- | `FOLDED_CORNER` | `foldedCorner` | — |
3516
- | `SMILEY_FACE` | `smileyFace` | — |
3517
- | `HEART` | `heart` | — |
3518
- | `FUNNEL` | `funnel` | — |
3519
- | `GEAR_6` | `gear6` | — |
3520
- | `GEAR_9` | `gear9` | — |
3521
- | `LIGHTNING_BOLT` | `lightningBolt` | — |
3522
- | `SUN` | `sun` | — |
3523
- | `MOON` | `moon` | — |
3524
- | `CLOUD` | `cloud` | — |
3525
- | `ARC` | `arc` | — |
3526
- | `BRACKET_PAIR` | `bracketPair` | — |
3527
- | `BRACE_PAIR` | `bracePair` | — |
3528
- | `LEFT_BRACKET` | `leftBracket` | — |
3529
- | `RIGHT_BRACKET` | `rightBracket` | — |
3530
- | `LEFT_BRACE` | `leftBrace` | — |
3531
- | `RIGHT_BRACE` | `rightBrace` | — |
3532
- | `RIGHT_ARROW` | `rightArrow` | — |
3533
- | `LEFT_ARROW` | `leftArrow` | — |
3534
- | `UP_ARROW` | `upArrow` | — |
3535
- | `DOWN_ARROW` | `downArrow` | — |
3536
- | `LEFT_RIGHT_ARROW` | `leftRightArrow` | — |
3537
- | `UP_DOWN_ARROW` | `upDownArrow` | — |
3538
- | `QUAD_ARROW` | `quadArrow` | — |
3539
- | `LEFT_RIGHT_UP_ARROW` | `leftRightUpArrow` | — |
3540
- | `BENT_ARROW` | `bentArrow` | — |
3541
- | `UTURN_ARROW` | `uturnArrow` | — |
3542
- | `LEFT_UP_ARROW` | `leftUpArrow` | — |
3543
- | `BENT_UP_ARROW` | `bentUpArrow` | — |
3544
- | `CURVED_RIGHT_ARROW` | `curvedRightArrow` | — |
3545
- | `CURVED_LEFT_ARROW` | `curvedLeftArrow` | — |
3546
- | `CURVED_UP_ARROW` | `curvedUpArrow` | — |
3547
- | `CURVED_DOWN_ARROW` | `curvedDownArrow` | — |
3548
- | `STRIPED_RIGHT_ARROW` | `stripedRightArrow` | — |
3549
- | `NOTCHED_RIGHT_ARROW` | `notchedRightArrow` | — |
3550
- | `HOME_PLATE` | `homePlate` | — |
3551
- | `CHEVRON` | `chevron` | — |
3552
- | `RIGHT_ARROW_CALLOUT` | `rightArrowCallout` | — |
3553
- | `LEFT_ARROW_CALLOUT` | `leftArrowCallout` | — |
3554
- | `UP_ARROW_CALLOUT` | `upArrowCallout` | — |
3555
- | `DOWN_ARROW_CALLOUT` | `downArrowCallout` | — |
3556
- | `LEFT_RIGHT_ARROW_CALLOUT` | `leftRightArrowCallout` | — |
3557
- | `UP_DOWN_ARROW_CALLOUT` | `upDownArrowCallout` | — |
3558
- | `QUAD_ARROW_CALLOUT` | `quadArrowCallout` | — |
3559
- | `CIRCULAR_ARROW` | `circularArrow` | — |
3560
- | `LEFT_CIRCULAR_ARROW` | `leftCircularArrow` | — |
3561
- | `SWOOSH_ARROW` | `swooshArrow` | — |
3562
- | `LEFT_RIGHT_RIBBON` | `leftRightRibbon` | — |
3563
- | `IRREGULAR_SEAL_1` | `irregularSeal1` | — |
3564
- | `IRREGULAR_SEAL_2` | `irregularSeal2` | — |
3565
- | `STAR_4` | `star4` | — |
3566
- | `STAR_5` | `star5` | — |
3567
- | `STAR_6` | `star6` | — |
3568
- | `STAR_7` | `star7` | — |
3569
- | `STAR_8` | `star8` | — |
3570
- | `STAR_10` | `star10` | — |
3571
- | `STAR_12` | `star12` | — |
3572
- | `STAR_16` | `star16` | — |
3573
- | `STAR_24` | `star24` | — |
3574
- | `STAR_32` | `star32` | — |
3575
- | `RIBBON_2` | `ribbon2` | — |
3576
- | `RIBBON` | `ribbon` | — |
3577
- | `ELLIPSE_RIBBON_2` | `ellipseRibbon2` | — |
3578
- | `ELLIPSE_RIBBON` | `ellipseRibbon` | — |
3579
- | `VERTICAL_SCROLL` | `verticalScroll` | — |
3580
- | `HORIZONTAL_SCROLL` | `horizontalScroll` | — |
3581
- | `WAVE` | `wave` | — |
3582
- | `DOUBLE_WAVE` | `doubleWave` | — |
3583
- | `WEDGE_RECT_CALLOUT` | `wedgeRectCallout` | — |
3584
- | `WEDGE_ROUND_RECT_CALLOUT` | `wedgeRoundRectCallout` | — |
3585
- | `WEDGE_ELLIPSE_CALLOUT` | `wedgeEllipseCallout` | — |
3586
- | `CLOUD_CALLOUT` | `cloudCallout` | — |
3587
- | `CALLOUT_1` | `callout1` | — |
3588
- | `CALLOUT_2` | `callout2` | — |
3589
- | `CALLOUT_3` | `callout3` | — |
3590
- | `ACCENT_CALLOUT_1` | `accentCallout1` | — |
3591
- | `ACCENT_CALLOUT_2` | `accentCallout2` | — |
3592
- | `ACCENT_CALLOUT_3` | `accentCallout3` | — |
3593
- | `BORDER_CALLOUT_1` | `borderCallout1` | — |
3594
- | `BORDER_CALLOUT_2` | `borderCallout2` | — |
3595
- | `BORDER_CALLOUT_3` | `borderCallout3` | — |
3596
- | `ACCENT_BORDER_CALLOUT_1` | `accentBorderCallout1` | — |
3597
- | `ACCENT_BORDER_CALLOUT_2` | `accentBorderCallout2` | — |
3598
- | `ACCENT_BORDER_CALLOUT_3` | `accentBorderCallout3` | — |
3599
- | `FLOW_CHART_PROCESS` | `flowChartProcess` | — |
3600
- | `FLOW_CHART_ALTERNATE_PROCESS` | `flowChartAlternateProcess` | — |
3601
- | `FLOW_CHART_DECISION` | `flowChartDecision` | — |
3602
- | `FLOW_CHART_INPUT_OUTPUT` | `flowChartInputOutput` | — |
3603
- | `FLOW_CHART_PREDEFINED_PROCESS` | `flowChartPredefinedProcess` | — |
3604
- | `FLOW_CHART_INTERNAL_STORAGE` | `flowChartInternalStorage` | — |
3605
- | `FLOW_CHART_DOCUMENT` | `flowChartDocument` | — |
3606
- | `FLOW_CHART_MULTIDOCUMENT` | `flowChartMultidocument` | — |
3607
- | `FLOW_CHART_TERMINATOR` | `flowChartTerminator` | — |
3608
- | `FLOW_CHART_PREPARATION` | `flowChartPreparation` | — |
3609
- | `FLOW_CHART_MANUAL_INPUT` | `flowChartManualInput` | — |
3610
- | `FLOW_CHART_MANUAL_OPERATION` | `flowChartManualOperation` | — |
3611
- | `FLOW_CHART_CONNECTOR` | `flowChartConnector` | — |
3612
- | `FLOW_CHART_OFFPAGE_CONNECTOR` | `flowChartOffpageConnector` | — |
3613
- | `FLOW_CHART_PUNCHED_CARD` | `flowChartPunchedCard` | — |
3614
- | `FLOW_CHART_PUNCHED_TAPE` | `flowChartPunchedTape` | — |
3615
- | `FLOW_CHART_SUMMING_JUNCTION` | `flowChartSummingJunction` | — |
3616
- | `FLOW_CHART_OR` | `flowChartOr` | — |
3617
- | `FLOW_CHART_COLLATE` | `flowChartCollate` | — |
3618
- | `FLOW_CHART_SORT` | `flowChartSort` | — |
3619
- | `FLOW_CHART_EXTRACT` | `flowChartExtract` | — |
3620
- | `FLOW_CHART_MERGE` | `flowChartMerge` | — |
3621
- | `FLOW_CHART_ONLINE_STORAGE` | `flowChartOnlineStorage` | — |
3622
- | `FLOW_CHART_DELAY` | `flowChartDelay` | — |
3623
- | `FLOW_CHART_MAGNETIC_TAPE` | `flowChartMagneticTape` | — |
3624
- | `FLOW_CHART_MAGNETIC_DISK` | `flowChartMagneticDisk` | — |
3625
- | `FLOW_CHART_MAGNETIC_DRUM` | `flowChartMagneticDrum` | — |
3626
- | `FLOW_CHART_DISPLAY` | `flowChartDisplay` | — |
3627
- | `ACTION_BUTTON_BACK_PREVIOUS` | `actionButtonBackPrevious` | — |
3628
- | `ACTION_BUTTON_FORWARD_NEXT` | `actionButtonForwardNext` | — |
3629
- | `ACTION_BUTTON_BEGINNING` | `actionButtonBeginning` | — |
3630
- | `ACTION_BUTTON_END` | `actionButtonEnd` | — |
3631
- | `ACTION_BUTTON_HOME` | `actionButtonHome` | — |
3632
- | `ACTION_BUTTON_INFORMATION` | `actionButtonInformation` | — |
3633
- | `ACTION_BUTTON_RETURN` | `actionButtonReturn` | — |
3634
- | `ACTION_BUTTON_MOVIE` | `actionButtonMovie` | — |
3635
- | `ACTION_BUTTON_DOCUMENT` | `actionButtonDocument` | — |
3636
- | `ACTION_BUTTON_SOUND` | `actionButtonSound` | — |
3637
- | `ACTION_BUTTON_HELP` | `actionButtonHelp` | — |
3638
- | `ACTION_BUTTON_BLANK` | `actionButtonBlank` | — |
3639
- | `MATH_PLUS` | `mathPlus` | — |
3640
- | `MATH_MINUS` | `mathMinus` | — |
3641
- | `MATH_MULTIPLY` | `mathMultiply` | — |
3642
- | `MATH_DIVIDE` | `mathDivide` | — |
3643
- | `MATH_EQUAL` | `mathEqual` | — |
3644
- | `MATH_NOT_EQUAL` | `mathNotEqual` | — |
3645
-
3646
- <a id="common-shapezorder"></a>
3647
- #### `ShapeZOrder`
3648
-
3649
- 도형 z-order(앞뒤 순서) 변경 종류.
3650
-
3651
- | 상수 | 값 | 설명 |
3652
- |---|---|---|
3653
- | `FRONT` | `front` | 맨 앞으로 |
3654
- | `BACK` | `back` | 맨 뒤로 |
3655
- | `FORWARD` | `forward` | 앞으로 (한 단계) |
3656
- | `BACKWARD` | `backward` | 뒤로 (한 단계) |
3657
-
3658
- <a id="common-charttype"></a>
3659
- #### `ChartType`
3660
-
3661
- addChart/setType 의 chartType. 단순 (type, range) 생성이 가능한 20종만 있으며,
3662
- 그 밖의 종류는 CHART_TYPE_UNSUPPORTED 로 거부된다.
3663
-
3664
- | 상수 | 값 | 설명 |
3665
- |---|---|---|
3666
- | `clusteredColumn` | `clustered_column` | — |
3667
- | `stackedColumn` | `stacked_column` | — |
3668
- | `_3dClusteredColumn` | `3d_clustered_column` | — |
3669
- | `_3dStackedColumn` | `3d_stacked_column` | — |
3670
- | `clusteredBar` | `clustered_bar` | — |
3671
- | `stackedBar` | `stacked_bar` | — |
3672
- | `_3dClusteredBar` | `3d_clustered_bar` | — |
3673
- | `_3dStackedBar` | `3d_stacked_bar` | — |
3674
- | `line` | `line` | — |
3675
- | `pie` | `pie` | — |
3676
- | `_3dPie` | `3d_pie` | — |
3677
- | `explodedPie` | `exploded_pie` | — |
3678
- | `_3dExplodedPie` | `3d_exploded_pie` | — |
3679
- | `scatter` | `scatter` | — |
3680
- | `area` | `area` | — |
3681
- | `stackedArea` | `stacked_area` | — |
3682
- | `_3dArea` | `3d_area` | — |
3683
- | `_3dStackedArea` | `3d_stacked_area` | — |
3684
- | `doughnut` | `doughnut` | — |
3685
- | `radar` | `radar` | — |
3686
-
3687
- <a id="common-chartgridlinetype"></a>
3688
- #### `ChartGridLineType`
3689
-
3690
- setGridLine 의 gridType. "none" 은 해당 축 눈금선 숨김.
3691
-
3692
- | 상수 | 값 | 설명 |
3693
- |---|---|---|
3694
- | `none` | `none` | — |
3695
- | `major` | `major` | — |
3696
- | `minor` | `minor` | — |
3697
- | `majorMinor` | `major_minor` | — |
3698
-
3699
- <a id="common-chartaxis"></a>
3700
- #### `ChartAxis`
3701
-
3702
- setAxisTitle/setGridLine 의 axis — 대상 축을 가리킨다.
3703
-
3704
- | 상수 | 값 | 설명 |
3705
- |---|---|---|
3706
- | `horizontal` | `horizontal` | — |
3707
- | `vertical` | `vertical` | — |
3708
-
3709
- <a id="common-chartlegendposition"></a>
3710
- #### `ChartLegendPosition`
3711
-
3712
- setLegendPosition 의 position. "none" 은 범례 숨김.
3713
-
3714
- | 상수 | 값 | 설명 |
3715
- |---|---|---|
3716
- | `none` | `none` | — |
3717
- | `bottom` | `bottom` | — |
3718
- | `topRight` | `top_right` | — |
3719
- | `top` | `top` | — |
3720
- | `right` | `right` | — |
3721
- | `left` | `left` | — |
3722
-
3723
- <a id="common-chartdatalabelposition"></a>
3724
- #### `ChartDataLabelPosition`
3725
-
3726
- setDataLabelPosition 의 position. "none" 은 숨김.
3727
- 차트 타입별 유효 위치는 부분집합이며 위반 시 CHART_DATALABEL_POSITION_INVALID.
3728
-
3729
- | 상수 | 값 | 설명 |
3730
- |---|---|---|
3731
- | `none` | `none` | — |
3732
- | `center` | `center` | — |
3733
- | `insideEnd` | `inside_end` | — |
3734
- | `insideBase` | `inside_base` | — |
3735
- | `outsideEnd` | `outside_end` | — |
3736
- | `bestFit` | `best_fit` | — |
3737
- | `left` | `left` | — |
3738
- | `right` | `right` | — |
3739
- | `top` | `top` | — |
3740
- | `bottom` | `bottom` | — |