Show.Group
Show.Group은 Presentation 모듈(Office.show(iframe))의 객체 타입입니다. 메서드 37개.
Presentation · 객체 타입 10개 · 메서드 586개 · 네임스페이스 Show. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.
비고
- 모듈: Presentation ·
Office.show(iframe)· 네임스페이스Show - 얻는 방법:
Slide.groupShapes(shapeProxyList) - 모든 메서드는
Promise를 반환하며, 시그니처는 TypeScript 표기입니다.
메서드
| 메서드 | 설명 |
|---|---|
align(alignType) | 도형을 슬라이드 기준으로 정렬한다. |
flip(direction) | 도형을 상하 또는 좌우로 반전한다. |
getChildren() | 그룹의 자식 도형 목록을 반환한다. |
getHeight() | 도형의 높이를 반환한다. |
getHyperlink() | 도형에 설정된 하이퍼링크를 반환한다. |
getPlaceholderType() | 도형의 placeholder 종류를 반환한다. |
getPresetId() | 도형의 OOXML preset id (prst) 를 반환한다. |
getRotation() | 도형의 회전 각도를 반환한다. |
getTransform() | 도형의 위치, 크기, 회전 정보를 반환한다. |
getWidth() | 도형의 너비를 반환한다. |
getX() | 도형의 X 좌표를 반환한다. |
getY() | 도형의 Y 좌표를 반환한다. |
getZOrderIndex() | 부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다. |
hasText() | 도형이 텍스트를 담고 있는지 반환한다. |
isChart() | 이 핸들이 Chart 인지 판별한다 (union 좁히기용 type guard). |
isControl() | 이 핸들이 Control 인지 판별한다 (union 좁히기용 type guard). |
isDiagram() | 이 핸들이 Diagram 인지 판별한다 (union 좁히기용 type guard). |
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 만큼 상대 이동한다. |
removeHyperlink() | 도형의 하이퍼링크를 제거한다. |
reorder(order) | 도형의 정렬 순서(앞으로/뒤로)를 변경한다. |
setHeight(height) | 도형의 높이를 설정한다. |
setHyperlink(hyperlink) | 도형에 하이퍼링크를 설정한다. |
setRotation(rotation) | 도형의 회전 각도를 절대값으로 설정한다. |
setTransform(transform) | 도형의 위치·크기·회전을 한 번에 설정한다. |
setWidth(width) | 도형의 너비를 설정한다. |
setX(x) | 도형의 X 좌표를 절대값으로 설정한다. |
setY(y) | 도형의 Y 좌표를 절대값으로 설정한다. |
ungroup() | 그룹을 해제하여 자식 도형을 슬라이드 최상위로 분리한다. |
메서드 상세
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>
getChildren()
그룹의 자식 도형 목록을 반환한다.
getChildren(): Promise<Shape[]>;
반환값
Promise<Shape[]> - 자식 도형 목록. 그룹 도형이 없으면(협업 중 삭제 등) 빈 배열
getHeight()
도형의 높이를 반환한다. (setHeight 대칭)
getHeight(): Promise<number | null>;
반환값
Promise<number | null> - 높이 (px 단위). 대상 도형이 없으면 null
getHyperlink()
도형에 설정된 하이퍼링크를 반환한다. 반환 객체를 그대로 setHyperlink 에 넘길 수 있다. 지원하지 않는 종류(프로그램 실행·매크로 등)가 걸려 있으면 null 이다.
getHyperlink(): Promise<Hyperlink | null>;
반환값
Promise<Hyperlink | null> - 하이퍼링크 정보. 하이퍼링크(action)가 없으면 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
getTransform()
도형의 위치, 크기, 회전 정보를 반환한다. x/y 는 반전(flip) 여부와 무관하게 도형의 좌상단이라, 반환값을 다른 도형의 setTransform 에 그대로 넘기면 두 도형이 같은 자리에 놓인다. 값은 에디터 입력 단위로 반올림해 반환한다 - 크기는 소수 한 자리, 위치는 정수. setter 도 같은 단위로 넣으므로, 임포트 문서처럼 더 잘게 놓인 도형은 되넘길 때 그만큼 움직인다.
getTransform(): Promise<ShapeTransform | null>;
반환값
Promise<ShapeTransform | 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
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>
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>
removeHyperlink()
도형의 하이퍼링크를 제거한다.
removeHyperlink(): Promise<void>;
반환값
Promise<void>
reorder(order)
도형의 정렬 순서(앞으로/뒤로)를 변경한다. 이미 목표 위치라 바뀔 것이 없으면 무시된다.
reorder(order: ShapeZOrder): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
order | ShapeZOrder | 순서 변경 타입 |
반환값
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>
setRotation(rotation)
도형의 회전 각도를 절대값으로 설정한다. 회전이 불가능한 도형이면 무시된다. (getRotation 대칭)
setRotation(rotation: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
rotation | number | 회전 각도 (degree) |
반환값
Promise<void>
setTransform(transform)
도형의 위치·크기·회전을 한 번에 설정한다. getTransform() 반환값을 그대로 넘길 수 있다. (getTransform 대칭) 값을 준 필드만 크기→위치→회전 순으로 적용하고, 생략한 필드는 현재 값을 유지한다. 각 필드는 개별 setter 와 같이 해당 조작(크기/이동/회전)이 불가능한 도형에서 무시된다.
setTransform(transform?: Partial<ShapeTransform>): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
transform (선택) | Partial<ShapeTransform> | 위치/크기 (px) · 회전 (degree) |
반환값
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>
ungroup()
그룹을 해제하여 자식 도형을 슬라이드 최상위로 분리한다. 해제 후 이 Group 인스턴스와 미리 얻어 둔 자식 프록시는 무효가 된다 (자식이 새 id 를 받는다).
ungroup(): Promise<Shape[]>;
반환값
Promise<Shape[]> - 분리된 자식 도형 배열