본문으로 건너뛰기

Show.Chart

Show.Chart은 Presentation 모듈(Office.show(iframe))의 객체 타입입니다. 메서드 50개.

Generated from the SDK type definitions

Presentation · 객체 타입 10개 · 메서드 586개 · 네임스페이스 Show. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.

비고​

메서드​

메서드설명
align(alignType)도형을 슬라이드 기준으로 정렬한다.
flip(direction)도형을 상하 또는 좌우로 반전한다.
getAxisTitle(axis)지정한 축의 제목을 반환한다.
getDataLabelPosition()데이터레이블 위치를 반환한다.
getGridLine(axis)지정한 축의 눈금선 종류를 반환한다.
getHeight()도형의 높이를 반환한다.
getHyperlink()도형에 설정된 하이퍼링크를 반환한다.
getLegendPosition()범례 위치를 반환한다.
getPlaceholderType()도형의 placeholder 종류를 반환한다.
getPresetId()도형의 OOXML preset id (prst) 를 반환한다.
getRotation()도형의 회전 각도를 반환한다.
getState()차트의 서식 상태를 한 번에 반환한다.
getTitle()차트 제목을 반환한다.
getTransform()도형의 위치, 크기, 회전 정보를 반환한다.
getType()차트 종류를 반환한다.
getWidth()도형의 너비를 반환한다.
getX()도형의 X 좌표를 반환한다.
getY()도형의 Y 좌표를 반환한다.
getZOrderIndex()부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다.
hasText()도형이 텍스트를 담고 있는지 반환한다.
isChart()이 핸들이 Chart 인지 판별한다 (union 좁히기용 type guard).
isControl()이 핸들이 Control 인지 판별한다 (union 좁히기용 type guard).
isDiagram()이 핸들이 Diagram 인지 판별한다 (union 좁히기용 type guard).
isEditable()이 차트를 편집할 수 있는지 반환한다.
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)도형의 정렬 순서(앞으로/뒤로)를 변경한다.
setAxisTitle(axis, title)지정한 축의 제목을 설정한다.
setDataLabelPosition(position)데이터레이블 위치를 설정한다.
setGridLine(axis, gridType)지정한 축의 눈금선을 설정한다.
setHeight(height)도형의 높이를 설정한다.
setHyperlink(hyperlink)도형에 하이퍼링크를 설정한다.
setLegendPosition(position)범례 위치를 설정한다.
setRotation(rotation)도형의 회전 각도를 절대값으로 설정한다.
setStyle(style)차트의 프리셋 스타일을 바꾼다.
setTitle(title)차트 제목을 설정한다.
setTransform(transform)도형의 위치·크기·회전을 한 번에 설정한다.
setType(chartType)차트 종류를 바꾼다.
setWidth(width)도형의 너비를 설정한다.
setX(x)도형의 X 좌표를 절대값으로 설정한다.
setY(y)도형의 Y 좌표를 절대값으로 설정한다.

메서드 상세​

align(alignType)​

도형을 슬라이드 기준으로 정렬한다. 이동이 불가능한 도형이면 무시된다. 그룹 자식도 그룹 안이 아니라 슬라이드를 기준으로 움직인다(에디터와 같다). 자식이 그룹 밖으로 나가면 그룹이 자식을 담도록 함께 넓어진다.

align(alignType: AlignType): Promise<void>;

매개변수

이름타입설명
alignTypeAlignType정렬 타입

반환값

Promise<void>

flip(direction)​

도형을 상하 또는 좌우로 반전한다. 현재 반전 상태를 뒤집는 토글이며, 지금 반전돼 있는지는 isFlippedH()/isFlippedV() 로 읽는다. 회전이 불가능한 도형에서는 반전도 무시된다. 회전된 도형은 각도도 거울상으로 함께 바뀐다 (getRotation() 값이 360 - 기존 각도 로 바뀐다).

flip(direction: FlipDirection): Promise<void>;

매개변수

이름타입설명
directionFlipDirection반전 방향

반환값

Promise<void>

getAxisTitle(axis)​

지정한 축의 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열이고, 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null 을 반환한다.

getAxisTitle(axis: ChartAxis): Promise<string | null>;

매개변수

이름타입설명
axisChartAxis제목을 읽을 축(가로축 또는 세로축)

반환값

Promise<string | null>

getDataLabelPosition()​

데이터레이블 위치를 반환한다. 데이터레이블을 표시하지 않는 차트는 "none" 을 반환한다.

getDataLabelPosition(): Promise<ChartDataLabelPosition>;

반환값

Promise<ChartDataLabelPosition>

getGridLine(axis)​

지정한 축의 눈금선 종류를 반환한다. 눈금선을 꺼 둔 축은 "none" 이고, 그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 null 을 반환한다.

getGridLine(axis: ChartAxis): Promise<ChartGridLineType | null>;

매개변수

이름타입설명
axisChartAxis눈금선을 읽을 축(가로축 또는 세로축)

반환값

Promise<ChartGridLineType | null>

getHeight()​

도형의 높이를 반환한다. (setHeight 대칭)

getHeight(): Promise<number | null>;

반환값

Promise<number | null> - 높이 (px 단위). 대상 도형이 없으면 null

도형에 설정된 하이퍼링크를 반환한다. 반환 객체를 그대로 setHyperlink 에 넘길 수 있다. 지원하지 않는 종류(프로그램 실행·매크로 등)가 걸려 있으면 null 이다.

getHyperlink(): Promise<Hyperlink | null>;

반환값

Promise<Hyperlink | null> - 하이퍼링크 정보. 하이퍼링크(action)가 없으면 null

getLegendPosition()​

범례 위치를 반환한다. 범례를 숨긴 차트는 "none" 이고, 위치를 알아낼 수 없는 차트는 "right" 로 보고한다.

getLegendPosition(): Promise<ChartLegendPosition>;

반환값

Promise<ChartLegendPosition>

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

getState()​

차트의 서식 상태를 한 번에 반환한다. 각 값은 이름이 같은 조회 메서드와 같은 규약을 따른다. axisTitle 과 gridLine 의 null 은 그 차트 종류에 해당 축의 제목·눈금선이 아예 없다는 뜻이고, "none" 은 쓸 수는 있지만 꺼져 있다는 뜻이다.

getState(): Promise<{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string | null; vertical: string | null }; gridLine: { horizontal: ChartGridLineType | null; vertical: ChartGridLineType | null } }>;

반환값

Promise<{ type: string; title: string; legendPosition: ChartLegendPosition; dataLabelPosition: ChartDataLabelPosition; axisTitle: { horizontal: string | null; vertical: string | null }; gridLine: { horizontal: ChartGridLineType | null; vertical: ChartGridLineType | null } }>

getTitle()​

차트 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열을 반환한다.

getTitle(): Promise<string>;

반환값

Promise<string>

getTransform()​

도형의 위치, 크기, 회전 정보를 반환한다. x/y 는 반전(flip) 여부와 무관하게 도형의 좌상단이라, 반환값을 다른 도형의 setTransform 에 그대로 넘기면 두 도형이 같은 자리에 놓인다. 값은 에디터 입력 단위로 반올림해 반환한다 - 크기는 소수 한 자리, 위치는 정수. setter 도 같은 단위로 넣으므로, 임포트 문서처럼 더 잘게 놓인 도형은 되넘길 때 그만큼 움직인다.

getTransform(): Promise<ShapeTransform | null>;

반환값

Promise<ShapeTransform | null> - 도형의 위치·크기·회전 정보. 대상 도형이 없으면(협업 중 삭제 등) null

getType()​

차트 종류를 반환한다. ChartType 에 없는 종류는 "unknown" 을 반환한다.

getType(): Promise<string>;

반환값

Promise<string>

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>

isEditable()​

이 차트를 편집할 수 있는지 반환한다. 외부 데이터를 소스로 하는 차트는 조회만 되고 편집은 되지 않는다.

isEditable(): Promise<boolean>;

반환값

Promise<boolean>

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>;

매개변수

이름타입설명
distanceShapeMoveDistance이동량 (px 단위)

반환값

Promise<void>

도형의 하이퍼링크를 제거한다.

removeHyperlink(): Promise<void>;

반환값

Promise<void>

reorder(order)​

도형의 정렬 순서(앞으로/뒤로)를 변경한다. 이미 목표 위치라 바뀔 것이 없으면 무시된다.

reorder(order: ShapeZOrder): Promise<void>;

매개변수

이름타입설명
orderShapeZOrder순서 변경 타입

반환값

Promise<void>

setAxisTitle(axis, title)​

지정한 축의 제목을 설정한다. 축 제목은 원형 계열·도넛·방사형을 뺀 차트 종류에서 지원한다.

setAxisTitle(axis: ChartAxis, title: string): Promise<void>;

매개변수

이름타입설명
axisChartAxis제목을 설정할 축(가로축 또는 세로축)
titlestring축에 표시할 제목

반환값

Promise<void>

setDataLabelPosition(position)​

데이터레이블 위치를 설정한다. "none" 을 넘기면 데이터레이블을 숨긴다. 쓸 수 있는 위치는 차트 종류마다 다르며, "none" 은 모든 종류에서 쓸 수 있다.

setDataLabelPosition(position: ChartDataLabelPosition): Promise<void>;

매개변수

이름타입설명
positionChartDataLabelPosition데이터레이블을 놓을 자리

반환값

Promise<void>

setGridLine(axis, gridType)​

지정한 축의 눈금선을 설정한다. "none" 을 넘기면 그 축의 눈금선을 숨긴다. 그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 "none" 을 포함해 어떤 값을 넘겨도 오류가 발생한다.

setGridLine(axis: ChartAxis, gridType: ChartGridLineType): Promise<void>;

매개변수

이름타입설명
axisChartAxis눈금선을 설정할 축(가로축 또는 세로축)
gridTypeChartGridLineType표시할 눈금선 종류

반환값

Promise<void>

setHeight(height)​

도형의 높이를 설정한다. 크기 조정이 불가능한 도형이면 무시된다.

setHeight(height: number): Promise<void>;

매개변수

이름타입설명
heightnumber높이 (px 단위, 소수 한 자리로 반올림)

반환값

Promise<void>

도형에 하이퍼링크를 설정한다. (getHyperlink 대칭 - 반환 객체를 그대로 넘겨 하이퍼링크를 복사할 수 있다) 지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다.

setHyperlink(hyperlink: Hyperlink): Promise<void>;

매개변수

이름타입설명
hyperlinkHyperlinkgetHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다

반환값

Promise<void>

setLegendPosition(position)​

범례 위치를 설정한다. "none" 을 넘기면 범례를 숨긴다.

setLegendPosition(position: ChartLegendPosition): Promise<void>;

매개변수

이름타입설명
positionChartLegendPosition범례를 놓을 자리

반환값

Promise<void>

setRotation(rotation)​

도형의 회전 각도를 절대값으로 설정한다. 회전이 불가능한 도형이면 무시된다. (getRotation 대칭)

setRotation(rotation: number): Promise<void>;

매개변수

이름타입설명
rotationnumber회전 각도 (degree)

반환값

Promise<void>

setStyle(style)​

차트의 프리셋 스타일을 바꾼다. 번호에 대응하는 실제 색은 문서 테마를 따른다.

setStyle(style: number): Promise<void>;

매개변수

이름타입설명
stylenumber스타일 번호(112 정수). 세 개씩 색 그룹이 나뉘고(13, 46, 79, 10~12), 한 그룹 안의 세 번호는 배경만 다르다(반투명 배경, 흰색 배경, 색상 배경과 계열 테두리 순)

반환값

Promise<void>

setTitle(title)​

차트 제목을 설정한다.

setTitle(title: string): Promise<void>;

매개변수

이름타입설명
titlestring차트에 표시할 제목

반환값

Promise<void>

setTransform(transform)​

도형의 위치·크기·회전을 한 번에 설정한다. getTransform() 반환값을 그대로 넘길 수 있다. (getTransform 대칭) 값을 준 필드만 크기→위치→회전 순으로 적용하고, 생략한 필드는 현재 값을 유지한다. 각 필드는 개별 setter 와 같이 해당 조작(크기/이동/회전)이 불가능한 도형에서 무시된다.

setTransform(transform?: Partial<ShapeTransform>): Promise<void>;

매개변수

이름타입설명
transform (선택)Partial<ShapeTransform>위치/크기 (px) · 회전 (degree)

반환값

Promise<void>

setType(chartType)​

차트 종류를 바꾼다. 지금 종류와 같은 값을 넘기면 아무것도 바뀌지 않는다.

setType(chartType: ChartType): Promise<void>;

매개변수

이름타입설명
chartTypeChartType바꿀 차트 종류(enum 문자열, 예: "clustered_column")

반환값

Promise<void>

setWidth(width)​

도형의 너비를 설정한다. 크기 조정이 불가능한 도형이면 무시된다.

setWidth(width: number): Promise<void>;

매개변수

이름타입설명
widthnumber너비 (px 단위, 소수 한 자리로 반올림)

반환값

Promise<void>

setX(x)​

도형의 X 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. (상대 이동은 moveBy)

setX(x: number): Promise<void>;

매개변수

이름타입설명
xnumberX 좌표 (px 단위, 정수로 반올림)

반환값

Promise<void>

setY(y)​

도형의 Y 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다.

setY(y: number): Promise<void>;

매개변수

이름타입설명
ynumberY 좌표 (px 단위, 정수로 반올림)

반환값

Promise<void>