Cell.Chart
Cell.Chart은 Spreadsheet 모듈(Office.cell(iframe))의 객체 타입입니다. 메서드 21개.
비고
- 모듈: Spreadsheet ·
Office.cell(iframe)· 네임스페이스Cell - 얻는 방법:
Workbook.getObjectById(oid),Worksheet.addChart(chartType, dataRange, seriesBy),Worksheet.getChart(oid) - 모든 메서드는
Promise를 반환하며, 시그니처는 TypeScript 표기입니다.
메서드
| 메서드 | 설명 |
|---|---|
delete() | 차트를 삭제한다. |
getAxisTitle(axis) | 지정한 축의 제목을 반환한다. |
getChartInfo() | 차트의 종류·제목·범례·데이터레이블·축 제목·눈금선 상태와 식별자, 데이터 범위를 한 번에 반환한다. |
getDataLabelPosition() | 데이터레이블 위치를 반환한다. |
getDataRange() | 차트가 데이터로 삼는 셀 범위를 시트 이름을 앞에 붙인 A1 표기 문자열로 반환한다("Sheet1!A1:C5"). |
getGridLine(axis) | 지정한 축의 눈금선 종류를 반환한다. |
getId() | 이 차트를 식별하는 고유 ID 를 반환한다. |
getLegendPosition() | 범례 위치를 반환한다. |
getTitle() | 차트 제목을 반환한다. |
getType() | 차트 종류를 반환한다. |
isEditable() | 이 차트를 편집할 수 있는지 반환한다. |
setAxisTitle(axis, title) | 지정한 축의 제목을 설정한다. |
setDataLabelPosition(position) | 데이터레이블 위치를 설정한다. |
setDataRange(dataRange, seriesBy) | 차트의 데이터 소스 범위를 바꾼다. |
setGridLine(axis, gridType) | 지정한 축의 눈금선을 설정한다. |
setLegendPosition(position) | 범례 위치를 설정한다. |
setPosition(startCell) | 차트의 왼쪽 위 모서리를 지정한 셀로 옮긴다. |
setStyle(style) | 차트의 프리셋 스타일을 바꾼다. |
setTitle(title) | 차트 제목을 설정한다. |
setType(chartType) | 차트 종류를 바꾼다. |
switchRowColumn() | 데이터의 행과 열을 맞바꿔 시리즈 방향을 전환한다. |
메서드 상세
delete()
차트를 삭제한다.
delete(): Promise<CommandResult>;
반환값
Promise<CommandResult>
getAxisTitle(axis)
지정한 축의 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열이고, 축 제목을 갖지 않는 차트 종류(원형 계열·도넛·방사형)는 null 을 반환한다.
getAxisTitle(axis: ChartAxis): Promise<string | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
axis | ChartAxis | 제목을 읽을 축(가로축 또는 세로축) |
반환값
Promise<string | null>
getChartInfo()
차트의 종류·제목·범례·데이터레이블·축 제목·눈금선 상태와 식별자, 데이터 범위를 한 번에 반환한다. 각 서식 값은 이름이 같은 조회 메서드와 같다.
getChartInfo(): Promise<ChartInfo>;
반환값
Promise<ChartInfo>
getDataLabelPosition()
데이터레이블 위치를 반환한다. 데이터레이블이 설정되지 않은 차트는 "none" 이고, 데이터레이블을 갖지 않는 차트 종류(표면형)는 null 을 반환한다.
getDataLabelPosition(): Promise<ChartDataLabelPosition | null>;
반환값
Promise<ChartDataLabelPosition | null>
getDataRange()
차트가 데이터로 삼는 셀 범위를 시트 이름을 앞에 붙인 A1 표기 문자열로 반환한다("Sheet1!A1:C5"). 참조가 여러 시트에 걸쳐 있거나 하나의 사각 영역으로 합쳐지지 않으면 null 을 반환한다.
getDataRange(): Promise<string | null>;
반환값
Promise<string | null>
getGridLine(axis)
지정한 축의 눈금선 종류를 반환한다. 눈금선을 꺼 둔 축은 "none" 이고, 그 축의 눈금선을 갖지 않는 차트 종류(원형 계열·도넛은 양축, 방사형은 세로축)는 null 을 반환한다.
getGridLine(axis: ChartAxis): Promise<ChartGridLineType | null>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
axis | ChartAxis | 눈금선을 읽을 축(가로축 또는 세로축) |
반환값
Promise<ChartGridLineType | null>
getId()
이 차트를 식별하는 고유 ID 를 반환한다.
getId(): Promise<string>;
반환값
Promise<string>
getLegendPosition()
범례 위치를 반환한다. 범례를 숨긴 차트는 "none" 이고, 위치를 알아낼 수 없는 차트는 "right" 로 보고한다.
getLegendPosition(): Promise<ChartLegendPosition>;
반환값
Promise<ChartLegendPosition>
getTitle()
차트 제목을 반환한다. 제목을 설정하지 않았으면 빈 문자열을 반환한다.
getTitle(): Promise<string>;
반환값
Promise<string>
getType()
차트 종류를 반환한다. 파일에서 읽은 100% 누적 막대형·거품형 차트는 ChartType 에 없는 그 종류의 이름을, 그 밖에 ChartType 에 없는 종류는 "unknown" 을 반환한다.
getType(): Promise<ChartType | "percent_stacked_column" | "percent_stacked_bar" | "bubble" | "3d_bubble" | "unknown">;
반환값
Promise<ChartType | "percent_stacked_column" | "percent_stacked_bar" | "bubble" | "3d_bubble" | "unknown">
isEditable()
이 차트를 편집할 수 있는지 반환한다. 외부 데이터를 소스로 하는 차트는 조회만 되고 편집은 되지 않는다.
isEditable(): Promise<boolean>;
반환값
Promise<boolean>
setAxisTitle(axis, title)
지정한 축의 제목을 설정한다. 축 제목은 원형 계열·도넛·방사형을 뺀 차트 종류에서 지원한다. 빈 문자열을 넘기면 축 제목을 비운다.
setAxisTitle(axis: ChartAxis, title: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
axis | ChartAxis | 제목을 설정할 축(가로축 또는 세로축) |
title | string | 축에 표시할 제목. 255자까지 지원한다 |
반환값
none
setDataLabelPosition(position)
데이터레이블 위치를 설정한다. "none" 을 넘기면 데이터레이블을 없앤다. 데이터레이블 설정은 2차원 차트(원형 대 원형·주식형·표면형 제외)에서만 쓸 수 있고, 3차원 차트는 현재 지원하지 않는다. 쓸 수 있는 위치는 차트 종류마다 다르다.
setDataLabelPosition(position: ChartDataLabelPosition): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
position | ChartDataLabelPosition | 데이터레이블을 놓을 자리 |
반환값
none
setDataRange(dataRange, seriesBy)
차트의 데이터 소스 범위를 바꾼다. 행과 열은 각각 100 개까지 지원한다. 시트를 지정하지 않으면 차트가 놓인 시트의 영역으로 처리한다. seriesBy 를 생략하면 지금의 시리즈 방향을 유지한다.
setDataRange(
dataRange: string | SheetRangeCoords | RangeCoords,
seriesBy?: ChartSeriesBy
): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
dataRange | string | SheetRangeCoords | RangeCoords | 새 데이터 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10", 다른 시트는 "Sheet2!A1:C5"). 문자열은 영역 하나만 받는다("A1:B2,D1:E2" 처럼 여러 영역은 받지 않는다) |
seriesBy (선택) | ChartSeriesBy | 시리즈 방향. AUTO 는 새 범위의 모양에 맞춰 정한다 |
반환값
none
setGridLine(axis, gridType)
지정한 축의 눈금선을 설정한다. "none" 을 넘기면 그 축의 눈금선을 숨긴다. 눈금선은 그 축의 눈금선을 갖는 차트 종류에서 지원한다(원형 계열·도넛은 양축, 방사형은 세로축이 없다).
setGridLine(axis: ChartAxis, gridType: ChartGridLineType): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
axis | ChartAxis | 눈금선을 설정할 축(가로축 또는 세로축) |
gridType | ChartGridLineType | 표시할 눈금선 종류 |
반환값
none
setLegendPosition(position)
범례 위치를 설정한다. "none" 을 넘기면 범례를 숨긴다.
setLegendPosition(position: ChartLegendPosition): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
position | ChartLegendPosition | 범례를 놓을 자리 |
반환값
none
setPosition(startCell)
차트의 왼쪽 위 모서리를 지정한 셀로 옮긴다. 크기는 그대로 둔다. startCell 에 여러 셀로 이루어진 범위를 넘기면 그 범위의 왼쪽 위 셀만 쓰고 나머지는 무시한다.
setPosition(startCell: string | RangeCoords): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
startCell | string | RangeCoords | 옮겨 놓을 셀. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10") |
반환값
none
setStyle(style)
차트의 프리셋 스타일을 바꾼다. 번호에 대응하는 실제 색은 문서 테마를 따른다.
setStyle(style: number): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
style | number | 스타일 번호(1 |
반환값
none
setTitle(title)
차트 제목을 설정한다. 빈 문자열을 넘기면 제목을 비운다.
setTitle(title: string): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
title | string | 차트에 표시할 제목. 255자까지 지원한다 |
반환값
none
setType(chartType)
차트 종류를 바꾼다. 지금 종류와 같은 값을 넘기면 아무것도 바뀌지 않는다.
setType(chartType: ChartType): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
chartType | ChartType | 바꿀 차트 종류(enum 문자열, 예: "clustered_column") |
반환값
none
switchRowColumn()
데이터의 행과 열을 맞바꿔 시리즈 방향을 전환한다. 호출할 때마다 방향이 번갈아 바뀐다. 분산형과 거품형 차트, 데이터 범위가 없는 차트는 전환할 수 없다. 행과 열은 각각 100 개까지 지원한다.
switchRowColumn(): Promise<void>;
반환값
none