Show.Shape
Show.Shape은 Presentation 모듈(Office.show(iframe))의 객체 타입입니다. 메서드 117개.
Presentation · 객체 타입 10개 · 메서드 586개 · 네임스페이스 Show. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.
비고
- 모듈: Presentation ·
Office.show(iframe)· 네임스페이스Show - 얻는 방법:
Document.findShapes(slides, filter),Slide.duplicateShape(shapeProxy),Slide.duplicateShapes(shapeProxyList),Slide.findShapes(filter),Slide.getShape(index),Slide.getShapes(),Slide.insertShape(presetId, transform),Slide.insertTextBox(transform),Slide.ungroupShapes(shapeProxy),Group.getChildren(),Group.ungroup() - 모든 메서드는
Promise를 반환하며, 시그니처는 TypeScript 표기입니다.
메서드
| 메서드 | 설명 |
|---|---|
align(alignType) | 도형을 슬라이드 기준으로 정렬한다. |
flip(direction) | 도형을 상하 또는 좌우로 반전한다. |
getAdjustValues() | 일반 도형에 정의된 조절값과 조절 가능한 범위를 반환한다. |
getAlignH(range) | 대표 단락의 가로 정렬을 반환한다. |
getAlignV() | 텍스트 세로 정렬을 반환한다. |
getBold(range) | 대표 run 의 굵게 여부를 반환한다. |
getBulletStyle(range) | 대표 단락의 글머리 기호 스타일을 반환한다. |
getEffects() | 도형에 적용된 효과를 반환한다. |
getFill() | 도형 채우기를 반환한다. |
getFirstLineIndent(range) | 대표 단락의 첫 줄 들여쓰기(UI "첫 줄")를 반환한다. |
getFontFamily(range) | 대표 run 의 글꼴 이름을 반환한다. |
getFontSize(range) | 대표 run 의 글자 크기(pt)를 반환한다. |
getFontStyle(range) | 대표 run(range 가 걸친 첫 run)의 글꼴 스타일을 반환한다. |
getHeight() | 도형의 높이를 반환한다. |
getHyperlink() | 도형에 설정된 하이퍼링크를 반환한다. |
getItalic(range) | 대표 run 의 기울임 여부를 반환한다. |
getLevel(range) | 대표 단락의 목록 수준을 반환한다. |
getLineCap() | 선 끝 모양(cap)을 반환한다. |
getLineColor() | 선 색상을 반환한다. |
getLineDash() | 선 대시 유형을 반환한다. |
getLineJoin() | 선 연결 유형(join)을 반환한다. |
getLineSpacing(range) | 대표 단락의 줄 간격 값을 반환한다. |
getLineSpacingType(range) | 대표 단락의 줄 간격 유형을 반환한다. |
getLineStyle() | 선 스타일을 반환한다. |
getLineWidth() | 선 두께(pt)를 반환한다. |
getMarginLeft(range) | 대표 단락의 왼쪽 여백(UI "텍스트 앞")을 반환한다. |
getParagraphStyle(range) | 대표 단락(range 가 걸친 첫 단락)의 단락 서식을 반환한다. |
getPlaceholderType() | 도형의 placeholder 종류를 반환한다. |
getPresetId() | 도형의 OOXML preset id (prst) 를 반환한다. |
getRotation() | 도형의 회전 각도를 반환한다. |
getSpaceAfter(range) | 대표 단락의 단락 뒤 간격(UI "문단 아래")을 반환한다. |
getSpaceBefore(range) | 대표 단락의 단락 앞 간격(UI "문단 위")을 반환한다. |
getStrike(range) | 대표 run 의 취소선 유형을 반환한다. |
getText(range) | 텍스트를 plain text로 반환한다. |
getTextboxAutoFit() | 텍스트 상자 자동 맞춤 유형을 반환한다. |
getTextColor(range) | 대표 run 의 글자 색상을 반환한다. |
getTextHyperlink(range) | 텍스트 구간의 하이퍼링크를 반환한다. |
getTransform() | 도형의 위치, 크기, 회전 정보를 반환한다. |
getUnderline(range) | 대표 run 의 밑줄 유형을 반환한다. |
getWidth() | 도형의 너비를 반환한다. |
getX() | 도형의 X 좌표를 반환한다. |
getY() | 도형의 Y 좌표를 반환한다. |
getZOrderIndex() | 부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다. |
hasText() | 도형이 텍스트를 담고 있는지 반환한다. |
insertSymbol(textOffset, symbol) | 지정한 offset 위치에 특수문자(symbol)를 삽입한다. |
insertText(text, textOffset) | 텍스트를 삽입한다. |
isChart() | 이 핸들이 Chart 인지 판별한다 (union 좁히기용 type guard). |
isControl() | 이 핸들이 Control 인지 판별한다 (union 좁히기용 type guard). |
isDiagram() | 이 핸들이 Diagram 인지 판별한다 (union 좁히기용 type guard). |
isFlatTx() | 3D 회전 시 텍스트를 평면으로 유지하는지 반환한다. |
isFlippedH() | 도형이 좌우로 반전된 상태인지 반환한다. |
isFlippedV() | 도형이 상하로 반전된 상태인지 반환한다. |
isGroup() | 이 핸들이 Group 인지 판별한다 (union 좁히기용 type guard). |
isImage() | 이 핸들이 Image 인지 판별한다 (union 좁히기용 type guard). |
isLine() | 이 핸들이 Line 인지 판별한다 (union 좁히기용 type guard). |
isOleObject() | 이 핸들이 OleObject 인지 판별한다 (union 좁히기용 type guard). |
isPlaceholder() | 도형이 placeholder(제목 · 본문 틀 등)인지 반환한다. |
isShape() | 이 핸들이 Shape 인지 판별한다 (union 좁히기용 type guard). |
isTable() | 이 핸들이 Table 인지 판별한다 (union 좁히기용 type guard). |
moveBy(distance) | 도형을 현재 위치 기준으로 x, y 만큼 상대 이동한다. |
remove3d() | 도형의 3D 효과를 제거한다. |
removeEffect(effectType) | 효과를 제거한다. |
removeFill() | 채우기를 제거한다 (noFill). |
removeHyperlink() | 도형의 하이퍼링크를 제거한다. |
removeLineColor() | 선 색상을 제거한다 (noFill). |
removeTextHyperlink(range) | 텍스트의 하이퍼링크를 제거한다. |
reorder(order) | 도형의 정렬 순서(앞으로/뒤로)를 변경한다. |
set3d(scene3d, sp3d) | 도형에 3D 효과를 적용한다. |
setAdjustValue(name, value) | 일반 도형의 조절값(adjust value) 하나를 변경한다. |
setAdjustValues(avList) | 일반 도형의 여러 조절값(adjust value)을 한 번에 변경한다. |
setAlignH(align, range) | 텍스트 가로 정렬을 설정한다. |
setAlignV(align) | 텍스트 세로 정렬을 설정한다. |
setBold(enabled, range) | 글자를 굵게 설정한다. |
setBulletStyle(bulletType, subType, startAt, range) | 글머리 기호 스타일을 설정한다. |
setEffects(effects) | getEffects() 가 반환한 효과 객체를 그대로 적용한다. |
setFill(fill) | getFill() 이 반환한 채우기 객체를 그대로 적용한다. |
setFirstLineIndent(firstLineIndent, range) | 단락 첫 줄의 들여쓰기(UI "첫 줄")를 설정한다. |
setFlatTx(enabled) | 3D 회전 시 텍스트를 평면으로 유지할지 설정한다. |
setFontFamily(fontFamily, range) | 글꼴을 설정한다. |
setFontSize(fontSize, range) | 글자 크기를 설정한다. |
setFontStyle(style, range) | 글꼴 스타일을 설정한다. |
setGlow(glow) | 네온(광선) 효과를 적용한다. |
setGradientFill(type, stops, angle) | 그라데이션 채우기를 설정한다. |
setHeight(height) | 도형의 높이를 설정한다. |
setHyperlink(hyperlink) | 도형에 하이퍼링크를 설정한다. |
setImageFill(imageUrl, fillMode, alpha, detail) | 이미지 채우기를 설정한다. |
setInnerShadow(shadow) | 내부 그림자를 적용한다. |
setItalic(enabled, range) | 글자 기울임을 설정한다. |
setLevel(level, range) | 목록 수준(개요 계층 깊이)을 설정한다. |
setLineCap(lineCap) | 선 끝 모양(cap)을 설정한다. |
setLineColor(color, alpha) | 선 색상을 설정한다. |
setLineDash(lineDash) | 선 스타일(대시)을 설정한다. |
setLineGradient(type, stops, angle) | 선(테두리) 그라데이션 채우기를 설정한다. |
setLineJoin(lineJoin) | 선 연결 유형(join)을 설정한다. |
setLineSpacing(lineSpacing, type, range) | 줄 간격을 설정한다. |
setLineStyle(style) | getLineStyle() 이 반환한 선 스타일 객체를 그대로 적용한다. |
setLineWidth(lineWidth) | 선 두께를 설정한다. |
setMarginLeft(marginLeft, range) | 단락 전체의 왼쪽 여백(UI "텍스트 앞")을 설정한다. |
setOuterShadow(shadow) | 외부 그림자를 적용한다. |
setParagraphStyle(style, range) | 단락 서식을 한 번에 설정한다. |
setPatternFill(preset, foreColor, backColor, foreAlpha, backAlpha) | 패턴(무늬) 채우기를 설정한다. |
setReflection(reflection) | 반사 효과를 적용한다. |
setRotation(rotation) | 도형의 회전 각도를 절대값으로 설정한다. |
setSoftEdge(softEdge) | 옅은 테두리(softEdge) 효과를 적용한다. |
setSolidFill(color, alpha) | 도형 채우기를 단색으로 설정한다. |
setSpaceAfter(spaceAfter, range) | 단락 뒤 간격(UI "문단 아래")을 설정한다. |
setSpaceBefore(spaceBefore, range) | 단락 앞 간격(UI "문단 위")을 설정한다. |
setStrike(strike, range) | 글자 취소선을 설정한다. |
setText(text, range) | 텍스트를 설정한다. |
setTextboxAutoFit(autoAlignType) | 텍스트 상자 자동 맞춤 유형을 설정한다. |
setTextColor(color, range) | 글자 색상을 설정한다. |
setTextHyperlink(hyperlink, range) | 텍스트에 하이퍼링크를 설정한다. |
setTransform(transform) | 도형의 위치·크기·회전을 한 번에 설정한다. |
setUnderline(underline, range) | 글자 밑줄을 설정한다. |
setWidth(width) | 도형의 너비를 설정한다. |
setX(x) | 도형의 X 좌표를 절대값으로 설정한다. |
setY(y) | 도형의 Y 좌표를 절대값으로 설정한다. |
메서드 상세
align(alignType)
도형을 슬라이드 기준으로 정렬한다. 이동이 불가능한 도형이면 무시된다. 그룹 자식도 그룹 안이 아니라 슬라이드를 기준으로 움직인다(에디터와 같다). 자식이 그룹 밖으로 나가면 그룹이 자식을 담도록 함께 넓어진다.
align(alignType: AlignType): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
alignType | AlignType | 정렬 타입 |
반환값
Promise<void>
flip(direction)
도형을 상하 또는 좌우로 반전한다. 현재 반전 상태를 뒤집는 토글이며, 지금 반전돼 있는지는 isFlippedH()/isFlippedV() 로 읽는다. 회전이 불가능한 도형에서는 반전도 무시된다. 회전된 도형은 각도도 거울상으로 함께 바뀐다 (getRotation() 값이 360 - 기존 각도 로 바뀐다).
flip(direction: FlipDirection): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
direction | FlipDirection | 반전 방향 |
반환값
Promise<void>
getAdjustValues()
일반 도형에 정의된 조절값과 조절 가능한 범위를 반환한다. 반환된 name 은 조절값 조회와 변경 API 에서 사용한다.
getAdjustValues(): Promise<AdjustValue[] | null>;
반환값
Promise<AdjustValue[] | null> - 조절값 목록. 대상 도형이 없으면(협업 중 삭제 등) null
getAlignH(range)
대표 단락의 가로 정렬을 반환한다. (setAlignH 대칭)
getAlignH(range?: TextRange): Promise<TextAlignH | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<TextAlignH | null> - 가로 정렬. 텍스트/단락 없으면 null
getAlignV()
텍스트 세로 정렬을 반환한다. (setAlignV 대칭) TextAlignV 는 TOP 이 0 인 숫자 enum 이라, 값이 있는지는 truthy 검사가 아니라 null 비교로 본다.
getAlignV(): Promise<TextAlignV | null>;
반환값
Promise<TextAlignV | null> - 세로 정렬. 대상 텍스트가 없으면 null
getBold(range)
대표 run 의 굵게 여부를 반환한다. (setBold 대칭 - 상속까지 반영된 실제 적용값)
getBold(range?: TextRange): Promise<boolean | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<boolean | null> - 굵게 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getBulletStyle(range)
대표 단락의 글머리 기호 스타일을 반환한다. 반환 필드를 풀어서 setBulletStyle(type, subType, startAt) 에 넘길 수 있다. 값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이고, 없는 값(시작 번호)과 되넘길 수 없는 값(프리셋 밖 번호 유형)은 키를 담지 않는다. 그림 글머리·프리셋 밖 문자는 조회 전용이라 그대로는 적용되지 않는다. (제약은 setBulletStyle 참조)
getBulletStyle(range?: TextRange): Promise<BulletStyle | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<BulletStyle | null> - 글머리 기호 스타일. 텍스트/단락 없으면 null
getEffects()
도형에 적용된 효과를 반환한다. 적용된 효과만 키로 포함된다. 각 값은 대응 setter(setOuterShadow/setInnerShadow/setGlow/setSoftEdge/setReflection/set3d) 의 인자와 같은 형태다. 그림자·네온의 alpha 는 불투명(0)이어도 항상 포함되고, 길이(pt)·비율(%)은 소수 첫째 자리로 반올림된다. outerShadow·innerShadow 가 함께 실린 문서면 둘 다 담는다 (setter 로는 하나만 넣을 수 있다).
getEffects(): Promise<Effects | null>;
반환값
Promise<Effects | null> - 효과 정보. 적용된 효과가 없으면 빈 객체 \{\}, 대상 도형이 없으면(협업 중 삭제 등) null
getFill()
도형 채우기를 반환한다. (setFill 대칭 - 반환 객체를 그대로 넘길 수 있다) type 별 개별 setter 는 setSolidFill/setGradientFill/setImageFill/setPatternFill/removeFill 이다.
getFill(): Promise<Fill | null>;
반환값
Promise<Fill | null> - 채우기 정보. noFill 이면 \{ type: FillType.NONE \}, 대상 도형이 없으면(협업 중 삭제 등) null
getFirstLineIndent(range)
대표 단락의 첫 줄 들여쓰기(UI "첫 줄")를 반환한다. (setFirstLineIndent 대칭)
getFirstLineIndent(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 첫 줄 들여쓰기 (pt, 음수는 내어쓰기). 텍스트/단락 없으면 null
getFontFamily(range)
대표 run 의 글꼴 이름을 반환한다. (setFontFamily 대칭 - 상속까지 반영된 실제 적용값)
getFontFamily(range?: TextRange): Promise<string | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<string | null> - 글꼴 이름. 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getFontSize(range)
대표 run 의 글자 크기(pt)를 반환한다. (setFontSize 대칭 - 상속까지 반영된 실제 적용값)
getFontSize(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 글자 크기 (pt). 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getFontStyle(range)
대표 run(range 가 걸친 첫 run)의 글꼴 스타일을 반환한다. (setFontStyle 대칭) 반환 객체를 그대로 다른 개체의 setFontStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다. 값은 레이아웃/마스터/표 스타일 상속까지 반영해 실제 적용된 값이라 run 이 직접 지정한 값만 골라낼 수는 없다.
getFontStyle(range?: TextRange): Promise<FontStyle | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<FontStyle | null> - 글꼴 스타일. run/스타일 없으면 빈 객체 \{\}, 대상 텍스트가 없거나(협업 중 삭제 등) 유효하지 않은 구간이면 null
getHeight()
도형의 높이를 반환한다. (setHeight 대칭)
getHeight(): Promise<number | null>;
반환값
Promise<number | null> - 높이 (px 단위). 대상 도형이 없으면 null
getHyperlink()
도형에 설정된 하이퍼링크를 반환한다. 반환 객체를 그대로 setHyperlink 에 넘길 수 있다. 지원하지 않는 종류(프로그램 실행·매크로 등)가 걸려 있으면 null 이다.
getHyperlink(): Promise<Hyperlink | null>;
반환값
Promise<Hyperlink | null> - 하이퍼링크 정보. 하이퍼링크(action)가 없으면 null
getItalic(range)
대표 run 의 기울임 여부를 반환한다. (setItalic 대칭 - 상속까지 반영된 실제 적용값)
getItalic(range?: TextRange): Promise<boolean | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<boolean | null> - 기울임 여부. 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getLevel(range)
대표 단락의 목록 수준을 반환한다. (setLevel 대칭)
getLevel(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 목록 수준 (1~9). 텍스트/단락 없으면 null
getLineCap()
선 끝 모양(cap)을 반환한다. (setLineCap 대칭)
getLineCap(): Promise<LineCap | null>;
반환값
Promise<LineCap | null> - 선 끝 모양. 설정이 없거나 대상 도형이 없으면 null
getLineColor()
선 색상을 반환한다. (setLineColor 대칭. 투명도까지 필요하면 getLineStyle 사용)
getLineColor(): Promise<string | null>;
반환값
Promise<string | null> - 선 색상 (hex "#RRGGBB" - scheme color 도 hex 로 풀려서 나온다). 선이 없거나 대상 도형이 없으면 null
getLineDash()
선 대시 유형을 반환한다. (setLineDash 대칭)
getLineDash(): Promise<LineDash | null>;
반환값
Promise<LineDash | null> - 선 대시 유형. LineDash enum 이 아니거나 대상 도형이 없으면 null
getLineJoin()
선 연결 유형(join)을 반환한다. (setLineJoin 대칭)
getLineJoin(): Promise<LineJoin | null>;
반환값
Promise<LineJoin | null> - 선 연결(모서리) 유형. 설정이 없거나 대상 도형이 없으면 null
getLineSpacing(range)
대표 단락의 줄 간격 값을 반환한다. (setLineSpacing 대칭)
getLineSpacing(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt). 텍스트/단락 없으면 null
getLineSpacingType(range)
대표 단락의 줄 간격 유형을 반환한다. (setLineSpacing 의 type 대칭)
getLineSpacingType(range?: TextRange): Promise<LineSpacingType | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<LineSpacingType | null> - 줄 간격 유형. 텍스트/단락 없으면 null
getLineStyle()
선 스타일을 반환한다. (setLineStyle 대칭 - 반환 객체를 그대로 넘길 수 있다) 개별 setter 는 setLineColor/setLineGradient/setLineWidth/setLineDash/setLineCap/setLineJoin 이다.
getLineStyle(): Promise<LineStyle | null>;
반환값
Promise<LineStyle | null> - 선 스타일. 대상 도형이 없으면 null
getLineWidth()
선 두께(pt)를 반환한다. (setLineWidth 대칭)
getLineWidth(): Promise<number | null>;
반환값
Promise<number | null> - 선 두께 (pt). 선 없음(noFill)이어도 두께는 그대로 반환한다. 대상 도형이 없으면 null
getMarginLeft(range)
대표 단락의 왼쪽 여백(UI "텍스트 앞")을 반환한다. (setMarginLeft 대칭)
getMarginLeft(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 왼쪽 여백 (pt). 텍스트/단락 없으면 null
getParagraphStyle(range)
대표 단락(range 가 걸친 첫 단락)의 단락 서식을 반환한다. (setParagraphStyle 대칭) 반환 객체를 그대로 다른 개체의 setParagraphStyle 에 넘길 수 있다. 값이 없는 속성은 키를 담지 않는다. 값은 레이아웃/마스터 상속까지 반영해 실제 적용된 값이라 단락이 직접 지정한 값만 골라낼 수는 없고, 같은 단락에 그대로 다시 넘기면 상속값과 같은 속성은 직접 지정으로 남지 않는다. 목록 수준은 서식 값이 아니라 상속 프리셋이라 담지 않는다. (getLevel 대칭)
getParagraphStyle(range?: TextRange): Promise<ParagraphStyle | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<ParagraphStyle | null> - 단락 서식. 텍스트/단락 없으면 null
getPlaceholderType()
도형의 placeholder 종류를 반환한다.
getPlaceholderType(): Promise<PlaceholderType | null>;
반환값
Promise<PlaceholderType | null> - placeholder 종류. placeholder 가 아니거나 대상 도형이 없으면 null
getPresetId()
도형의 OOXML preset id (prst) 를 반환한다.
getPresetId(): Promise<string | null>;
반환값
Promise<string | null> - preset id (prst), 없으면 null
getRotation()
도형의 회전 각도를 반환한다. (setRotation 대칭)
getRotation(): Promise<number | null>;
반환값
Promise<number | null> - 회전 각도 (degree). 대상 도형이 없으면 null
getSpaceAfter(range)
대표 단락의 단락 뒤 간격(UI "문단 아래")을 반환한다. (setSpaceAfter 대칭)
getSpaceAfter(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 단락 뒤 간격 (pt). 배수(%) 저장/텍스트 없음이면 null
getSpaceBefore(range)
대표 단락의 단락 앞 간격(UI "문단 위")을 반환한다. (setSpaceBefore 대칭)
getSpaceBefore(range?: TextRange): Promise<number | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<number | null> - 단락 앞 간격 (pt). 배수(%) 저장/텍스트 없음이면 null
getStrike(range)
대표 run 의 취소선 유형을 반환한다. (setStrike 대칭 - 상속까지 반영된 실제 적용값)
getStrike(range?: TextRange): Promise<Strike | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<Strike | null> - 취소선 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getText(range)
텍스트를 plain text로 반환한다. 문단 사이의 개행은 그대로 들어가지만, 마지막 문단을 끝맺는 개행은 글자가 아니라 담지 않는다 (빈 텍스트는 "").
getText(range?: TextRange): Promise<string>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (UTF-16 코드 단위 offset) (기본값: 전체 텍스트) |
반환값
Promise<string> - 해당 구간의 텍스트 (plain text). 텍스트 모델이 없거나 빈 구간이면 ""
getTextboxAutoFit()
텍스트 상자 자동 맞춤 유형을 반환한다. (setTextboxAutoFit 대칭)
getTextboxAutoFit(): Promise<AutoFitType | null>;
반환값
Promise<AutoFitType | null> - 자동 맞춤 유형. 대상 텍스트가 없으면 null
getTextColor(range)
대표 run 의 글자 색상을 반환한다. (setTextColor 대칭 - 상속까지 반영된 실제 적용값)
getTextColor(range?: TextRange): Promise<string | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<string | null> - 글자 색상 (hex "#RRGGBB" - scheme color 도 hex 로 풀려서 나온다). solid 채우기가 아니거나 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getTextHyperlink(range)
텍스트 구간의 하이퍼링크를 반환한다. (setTextHyperlink 대칭 - 반환 객체를 그대로 넘겨 복사할 수 있다) range 를 주면 그 구간의 첫 글자, range 가 없으면 텍스트의 첫 글자가 속한 run 을 기준으로 한다. 도형 자체에 걸린 하이퍼링크는 getHyperlink 로 읽는다.
getTextHyperlink(range?: TextRange): Promise<Hyperlink | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 조회할 텍스트 구간 (기본값: 텍스트 첫 글자) |
반환값
Promise<Hyperlink | null> - 하이퍼링크 정보 (getHyperlink 와 같은 Hyperlink 객체). 링크 없음/텍스트 없음/미노출 action 이면 null
getTransform()
도형의 위치, 크기, 회전 정보를 반환한다. x/y 는 반전(flip) 여부와 무관하게 도형의 좌상단이라, 반환값을 다른 도형의 setTransform 에 그대로 넘기면 두 도형이 같은 자리에 놓인다. 값은 에디터 입력 단위로 반올림해 반환한다 - 크기는 소수 한 자리, 위치는 정수. setter 도 같은 단위로 넣으므로, 임포트 문서처럼 더 잘게 놓인 도형은 되넘길 때 그만큼 움직인다.
getTransform(): Promise<ShapeTransform | null>;
반환값
Promise<ShapeTransform | null> - 도형의 위치·크기·회전 정보. 대상 도형이 없으면(협업 중 삭제 등) null
getUnderline(range)
대표 run 의 밑줄 유형을 반환한다. (setUnderline 대칭 - 상속까지 반영된 실제 적용값)
getUnderline(range?: TextRange): Promise<Underline | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 읽을 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<Underline | null> - 밑줄 유형. 대상 텍스트가 없거나 유효하지 않은 구간이면 null
getWidth()
도형의 너비를 반환한다. (setWidth 대칭)
getWidth(): Promise<number | null>;
반환값
Promise<number | null> - 너비 (px 단위). 대상 도형이 없으면 null
getX()
도형의 X 좌표를 반환한다. (setX 대칭)
getX(): Promise<number | null>;
반환값
Promise<number | null> - X 좌표 (px 단위). 대상 도형이 없으면 null
getY()
도형의 Y 좌표를 반환한다. (setY 대칭)
getY(): Promise<number | null>;
반환값
Promise<number | null> - Y 좌표 (px 단위). 대상 도형이 없으면 null
getZOrderIndex()
부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다. 0 이 맨 뒤이며, 클수록 앞이다.
getZOrderIndex(): Promise<number | null>;
반환값
Promise<number | null> - z-order 순번. 대상 도형이 없으면 null
hasText()
도형이 텍스트를 담고 있는지 반환한다. 에디터가 텍스트를 비었다고 보는 기준과 같다 - 공백만 있거나 빈 문단이 둘 이상(개행만 넣은 상태)이면 true, 빈 문단 하나뿐이면 false 다. 도형 레벨 텍스트가 없는 종류(표·그룹·차트)는 항상 false 다. (표는 셀 단위로 조회)
hasText(): Promise<boolean | null>;
반환값
Promise<boolean | null> - 텍스트 존재 여부. 대상 도형이 없으면 null
insertSymbol(textOffset, symbol)
지정한 offset 위치에 특수문자(symbol)를 삽입한다.
insertSymbol(textOffset: number, symbol: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
textOffset | number | 삽입 위치 offset |
symbol | string | 삽입할 특수문자 (개행 불가 - 문단을 나누려면 insertText) |
반환값
Promise<void>
insertText(text, textOffset)
텍스트를 삽입한다. 삽입한 글자의 서식은 삽입 지점 바로 앞 글자의 런 서식을 따른다.
insertText(text: string, textOffset?: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
text | string | 삽입할 텍스트 |
textOffset (선택) | number | 삽입 위치 offset (기본값: 텍스트 끝) |
반환값
Promise<void>
isChart()
이 핸들이 Chart 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isChart(): Promise<this is Chart>;
반환값
Promise<this is Chart>
isControl()
이 핸들이 Control 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isControl(): Promise<this is Control>;
반환값
Promise<this is Control>
isDiagram()
이 핸들이 Diagram 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isDiagram(): Promise<this is Diagram>;
반환값
Promise<this is Diagram>
isFlatTx()
3D 회전 시 텍스트를 평면으로 유지하는지 반환한다. (setFlatTx 대칭)
isFlatTx(): Promise<boolean | null>;
반환값
Promise<boolean | null> - 텍스트 평면 유지 여부. 대상 도형이 없으면 null
isFlippedH()
도형이 좌우로 반전된 상태인지 반환한다. (flip(FlipDirection.HORIZONTAL) 을 호출하면 이 값이 뒤집힌다)
isFlippedH(): Promise<boolean | null>;
반환값
Promise<boolean | null> - 좌우 반전 여부. 대상 도형이 없으면 null
isFlippedV()
도형이 상하로 반전된 상태인지 반환한다. (flip(FlipDirection.VERTICAL) 을 호출하면 이 값이 뒤집힌다)
isFlippedV(): Promise<boolean | null>;
반환값
Promise<boolean | null> - 상하 반전 여부. 대상 도형이 없으면 null
isGroup()
이 핸들이 Group 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isGroup(): Promise<this is Group>;
반환값
Promise<this is Group>
isImage()
이 핸들이 Image 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isImage(): Promise<this is Image>;
반환값
Promise<this is Image>
isLine()
이 핸들이 Line 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isLine(): Promise<this is Line>;
반환값
Promise<this is Line>
isOleObject()
이 핸들이 OleObject 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isOleObject(): Promise<this is OleObject>;
반환값
Promise<this is OleObject>
isPlaceholder()
도형이 placeholder(제목 · 본문 틀 등)인지 반환한다.
isPlaceholder(): Promise<boolean | null>;
반환값
Promise<boolean | null> - placeholder 여부. 대상 도형이 없으면 null
isShape()
이 핸들이 Shape 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isShape(): Promise<this is Shape>;
반환값
Promise<this is Shape>
isTable()
이 핸들이 Table 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.
isTable(): Promise<this is Table>;
반환값
Promise<this is Table>
moveBy(distance)
도형을 현재 위치 기준으로 x, y 만큼 상대 이동한다. (절대 좌표 설정은 setX / setY)
moveBy(distance: ShapeMoveDistance): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
distance | ShapeMoveDistance | 이동량 (px 단위) |
반환값
Promise<void>
remove3d()
도형의 3D 효과를 제거한다.
remove3d(): Promise<void>;
반환값
Promise<void>
removeEffect(effectType)
효과를 제거한다. 그 효과가 걸려 있지 않으면 아무 일도 하지 않는다. 도형이 직접 가진 효과만 제거한다 - 도형 스타일(effectRef)에서 상속받은 효과는 제거할 수 없어, getEffects() 가 돌려주는데도 아무 일도 하지 않는 경우가 있다.
removeEffect(effectType: EffectType): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
effectType | EffectType | 제거할 효과 타입 |
반환값
Promise<void>
removeFill()
채우기를 제거한다 (noFill).
removeFill(): Promise<void>;
반환값
Promise<void>
removeHyperlink()
도형의 하이퍼링크를 제거한다.
removeHyperlink(): Promise<void>;
반환값
Promise<void>
removeLineColor()
선 색상을 제거한다 (noFill).
removeLineColor(): Promise<void>;
반환값
Promise<void>
removeTextHyperlink(range)
텍스트의 하이퍼링크를 제거한다. (도형 자체에 걸린 하이퍼링크는 removeHyperlink)
removeTextHyperlink(range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
range (선택) | TextRange | 제거할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
reorder(order)
도형의 정렬 순서(앞으로/뒤로)를 변경한다. 이미 목표 위치라 바뀔 것이 없으면 무시된다.
reorder(order: ShapeZOrder): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
order | ShapeZOrder | 순서 변경 타입 |
반환값
Promise<void>
set3d(scene3d, sp3d)
도형에 3D 효과를 적용한다. scene3d 와 sp3d 중 비어 있는 인자는 적용하지 않는다.
set3d(scene3d?: Scene3d, sp3d?: Sp3d): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
scene3d (선택) | Scene3d | 카메라(회전) 설정. 생략하면 적용하지 않음 |
sp3d (선택) | Sp3d | 입체(깊이) 설정. 생략하면 적용하지 않음 |
반환값
Promise<void>
setAdjustValue(name, value)
일반 도형의 조절값(adjust value) 하나를 변경한다. 여러 조절값을 함께 변경하려면 setAdjustValues 를 사용한다.
setAdjustValue(name: string, value: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
name | string | 조절값 이름(getAdjustValues 결과) |
value | number | 조절값. 정수로 반올림되며 허용 범위를 벗어나면 최솟값 또는 최댓값으로 제한됨 (getAdjustValues 의 min/max 가 null 인 경우처럼 범위를 알 수 없으면 제한하지 않는다) |
반환값
Promise<void>
setAdjustValues(avList)
일반 도형의 여러 조절값(adjust value)을 한 번에 변경한다.
setAdjustValues(avList: AdjustValueUpdate[]): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
avList | AdjustValueUpdate[] | 변경할 조절값 목록 |
반환값
Promise<void>
setAlignH(align, range)
텍스트 가로 정렬을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다.
setAlignH(align: TextAlignH, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
align | TextAlignH | 가로 정렬 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setAlignV(align)
텍스트 세로 정렬을 설정한다. (getAlignV 대칭)
setAlignV(align: TextAlignV): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
align | TextAlignV | 세로 정렬 |
반환값
Promise<void>
setBold(enabled, range)
글자를 굵게 설정한다.
setBold(enabled: boolean, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
enabled | boolean | true: 굵게, false: 해제 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setBulletStyle(bulletType, subType, startAt, range)
글머리 기호 스타일을 설정한다. (getBulletStyle 대칭) 그림 글머리(BulletType.BLIP)는 적용을 지원하지 않는 조회 전용 유형이라 거부한다. CharType 프리셋 밖의 문자도 적용할 수 없다 (조회 전용이라 받을 인자가 없다).
setBulletStyle(
bulletType: Exclude<BulletType, "buBlip">,
subType?: NumberedType | CharType,
startAt?: number,
range?: TextRange
): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
bulletType | Exclude<BulletType, "buBlip"> | 글머리 기호 유형 |
subType (선택) | NumberedType | CharType | BulletType.AUTO_NUM: 번호 매기기 유형 (기본값 NumberedType.NUMBER_WITH_DOT), BulletType.CHAR: 글머리 문자 유형 (기본값 CharType.DOT) |
startAt (선택) | number | 시작 번호 (BulletType.AUTO_NUM 일 때만 사용) (기본값: 1) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setEffects(effects)
getEffects() 가 반환한 효과 객체를 그대로 적용한다. (getEffects 대칭 - 도형→도형 효과 복사) 포함된 효과 키만 대응 setter 로 적용한다. scene3d/sp3d 는 set3d 로 함께 넘긴다. 대상의 기존 효과를 지우지는 않는다 - 완전 복사하려면 removeEffect/remove3d 로 먼저 제거한 뒤 적용한다. outerShadow 와 innerShadow 를 함께 넘기면 거부하지 않고 순서대로 적용해 나중 것만 남는다.
setEffects(effects?: Effects): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
effects (선택) | Effects | getEffects() 반환값. 생략하면 아무것도 변경하지 않는다 |
반환값
Promise<void>
setFill(fill)
getFill() 이 반환한 채우기 객체를 그대로 적용한다. (getFill 대칭 - 도형→도형 채우기 복사) image 는 조회 결과의 embed 를 재사용하므로 같은 문서 안에서만 복원된다. embed 없는 image 는 적용할 그림이 없어 거부한다 (새 이미지는 setImageFill).
setFill(fill?: Fill): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
fill (선택) | Fill | getFill() 반환값. 생략하면 아무것도 변경하지 않는다 |
반환값
Promise<void>
setFirstLineIndent(firstLineIndent, range)
단락 첫 줄의 들여쓰기(UI "첫 줄")를 설정한다. 둘째 줄부터는 marginLeft 를 따른다. 양수는 들여쓰기, 음수는 내어쓰기, 0 은 들여쓰기 없음이다. 글머리 기호 목록의 계층 깊이를 바꾸려면 setLevel 을 사용한다.
setFirstLineIndent(firstLineIndent: number, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
firstLineIndent | number | 첫 줄 들여쓰기 (pt) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setFlatTx(enabled)
3D 회전 시 텍스트를 평면으로 유지할지 설정한다. (isFlatTx 대칭)
setFlatTx(enabled: boolean): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
enabled | boolean | true 이면 텍스트 평면 유지, false 이면 해제 |
반환값
Promise<void>
setFontFamily(fontFamily, range)
글꼴을 설정한다.
setFontFamily(fontFamily: string, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
fontFamily | string | 글꼴 이름 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setFontSize(fontSize, range)
글자 크기를 설정한다.
setFontSize(fontSize: number, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
fontSize | number | pt 단위 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setFontStyle(style, range)
글꼴 스타일을 설정한다. 단일 속성은 setBold/setItalic/setFontSize/setFontFamily/setTextColor 사용 권장.
setFontStyle(style: FontStyle, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
style | FontStyle | 글꼴 스타일 설정 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setGlow(glow)
네온(광선) 효과를 적용한다. (getEffects().glow 대칭 - 반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 Glow 참조).
setGlow(glow?: Glow): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
glow (선택) | Glow | 네온(광선) 설정 |
반환값
Promise<void>
setGradientFill(type, stops, angle)
그라데이션 채우기를 설정한다.
setGradientFill(
type?: GradientType,
stops?: { color: string; pos?: number; alpha?: number }[],
angle?: number
): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
type (선택) | GradientType | 그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR) |
stops (선택) | { color: string; pos?: number; alpha?: number }[] | 색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100, 0=불투명) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }]) |
angle (선택) | number | 그라데이션 각도 (lin 일 때만 사용) (기본값: 45) |
반환값
Promise<void>
setHeight(height)
도형의 높이를 설정한다. 크기 조정이 불가능한 도형이면 무시된다.
setHeight(height: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
height | number | 높이 (px 단위, 소수 한 자리로 반올림) |
반환값
Promise<void>
setHyperlink(hyperlink)
도형에 하이퍼링크를 설정한다. (getHyperlink 대칭 - 반환 객체를 그대로 넘겨 하이퍼링크를 복사할 수 있다) 지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다.
setHyperlink(hyperlink: Hyperlink): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
hyperlink | Hyperlink | getHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다 |
반환값
Promise<void>
setImageFill(imageUrl, fillMode, alpha, detail)
이미지 채우기를 설정한다.
setImageFill(
imageUrl: string,
fillMode?: ImageFillMode,
alpha?: number,
detail?: ImageFillDetail
): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
imageUrl | string | 이미지 URL |
fillMode (선택) | ImageFillMode | 이미지 채우기 방식 (기본값: ImageFillMode.STRETCH) |
alpha (선택) | number | 투명도 (0~100, 0=불투명) (기본값: 0) |
detail (선택) | ImageFillDetail | 세부 옵션. offset/scale/mirror/align 은 fillMode=ImageFillMode.TILE 일 때만 반영 (기본값: {}) |
반환값
Promise<void> - 이미지 업로드 후 채우기 적용이 끝나면 resolve. 대상 도형이 없으면(업로드 중 삭제 포함) SHAPE_NOT_FOUND 로 reject
setInnerShadow(shadow)
내부 그림자를 적용한다. (getEffects().innerShadow 대칭
반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 InnerShadow 참조). 도형이 갖는 그림자는 하나다
외부 그림자가 걸려 있으면 내부 그림자로 바뀐다.
setInnerShadow(shadow?: InnerShadow): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
shadow (선택) | InnerShadow | 그림자 설정 |
반환값
Promise<void>
setItalic(enabled, range)
글자 기울임을 설정한다.
setItalic(enabled: boolean, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
enabled | boolean | true: 기울임, false: 해제 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setLevel(level, range)
목록 수준(개요 계층 깊이)을 설정한다. range 가 걸친 단락을 모두 같은 수준으로 맞춘다. pt 단위 들여쓰기(setFirstLineIndent/setMarginLeft)와 달리 수준은 상속 프리셋 선택이라, 바꾸면 그 수준의 글머리 기호·글자 크기가 따라오고 marginLeft 는 새 수준의 값으로 덮인다. setMarginLeft 로 지정한 값도 버려지므로 둘을 함께 쓸 때는 setLevel 을 먼저 호출한다. (firstLineIndent 는 유지) 대상 텍스트가 허용하는 범위(제목 개체는 1 수준뿐)로 제한한다.
setLevel(level: number, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
level | number | 목록 수준 (1=최상위 ~ 9) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setLineCap(lineCap)
선 끝 모양(cap)을 설정한다.
setLineCap(lineCap: LineCap): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
lineCap | LineCap | 선 끝 모양 |
반환값
Promise<void>
setLineColor(color, alpha)
선 색상을 설정한다.
setLineColor(color: string, alpha?: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
color | string | hex (#RRGGBB) 또는 scheme color |
alpha (선택) | number | 투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지) |
반환값
Promise<void>
setLineDash(lineDash)
선 스타일(대시)을 설정한다.
setLineDash(lineDash: LineDash): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
lineDash | LineDash | 선 대시 스타일 |
반환값
Promise<void>
setLineGradient(type, stops, angle)
선(테두리) 그라데이션 채우기를 설정한다.
setLineGradient(
type?: GradientType,
stops?: { color: string; pos?: number; alpha?: number }[],
angle?: number
): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
type (선택) | GradientType | 그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR) |
stops (선택) | { color: string; pos?: number; alpha?: number }[] | 색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100, 0=불투명) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }]) |
angle (선택) | number | 그라데이션 각도 (lin 일 때만 사용) (기본값: 45) |
반환값
Promise<void>
setLineJoin(lineJoin)
선 연결 유형(join)을 설정한다.
setLineJoin(lineJoin: LineJoin): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
lineJoin | LineJoin | 선 연결(모서리) 유형 |
반환값
Promise<void>
setLineSpacing(lineSpacing, type, range)
줄 간격을 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다. lineSpacing 의 단위는 유형에 따라 다르다 - MULTIPLE 이면 배수 백분율(150=1.5배), EXACT 이면 pt 다.
setLineSpacing(lineSpacing: number, type?: LineSpacingType, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
lineSpacing | number | 줄 간격 값 (MULTIPLE: 배수%, EXACT: pt) |
type (선택) | LineSpacingType | 줄 간격 유형 (기본값: LineSpacingType.MULTIPLE) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setLineStyle(style)
getLineStyle() 이 반환한 선 스타일 객체를 그대로 적용한다. (getLineStyle 대칭 - 도형→도형 선 복사)
setLineStyle(style?: LineStyle): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
style (선택) | LineStyle | getLineStyle() 반환값. 생략하면 아무것도 변경하지 않는다 |
반환값
Promise<void>
setLineWidth(lineWidth)
선 두께를 설정한다.
setLineWidth(lineWidth: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
lineWidth | number | 선 두께 (pt 단위) |
반환값
Promise<void>
setMarginLeft(marginLeft, range)
단락 전체의 왼쪽 여백(UI "텍스트 앞")을 설정한다. 첫 줄만 들여쓰려면 setFirstLineIndent 를 사용한다.
setMarginLeft(marginLeft: number, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
marginLeft | number | 왼쪽 여백 (pt) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setOuterShadow(shadow)
외부 그림자를 적용한다. (getEffects().outerShadow 대칭
반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 OuterShadow 참조). 도형이 갖는 그림자는 하나다
내부 그림자가 걸려 있으면 외부 그림자로 바뀐다.
setOuterShadow(shadow?: OuterShadow): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
shadow (선택) | OuterShadow | 그림자 설정 |
반환값
Promise<void>
setParagraphStyle(style, range)
단락 서식을 한 번에 설정한다. range 를 주면 그 구간이 걸친 단락에만 적용한다. 값을 준 속성만 바뀐다. null/undefined 는 "변경 없음"으로 무시하며, 지정한 값을 상속 상태로 되돌리는 방법은 아직 없다. 단일 속성은 setLineSpacing/setMarginLeft/setFirstLineIndent/setSpaceBefore/setSpaceAfter 사용 권장. 목록 수준은 바꿀 때 딸려오는 부수 효과(글머리 기호·글자 크기)가 있어 여기 담지 않는다. (setLevel 참고)
setParagraphStyle(style: ParagraphStyle, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
style | ParagraphStyle | 단락 서식 설정 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setPatternFill(preset, foreColor, backColor, foreAlpha, backAlpha)
패턴(무늬) 채우기를 설정한다. (getFill 왕복 대칭)
setPatternFill(
preset: PatternPreset,
foreColor?: string,
backColor?: string,
foreAlpha?: number,
backAlpha?: number
): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
preset | PatternPreset | 무늬 프리셋 (apiConstants.PatternPreset) |
foreColor (선택) | string | 전경색 hex (#RRGGBB) 또는 scheme color (기본은 테마 강조색1) (기본값: "accent1") |
backColor (선택) | string | 배경색 hex (#RRGGBB) 또는 scheme color (기본은 테마 배경색1) (기본값: "bg1") |
foreAlpha (선택) | number | 전경색 투명도 (0~100, 0=불투명) (기본값: 0) |
backAlpha (선택) | number | 배경색 투명도 (0~100, 0=불투명) (기본값: 0) |
반환값
Promise<void>
setReflection(reflection)
반사 효과를 적용한다. (getEffects().reflection 대칭 - 반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 Reflection 참조).
setReflection(reflection?: Reflection): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
reflection (선택) | Reflection | 반사 설정 |
반환값
Promise<void>
setRotation(rotation)
도형의 회전 각도를 절대값으로 설정한다. 회전이 불가능한 도형이면 무시된다. (getRotation 대칭)
setRotation(rotation: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
rotation | number | 회전 각도 (degree) |
반환값
Promise<void>
setSoftEdge(softEdge)
옅은 테두리(softEdge) 효과를 적용한다. (getEffects().softEdge 대칭 - 반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 SoftEdge 참조).
setSoftEdge(softEdge?: SoftEdge): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
softEdge (선택) | SoftEdge | 옅은 테두리 설정 |
반환값
Promise<void>
setSolidFill(color, alpha)
도형 채우기를 단색으로 설정한다.
setSolidFill(color: string, alpha?: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
color | string | hex (#RRGGBB) 또는 scheme color |
alpha (선택) | number | 투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지) |
반환값
Promise<void>
setSpaceAfter(spaceAfter, range)
단락 뒤 간격(UI "문단 아래")을 설정한다.
setSpaceAfter(spaceAfter: number, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
spaceAfter | number | 단락 뒤 간격 (pt) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setSpaceBefore(spaceBefore, range)
단락 앞 간격(UI "문단 위")을 설정한다.
setSpaceBefore(spaceBefore: number, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
spaceBefore | number | 단락 앞 간격 (pt) |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setStrike(strike, range)
글자 취소선을 설정한다.
setStrike(strike: Strike, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
strike | Strike | 취소선 유형 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setText(text, range)
텍스트를 설정한다. 인자 조합에 따라 다음과 같이 동작한다.
range 없음: 전체 텍스트를 text 로 교체
range 있음: 지정한 구간만 text 로 교체
text 가 빈 문자열("")이면 교체 대신 해당 범위를 삭제
setText(text: string, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
text | string | 설정할 텍스트. 빈 문자열("")이면 삭제로 동작 |
range (선택) | TextRange | 교체할 텍스트 구간 to = from + 글자수 - 1 (0-based) 예: "가나다" 전체 = {from: 0, to: 2}, "가나다" 중 "가" = {from: 0, to: 0} offset 은 UTF-16 코드 단위라 서로게이트 페어를 가르는 range 는 반쪽이 아니라 그 글자 전체가 대상이 된다 (range 를 받는 서식 setter 도 같다) (기본값: 전체 텍스트) |
반환값
Promise<void>
setTextboxAutoFit(autoAlignType)
텍스트 상자 자동 맞춤 유형을 설정한다. 이미 같은 유형이면 아무것도 하지 않는다.
setTextboxAutoFit(autoAlignType: AutoFitType): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
autoAlignType | AutoFitType | 자동 맞춤 유형 |
반환값
Promise<void>
setTextColor(color, range)
글자 색상을 설정한다.
setTextColor(color: string, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
color | string | hex (#RRGGBB) 또는 scheme color |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setTextHyperlink(hyperlink, range)
텍스트에 하이퍼링크를 설정한다. (getTextHyperlink 대칭 - 반환 객체를 그대로 넘겨 링크를 복사할 수 있다) 도형 전체에 링크를 거는 setHyperlink 와 달리 링크가 글자(run) 단위로 걸리며 하이퍼링크 서식으로 표시된다. 지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다.
setTextHyperlink(hyperlink: Hyperlink, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
hyperlink | Hyperlink | getTextHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setTransform(transform)
도형의 위치·크기·회전을 한 번에 설정한다. getTransform() 반환값을 그대로 넘길 수 있다. (getTransform 대칭) 값을 준 필드만 크기→위치→회전 순으로 적용하고, 생략한 필드는 현재 값을 유지한다. 각 필드는 개별 setter 와 같이 해당 조작(크기/이동/회전)이 불가능한 도형에서 무시된다.
setTransform(transform?: Partial<ShapeTransform>): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
transform (선택) | Partial<ShapeTransform> | 위치/크기 (px) · 회전 (degree) |
반환값
Promise<void>
setUnderline(underline, range)
글자 밑줄을 설정한다.
setUnderline(underline: Underline, range?: TextRange): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
underline | Underline | 밑줄 유형 |
range (선택) | TextRange | 적용할 텍스트 구간 (기본값: 전체 텍스트) |
반환값
Promise<void>
setWidth(width)
도형의 너비를 설정한다. 크기 조정이 불가능한 도형이면 무시된다.
setWidth(width: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
width | number | 너비 (px 단위, 소수 한 자리로 반올림) |
반환값
Promise<void>
setX(x)
도형의 X 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. (상대 이동은 moveBy)
setX(x: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
x | number | X 좌표 (px 단위, 정수로 반올림) |
반환값
Promise<void>
setY(y)
도형의 Y 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다.
setY(y: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
y | number | Y 좌표 (px 단위, 정수로 반올림) |
반환값
Promise<void>