Show.Document
Show.Document은 Presentation 모듈(Office.show(iframe))의 객체 타입입니다. 메서드 56개.
Presentation · 객체 타입 10개 · 메서드 586개 · 네임스페이스 Show. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.
비고
- 모듈: Presentation ·
Office.show(iframe)· 네임스페이스Show - 얻는 방법:
app.getDocument()(루트 핸들).Office.show(iframe)이 반환하는 앱 핸들에서 얻습니다. 문서 메서드는 앱 핸들이 아니라 이 핸들에 있습니다. - 모든 메서드는
Promise를 반환하며, 시그니처는 TypeScript 표기입니다.
메서드
메서드 상세
close()
문서를 닫는다. (앱 레벨 동작이므로 Actor 경유)
close(): Promise<void>;
반환값
Promise<void>
createColorScheme(colorScheme)
사용자 정의 색상 테마를 생성하고 현재 문서에 적용한다.
createColorScheme(colorScheme: ColorScheme): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
colorScheme | ColorScheme | 새 색상 테마 정보 |
반환값
Promise<void>
deleteSlide(slideProxy)
슬라이드 하나를 삭제한다.
deleteSlide(slideProxy: Slide): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxy | Slide | 삭제할 슬라이드 |
반환값
Promise<void>
deleteSlides(slideProxyList)
여러 슬라이드를 일괄 삭제한다.
deleteSlides(slideProxyList: Slide[]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 삭제할 슬라이드 배열 |
반환값
Promise<void>
download()
문서를 다운로드한다. (서버 I/O 이므로 Actor 경유)
download(): Promise<void>;
반환값
Promise<void>
downloadAsPdf()
문서를 PDF 로 변환해 다운로드한다. 원본 형식(pptx 등)으로 받으려면 download() 를 사용한다. 요청만 보내고 변환 완료를 기다리지 않는다 - 변환 진행·실패는 앱 상태 UI 가 표시한다. OfficeFilter 사용 시 해당 API 미지원 (미구현) (서버 변환·I/O 이므로 Actor 경유)
downloadAsPdf(): Promise<void>;
반환값
Promise<void>
duplicateSlide(slideProxy)
슬라이드 하나를 복제한다.
duplicateSlide(slideProxy: Slide): Promise<Slide>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxy | Slide | 복제할 슬라이드 |
반환값
Promise<Slide> - 복제된 슬라이드 Proxy
duplicateSlides(slideProxyList)
여러 슬라이드를 일괄 복제한다.
duplicateSlides(slideProxyList: Slide[]): Promise<Slide[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 복제할 슬라이드 배열 |
반환값
Promise<Slide[]> - 복제된 슬라이드 Proxy 배열
findCharts(slides, filter)
여러 슬라이드에서 조건에 맞는 차트를 검색한다.
findCharts(slides: Slide[], filter?: ChartFilter): Promise<Chart[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slides | Slide[] | 검색 대상 슬라이드 |
filter (선택) | ChartFilter | 검색 조건 (Slide.findCharts 와 동일) (기본값: 전체 차트) |
반환값
Promise<Chart[]> - 조건에 맞는 차트 목록
findComments(slides, filter)
여러 슬라이드에서 조건에 맞는 댓글을 검색한다.
findComments(slides: Slide[], filter?: CommentFilter): Promise<Comment[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slides | Slide[] | 검색 대상 슬라이드 |
filter (선택) | CommentFilter | 검색 조건 (Slide.findComments 와 동일) (기본값: 전체 댓글) |
반환값
Promise<Comment[]> - 조건에 맞는 댓글 목록
findShapes(slides, filter)
여러 슬라이드에서 조건에 맞는 도형을 검색한다. 슬라이드별 검색은 Slide.findShapes 와 동일하며, 결과를 슬라이드 순서대로 합친다.
findShapes(slides: Slide[], filter?: ShapeFilter): Promise<Shape[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slides | Slide[] | 검색 대상 슬라이드 |
filter (선택) | ShapeFilter | 검색 조건 (Slide.findShapes 와 동일) (기본값: 전체 도형) |
반환값
Promise<Shape[]> - 조건에 맞는 도형 목록
findSlides(filter)
조건에 맞는 슬라이드를 검색한다.
findSlides(filter?: SlideFilter): Promise<Slide[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
filter (선택) | SlideFilter | 검색 조건 (기본값: 전체 슬라이드) |
반환값
Promise<Slide[]> - 조건에 맞는 슬라이드 목록
findTables(slides, filter)
여러 슬라이드에서 조건에 맞는 표를 검색한다.
findTables(slides: Slide[], filter?: TableFilter): Promise<Table[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slides | Slide[] | 검색 대상 슬라이드 |
filter (선택) | TableFilter | 검색 조건 (Slide.findTables 와 동일) (기본값: 전체 표) |
반환값
Promise<Table[]> - 조건에 맞는 표 목록
findText(query, slideProxyList, caseSensitive)
텍스트를 검색한다. slideProxyList 를 주면 그 슬라이드들만 검색한다. 매치는 문서 순서(슬라이드 → 도형 → 표 셀)로 반환된다. 병합된 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 검색되지 않는다.
findText(
query: string,
slideProxyList?: Slide[],
caseSensitive?: boolean
): Promise<{ target: (TableCell | Shape); range: { from: number; to: number }; text: string }[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
query | string | 찾을 텍스트 |
slideProxyList (선택) | Slide[] | 검색 대상 슬라이드 (기본값: 전체 슬라이드) |
caseSensitive (선택) | boolean | 대소문자 구분 (기본값: false) |
반환값
Promise<{ target: (TableCell | Shape); range: { from: number; to: number }; text: string }[]> - 매치 목록. target 은 표 셀 매치면 TableCell, 아니면 도형 프록시(Shape)이며, range 를 그대로 서식 API 에 넘겨 매치 구간만 편집할 수 있다 (예: m.target.setBold(true, m.range)). range 의 from/to 는 글자 offset(to 포함), text 는 검색 시점의 매치 텍스트다.
getChartStyleList()
차트 프리셋 스타일(112)별 계열 색 팔레트를 현재 슬라이드에 적용된 테마 기준으로 반환한다. set_chart_style 의 style 을 고를 때 참고용. style 은 색 그룹(4) × 배경/선 변형(3) 조합. 색은 그룹으로만 결정되므로 같은 그룹(예: 13)은 colors 가 동일하고, 그룹 내 차이(뒤 1/2/3)는 배경/선 변형(variant)이다. 색은 테마 accent 에 종속 - 테마가 바뀌면 값도 바뀐다.
getChartStyleList(): Promise<{ style: number; colors: string[]; variant: string }[]>;
반환값
Promise<{ style: number; colors: string[]; variant: string }[]> - 차트 스타일 목록. 문서에 슬라이드가 없으면 빈 배열
getColorScheme()
문서의 색상 테마를 반환한다. (setColorScheme 대칭) 현재 슬라이드가 속한 마스터의 테마이며, setSlideColorScheme 으로 준 슬라이드별 재정의는 포함하지 않는다. 슬라이드별 조회는 slide.getColorScheme() 을 사용한다.
getColorScheme(): Promise<{ prst: string | null; name: string; colors: Record<string, unknown> } | null>;
반환값
Promise<{ prst: string | null; name: string; colors: Record<string, unknown> } | null> - 색상 테마 (prst: getColorSchemeList 에 있는 테마일 때만 채워지고 파일에서 읽은 문서 고유 테마면 null, name: 테마 이름, colors: 슬롯 이름 → #RRGGBB). 문서에 슬라이드가 없으면 null
getColorSchemeList()
적용 가능한 색상 테마(빌트인 + 사용자 정의) 목록을 반환한다.
getColorSchemeList(): Promise<{ prst: string; name: string; colors: Record<string, unknown> }[]>;
반환값
Promise<{ prst: string; name: string; colors: Record<string, unknown> }[]> - 색상 테마 목록 (prst: 프리셋 이름, name: 표시 이름, colors: 슬롯 이름 → #RRGGBB)
getCurrentSlide()
현재 보기의 슬라이드를 반환한다.
getCurrentSlide(): Promise<Slide>;
반환값
Promise<Slide> - 현재 슬라이드 (문서에 슬라이드가 없으면 null)
getDocumentInfo()
문서(캔버스) 정보를 반환한다.
getDocumentInfo(): Promise<{ width: number; height: number; slideCount: number }>;
반환값
Promise<{ width: number; height: number; slideCount: number }> - 슬라이드 영역의 가로·세로 크기 (px) 와 전체 슬라이드 수
getFontScheme()
문서의 테마 글꼴을 반환한다. (setFontScheme 대칭)
getFontScheme(): Promise<{ prst: string | null; name: string } | null>;
반환값
Promise<{ prst: string | null; name: string } | null> - 현재 테마 글꼴 (prst: getFontSchemeList 에 있는 테마일 때만 채워지고 목록에 없는 문서 고유 테마면 null, name: 테마 이름). 문서에 슬라이드가 없으면 null
getFontSchemeList()
적용 가능한 테마 글꼴(빌트인 + 사용자 정의) 목록을 반환한다.
getFontSchemeList(): Promise<{ prst: string; name: string }[]>;
반환값
Promise<{ prst: string; name: string }[]> - 테마 글꼴 목록 (prst: 프리셋 이름, name: 표시 이름)
getFormatScheme()
문서의 테마 효과를 반환한다. (setFormatScheme 대칭)
getFormatScheme(): Promise<{ prst: string | null; name: string } | null>;
반환값
Promise<{ prst: string | null; name: string } | null> - 현재 테마 효과 (prst: getFormatSchemeList 에 있는 테마일 때만 채워짐, name: 표시 이름, 목록에 없으면 테마 원본 이름). 문서에 슬라이드가 없으면 null
getFormatSchemeList()
적용 가능한 테마 효과 목록을 반환한다.
getFormatSchemeList(): Promise<{ prst: string; name: string }[]>;
반환값
Promise<{ prst: string; name: string }[]> - 테마 효과 목록 (prst: 프리셋 이름, name: 표시 이름)
getLayoutList(slideProxy)
지정한 슬라이드가 속한 마스터의 레이아웃 목록을 반환한다. 레이아웃은 마스터 단위의 상위 개념이라 문서 레벨에서 조회한다.
getLayoutList(slideProxy: Slide): Promise<{ name: string; type: SlideLayoutType }[]>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxy | Slide | 대상 슬라이드 |
반환값
Promise<{ name: string; type: SlideLayoutType }[]> - 레이아웃 목록 (대상 슬라이드가 없으면 빈 배열 반환)
getSlide(index)
인덱스로 슬라이드를 가져온다.
getSlide(index: number): Promise<Slide>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
index | number | 0-based |
반환값
Promise<Slide> - 해당 슬라이드 (범위를 벗어나면 null)
getSlideCount()
getSlideCount(): Promise<number>;
반환값
Promise<number> - 문서의 전체 슬라이드 수
getSlideIndex(slideProxy)
슬라이드의 0-based 인덱스를 찾는다.
getSlideIndex(slideProxy: Slide): Promise<number>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxy | Slide | 대상 슬라이드 |
반환값
Promise<number> - 문서에 없는 슬라이드면 -1
getSlides()
문서의 모든 슬라이드를 순서대로 반환한다.
getSlides(): Promise<Slide[]>;
반환값
Promise<Slide[]> - 슬라이드 목록
getSlideSize()
슬라이드 영역 크기 (px). 문서 내 모든 슬라이드가 공유하는 단일 값.
getSlideSize(): Promise<{ width: number; height: number }>;
반환값
Promise<{ width: number; height: number }> - 슬라이드 영역의 가로·세로 크기 (px)
getTableStyleNames()
적용 가능한 표 스타일 이름 목록을 반환한다. 여기서 얻은 이름을 slide.insertTable / table.setStyle 에 그대로 넘긴다.
getTableStyleNames(): Promise<string[]>;
반환값
Promise<string[]> - 표 스타일 이름 목록 (편집기 '표 스타일' 갤러리와 동일)
goToSlide(slideProxy)
지정한 슬라이드로 현재 보기를 전환한다.
goToSlide(slideProxy: Slide): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxy | Slide | 이동할 슬라이드 |
반환값
Promise<void>
hideSlides(slideProxyList, isHidden)
여러 슬라이드의 숨김 상태를 일괄 변경한다.
hideSlides(slideProxyList: Slide[], isHidden: boolean): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 대상 슬라이드 배열 |
isHidden | boolean | true: 숨김, false: 표시 |
반환값
Promise<void>
insertSlide(index, layoutType)
새 슬라이드를 삽입한다.
insertSlide(index?: number, layoutType?: SlideLayoutType): Promise<Slide>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
index (선택) | number | 삽입 위치 (0-based) (기본값: 마지막에 추가) |
layoutType (선택) | SlideLayoutType | 레이아웃 종류. 같은 type 이 여럿이면 첫 번째. 지정한 type 미존재 시 BLANK (문서에 BLANK 가 없으면 첫 번째 마스터의 첫 번째 레이아웃) (기본값: SlideLayoutType.BLANK) |
반환값
Promise<Slide> - 삽입된 슬라이드
isCommentsVisible()
문서 전체의 댓글 표시 여부를 반환한다. (showComments 대칭)
isCommentsVisible(): Promise<boolean>;
반환값
Promise<boolean> - 댓글이 표시 중이면 true
moveSlide(fromIndex, toIndex)
슬라이드를 다른 위치로 이동한다.
moveSlide(fromIndex: number, toIndex: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
fromIndex | number | 이동 원본 인덱스 (0-based) |
toIndex | number | 이동 대상 인덱스 (0-based) |
반환값
Promise<void>
print()
현재 문서를 인쇄한다. (브라우저 인쇄/PDF 등 앱 레벨 동작이므로 Actor 경유)
print(): Promise<void>;
반환값
Promise<void>
removeDate()
모든 슬라이드의 날짜 머리글/바닥글을 제거한다.
removeDate(): Promise<void>;
반환값
Promise<void>
removeFooter()
모든 슬라이드의 바닥글을 제거한다.
removeFooter(): Promise<void>;
반환값
Promise<void>
removeSlideNumber()
모든 슬라이드의 슬라이드 번호를 제거한다.
removeSlideNumber(): Promise<void>;
반환값
Promise<void>
removeTransition(slideProxyList)
여러 슬라이드의 전환 효과를 제거한다. (단일 undo 로 처리)
removeTransition(slideProxyList: Slide[]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 대상 슬라이드 배열 |
반환값
Promise<void>
replaceText(query, replacement, slideProxyList, caseSensitive)
검색 텍스트를 찾아 모두 새 텍스트로 바꾼다. (모두 바꾸기) slideProxyList 를 주면 그 슬라이드들만 바꾼다. 병합된 표 셀, 슬라이드 번호·날짜 같은 자동 갱신 필드, 문단 경계를 가로지르는 매치는 바뀌지 않는다. 협업 잠금 등으로 편집할 수 없는 텍스트의 매치도 바꾸지 않고 skippedCount 로 반환한다.
replaceText(
query: string,
replacement?: string,
slideProxyList?: Slide[],
caseSensitive?: boolean
): Promise<{ replacedCount: number; skippedCount: number }>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
query | string | 찾을 텍스트 |
replacement (선택) | string | 바꿀 텍스트. 빈 문자열이면 매치를 삭제한다 (기본값: "") |
slideProxyList (선택) | Slide[] | 치환 대상 슬라이드 (기본값: 전체 슬라이드) |
caseSensitive (선택) | boolean | 대소문자 구분 (기본값: false) |
반환값
Promise<{ replacedCount: number; skippedCount: number }> - 치환한 매치 수 / 제외한 매치 수
resetBackgrounds(slideProxyList)
여러 슬라이드의 배경을 일괄 초기화한다.
resetBackgrounds(slideProxyList: Slide[]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 대상 슬라이드 배열 |
반환값
Promise<void>
save()
문서를 저장한다. (서버 I/O 이므로 Actor 경유)
save(): Promise<void>;
반환값
Promise<void>
selectAll(scope)
지정한 범위를 모두 선택한다.
selectAll(scope?: SelectScope): Promise<boolean>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
scope (선택) | SelectScope | "shape": 현재 슬라이드의 모든 도형 "slide": 모든 슬라이드 "text": 현재 편집 중인 텍스트 전체 (텍스트 편집 중이 아니면 아무 것도 선택 안 함) (기본값: SelectScope.SHAPE) |
반환값
Promise<boolean> - 선택 대상이 없으면 false
setColorScheme(colorSchemePrst)
문서 전체의 색상 테마를 변경한다. getColorSchemeList 로 목록을 확인한 뒤 prst 를 전달한다.
setColorScheme(colorSchemePrst: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
colorSchemePrst | string | 색상 테마 프리셋 이름 |
반환값
Promise<void>
setDate(date)
모든 슬라이드의 날짜 머리글/바닥글을 설정한다. (없으면 생성, 있으면 갱신)
setDate(date?: HeaderFooterDate): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
date (선택) | HeaderFooterDate | 날짜 설정 (기본값: 자동갱신 날짜) |
반환값
Promise<void>
setFontScheme(fontSchemePrst)
문서의 테마 글꼴을 변경한다. getFontSchemeList 로 목록을 확인한 뒤 prst 를 전달한다.
setFontScheme(fontSchemePrst: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
fontSchemePrst | string | 테마 글꼴 프리셋 이름 |
반환값
Promise<void>
setFooter(text)
모든 슬라이드의 바닥글을 설정한다. (없으면 생성, 있으면 갱신)
setFooter(text: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
text | string | 바닥글 텍스트 |
반환값
Promise<void>
setFormatScheme(formatSchemePrst)
문서의 테마 효과를 변경한다. getFormatSchemeList 로 목록을 확인한 뒤 prst 를 전달한다.
setFormatScheme(formatSchemePrst: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
formatSchemePrst | string | 테마 효과 프리셋 이름 |
반환값
Promise<void>
setSlideColorScheme(slideProxyList, colorSchemePrst)
지정한 슬라이드들에만 색상 테마를 적용한다. 이후 setColorScheme 으로 문서 전체 테마를 바꾸면 여기서 준 슬라이드별 재정의는 모두 해제된다. getColorSchemeList 로 목록을 확인한 뒤 prst 를 전달한다.
setSlideColorScheme(slideProxyList: Slide[], colorSchemePrst: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 대상 슬라이드 배열 |
colorSchemePrst | string | 색상 테마 프리셋 이름 |
반환값
Promise<void>
setSlideNumber()
모든 슬라이드에 슬라이드 번호를 표시한다.
setSlideNumber(): Promise<void>;
반환값
Promise<void>
setTransition(slideProxyList, transition)
여러 슬라이드에 전환 효과를 일괄 적용한다. (단일 undo 로 처리) 효과가 지원하는 옵션만 반영되며, 주지 않은 값은 기본 모델에서 채운다. 효과 제거는 type 으로 하지 않고 removeTransition() 을 사용한다.
setTransition(slideProxyList: Slide[], transition: Transition): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
slideProxyList | Slide[] | 대상 슬라이드 배열 (전체 적용은 getSlides() 를 넘긴다) |
transition | Transition | 전환 효과 설정 |
반환값
Promise<void>
setViewMode(mode)
편집 화면의 보기 배율/맞춤을 변경한다.
setViewMode(mode: ViewMode): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
mode | ViewMode | 보기 배율 또는 창 맞춤. 허용값은 ViewMode 의 8개뿐이다. |
반환값
Promise<void>
showComments(show)
문서 전체의 댓글 표시 여부를 설정한다.
showComments(show: boolean): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
show | boolean | true: 댓글 표시, false: 댓글 숨김 |
반환값
Promise<void>
startSlideShow(fromCurrent)
슬라이드 쇼(전체화면 발표)를 시작한다.
startSlideShow(fromCurrent?: boolean): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
fromCurrent (선택) | boolean | true: 현재 슬라이드부터, false: 처음부터 (기본값: false) |
반환값
Promise<void>
uploadImageFromUrl(url)
이미지(URL / data:URI)를 서버 파일 DB 에 업로드한다. (SVG 임포트의 이미지 처리) 업로드 해소는 ApiUtils.uploadImageLink 로 공통화돼 있다(도형/배경 setImageFill·htmlImport 공유).
uploadImageFromUrl(url: string): Promise<{isError:boolean, src?:string, width?:number, height?:number}>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
url | string | 이미지 URL 또는 data URI |
반환값
Promise<{isError:boolean, src?:string, width?:number, height?:number}>