Word.Table
Word.Table은 Word 모듈(Office.word(iframe))의 객체 타입입니다. 메서드 22개.
Word · 객체 타입 14개 · 메서드 259개 · 네임스페이스 Word. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.
비고
- 모듈: Word ·
Office.word(iframe)· 네임스페이스Word - 얻는 방법:
Document.getTable(tableId),Body.insertTable(rows, columns, options),Paragraph.getParentTable(),Paragraph.insertTable(rows, columns, options),Range.insertTable(rows, columns, options),TableRow.getTable(),TableCell.getTable() - 모든 메서드는
Promise를 반환하며, 시그니처는 TypeScript 표기입니다.
메서드
| 메서드 | 설명 |
|---|---|
delete() | 표를 삭제한다. |
deleteColumn(columnIndex) | 열을 삭제한다. |
deleteRow(rowIndex) | 행을 삭제한다. |
distributeColumns(range) | 대상 열들의 너비를 동일하게 맞춘다. |
getCell(rowIndex, columnIndex) | 지정한 위치의 셀을 반환한다. |
getColumnCount() | 병합된 셀이 차지하는 열 수를 포함해 표의 전체 열 개수를 반환한다. |
getId() | 표 ID를 반환한다. |
getRow(rowIndex) | 지정한 위치의 행을 반환한다. |
getRowCount() | 표의 행 개수를 반환한다. |
insertColumn(columnIndex, position) | 기준 열의 왼쪽 또는 오른쪽에 새 열을 삽입한다. |
insertRow(rowIndex, position) | 기준 행의 앞/뒤에 새 행을 삽입한다. |
mergeCells(range) | 셀 범위를 병합한다. |
setAlignment(align) | 페이지 안에서 표의 가로 위치를 설정한다. |
setCellBackgroundColor(range, color) | 셀 범위의 배경색을 설정한다. |
setCellBorder(range, border) | 셀 범위의 테두리를 설정한다. |
setCellPadding(range, padding) | 지정한 셀 범위의 안쪽 여백을 설정한다. |
setCellVerticalAlignment(range, align) | 셀 범위의 세로 정렬을 설정한다. |
setColumnWidths(widths) | 표의 모든 열 너비를 설정한다. |
setRowHeight(height, range) | 대상 행들의 높이를 지정한 값으로 동일하게 맞춘다. |
setRowHeights(heights) | 표의 행 높이를 행별로 설정한다. |
setValues(values) | 여러 셀의 내용을 2차원 배열의 텍스트로 교체한다. |
unmergeCells(range) | 지정한 범위 안의 병합된 셀을 분할한다. |
메서드 상세
delete()
표를 삭제한다.
delete(): Promise<void>;
반환값
Promise<void>
deleteColumn(columnIndex)
열을 삭제한다.
deleteColumn(columnIndex: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
columnIndex | number | 삭제할 열 인덱스(0부터 시작하는) |
반환값
Promise<void>
deleteRow(rowIndex)
행을 삭제한다.
deleteRow(rowIndex: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
rowIndex | number | 삭제할 행 인덱스(0부터 시작하는) |
반환값
Promise<void>
distributeColumns(range)
대상 열들의 너비를 동일하게 맞춘다. - 대상 열의 전체 너비를 유지하면서 균등하게 나누며, 다른 열은 변경하지 않는다.
distributeColumns(range?: CellRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | CellRange | 대상 열 범위(기본 표 전체). 열 구간(col/colSpan)만 사용한다 (기본값: whole table) |
반환값
Promise<void>
getCell(rowIndex, columnIndex)
지정한 위치의 셀을 반환한다.
getCell(rowIndex: number, columnIndex: number): Promise<TableCell>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
rowIndex | number | 행 인덱스(0부터 시작하는) |
columnIndex | number | 열 인덱스(0부터 시작하는) |
반환값
Promise<TableCell> - 해당 행·열 위치의 셀
getColumnCount()
병합된 셀이 차지하는 열 수를 포함해 표의 전체 열 개수를 반환한다.
getColumnCount(): Promise<number>;
반환값
Promise<number> - 병합을 고려한 표의 전체 열 개수
getId()
표 ID를 반환한다.
getId(): Promise<string>;
반환값
Promise<string> - 표 ID
getRow(rowIndex)
지정한 위치의 행을 반환한다.
getRow(rowIndex: number): Promise<TableRow>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
rowIndex | number | 행 인덱스(0부터 시작하는) |
반환값
Promise<TableRow> - 해당 인덱스의 행
getRowCount()
표의 행 개수를 반환한다.
getRowCount(): Promise<number>;
반환값
Promise<number> - 표의 행 개수
insertColumn(columnIndex, position)
기준 열의 왼쪽 또는 오른쪽에 새 열을 삽입한다. - 새 열의 셀은 getCell()에 행·열 인덱스를 전달해 접근한다.
insertColumn(columnIndex: number, position?: InsertAt): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
columnIndex | number | 기준 열 인덱스(0부터 시작하는) |
position (선택) | InsertAt | 삽입 위치 "before"(기준 열 왼쪽) | "after"(기준 열 오른쪽) (기본값: InsertAt.AFTER) |
반환값
Promise<void>
insertRow(rowIndex, position)
기준 행의 앞/뒤에 새 행을 삽입한다.
insertRow(rowIndex: number, position?: InsertAt): Promise<TableRow>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
rowIndex | number | 기준 행 인덱스(0부터 시작하는) |
position (선택) | InsertAt | 삽입 위치 "before"(기준 행 위) | "after"(기준 행 아래) (기본값: InsertAt.AFTER) |
반환값
Promise<TableRow> - 새로 만든 행
mergeCells(range)
셀 범위를 병합한다.
mergeCells(range: CellRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range | CellRange | 대상 셀 범위(앵커 + 개수, rowSpan·colSpan 중 하나 이상 2 이상) |
반환값
Promise<void>
setAlignment(align)
페이지 안에서 표의 가로 위치를 설정한다. - 셀 내용의 가로 정렬은 셀 단락의 setParagraphFormat()으로, 세로 정렬은 setCellVerticalAlignment()로 설정한다.
setAlignment(align: TableAlign): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
align | TableAlign | 가로 위치 "left" | "center" | "right" |
반환값
Promise<void>
setCellBackgroundColor(range, color)
셀 범위의 배경색을 설정한다.
setCellBackgroundColor(range: CellRange, color: string | null): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range | CellRange | 대상 셀 범위(앵커 + 개수) |
color | string | null | 배경색 (16진수 "#RRGGBB", null 또는 "" 이면 제거) |
반환값
Promise<void>
setCellBorder(range, border)
셀 범위의 테두리를 설정한다.
setCellBorder(range: CellRange, border: Border): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range | CellRange | 대상 셀 범위(앵커 + 개수) |
border | Border | 테두리 값(단락/셀/페이지 공용 - 필드 정의는 WordRange.setParagraphBorder 의 Border typedef 참조) |
반환값
Promise<void>
setCellPadding(range, padding)
지정한 셀 범위의 안쪽 여백을 설정한다.
setCellPadding(range: CellRange, padding: Padding): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range | CellRange | 대상 셀 범위(앵커 + 개수) |
padding | Padding | 4방향 여백(pt, 지정한 변만 변경) |
반환값
Promise<void>
setCellVerticalAlignment(range, align)
셀 범위의 세로 정렬을 설정한다.
setCellVerticalAlignment(range: CellRange, align: CellVerticalAlign): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range | CellRange | 대상 셀 범위(앵커 + 개수) |
align | CellVerticalAlign | 세로 정렬 "top" | "center" | "bottom" |
반환값
Promise<void>
setColumnWidths(widths)
표의 모든 열 너비를 설정한다.
배열 길이는 표의 전체 열 개수와 같아야 한다. null인 열은 현재 너비를 유지한다.
최소 너비보다 작은 값은 최소 너비로 보정한다.
setColumnWidths(widths: (number | null)[]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
widths | (number | null)[] | 열 너비(pt) 배열. null 슬롯은 현재 값 유지 |
반환값
Promise<void>
setRowHeight(height, range)
대상 행들의 높이를 지정한 값으로 동일하게 맞춘다.
setRowHeight(height: number, range?: CellRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
height | number | 행 높이(pt, 양수) |
range (선택) | CellRange | 대상 행 범위(기본 표 전체). 행 구간(row/rowSpan)만 사용한다 (기본값: whole table) |
반환값
Promise<void>
setRowHeights(heights)
표의 행 높이를 행별로 설정한다. - 배열 길이는 표의 행 개수와 같아야 한다. null인 행은 현재 높이를 유지한다.
setRowHeights(heights: (number | null)[]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
heights | (number | null)[] | 행 높이(pt) 배열. null 슬롯은 현재 값 유지 |
반환값
Promise<void>
setValues(values)
여러 셀의 내용을 2차원 배열의 텍스트로 교체한다.
values[r][c]를 r행 c열에 넣는다. 배열에 포함되지 않은 셀과 값이 null·undefined인 셀은 유지한다.
배열이 표 크기를 초과하면 오류가 발생한다.
setValues(values: string[][]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
values | string[][] | 행별 값 배열(행마다 열 길이가 달라도 된다) |
반환값
Promise<void>
unmergeCells(range)
지정한 범위 안의 병합된 셀을 분할한다.
unmergeCells(range: CellRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range | CellRange | 대상 셀 범위(단일 셀이면 개수 생략) |
반환값
Promise<void>