Cell.Chart

Cell.Chart은 Spreadsheet 모듈(Office.cell(iframe))의 객체 타입입니다. 메서드 22개.

Generated from the SDK type definitions

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

비고

모듈: Spreadsheet · Office.cell(iframe) · 네임스페이스 Cell
얻는 방법: Workbook.getObjectById(oid), Worksheet.addChart(chartType, dataRange, opts), Worksheet.getChart(oid)
모든 메서드는 Promise를 반환하며, 시그니처는 TypeScript 표기입니다.

메서드

메서드	설명
`delete()`	차트를 삭제한다.
`getAxisTitle(axis)`	지정한 축의 제목을 반환한다.
`getDataLabelPosition()`	데이터레이블 위치를 반환한다.
`getDataRange()`	차트가 데이터로 삼는 셀 범위를 A1 표기 문자열로 반환한다.
`getGridLine(axis)`	지정한 축의 눈금선 종류를 반환한다.
`getId()`	이 차트를 식별하는 고유 ID 를 반환한다.
`getInfo()`	차트의 요약 정보를 반환한다.
`getLegendPosition()`	범례 위치를 반환한다.
`getState()`	차트의 서식 상태를 한 번에 반환한다.
`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>

`getDataLabelPosition()`

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

getDataLabelPosition(): Promise<ChartDataLabelPosition>;

반환값

Promise<ChartDataLabelPosition>

`getDataRange()`

차트가 데이터로 삼는 셀 범위를 A1 표기 문자열로 반환한다. 참조가 여러 시트에 걸쳐 있거나 하나의 사각 영역으로 합쳐지지 않으면 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>

`getInfo()`

차트의 요약 정보를 반환한다. range 는 getDataRange 와 같은 규약을 따른다.

getInfo(): Promise<ChartInfo>;

반환값

Promise<ChartInfo>

`getLegendPosition()`

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

getLegendPosition(): Promise<ChartLegendPosition>;

반환값

Promise<ChartLegendPosition>

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

`getType()`

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

getType(): Promise<string>;

반환값

Promise<string>

`isEditable()`

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

isEditable(): Promise<boolean>;

반환값

Promise<boolean>

`setAxisTitle(axis, title)`

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

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

매개변수

이름	타입	설명
`axis`	`ChartAxis`	제목을 설정할 축(가로축 또는 세로축)
`title`	`string`	축에 표시할 제목

반환값

Promise<void>

`setDataLabelPosition(position)`

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

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

매개변수

이름	타입	설명
`position`	`ChartDataLabelPosition`	데이터레이블을 놓을 자리

반환값

Promise<void>

`setDataRange(dataRange, seriesBy)`

차트의 데이터 소스 범위를 바꾼다. 행과 열은 각각 100 개까지 지원한다. seriesBy 를 생략하면 지금의 시리즈 방향을 유지한다.

setDataRange(
  dataRange: string | RangeCoords,
  seriesBy?: "auto" | "rows" | "columns"
): Promise<void>;

매개변수

이름	타입	설명
`dataRange`	`string \| RangeCoords`	새 데이터 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")
`seriesBy` (선택)	`"auto" \| "rows" \| "columns"`	시리즈 방향. rows 는 행 하나가, columns 는 열 하나가 시리즈가 되고, auto 는 새 범위의 모양에 맞춰 정한다. 분산형과 거품형 차트는 rows·columns 를 받지 않는다

반환값

Promise<void>

`setGridLine(axis, gridType)`

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

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

매개변수

이름	타입	설명
`axis`	`ChartAxis`	눈금선을 설정할 축(가로축 또는 세로축)
`gridType`	`ChartGridLineType`	표시할 눈금선 종류

반환값

Promise<void>

`setLegendPosition(position)`

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

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

매개변수

이름	타입	설명
`position`	`ChartLegendPosition`	범례를 놓을 자리

반환값

Promise<void>

`setPosition(startCell)`

차트의 왼쪽 위 모서리를 지정한 셀로 옮긴다. 크기는 그대로 둔다. startCell 에 여러 셀로 이루어진 범위를 넘기면 그 범위의 왼쪽 위 셀만 쓰고 나머지는 무시한다.

setPosition(startCell: string | RangeCoords): Promise<void>;

매개변수

이름	타입	설명
`startCell`	`string \| RangeCoords`	옮겨 놓을 셀. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")

반환값

Promise<void>

`setStyle(style)`

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

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

매개변수

이름	타입	설명
`style`	`number`	스타일 번호(1~~12 정수). 세 개씩 색 그룹이 나뉘고(1~~3, 4~~6, 7~~9, 10~12), 한 그룹 안의 세 번호는 배경만 다르다(반투명 배경, 흰색 배경, 색상 배경과 계열 테두리 순)

반환값

Promise<void>

`setTitle(title)`

차트 제목을 설정한다.

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

매개변수

이름	타입	설명
`title`	`string`	차트에 표시할 제목

반환값

Promise<void>

`setType(chartType)`

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

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

매개변수

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

반환값

Promise<void>

`switchRowColumn()`

데이터의 행과 열을 맞바꿔 시리즈 방향을 전환한다. 호출할 때마다 방향이 번갈아 바뀐다. 분산형과 거품형 차트는 전환할 수 없고, 데이터 범위가 없거나 행이나 열이 100개를 넘는 차트도 전환할 수 없다.

switchRowColumn(): Promise<void>;

반환값

Promise<void>

비고​

메서드​

메서드 상세​

delete()​

getAxisTitle(axis)​

getDataLabelPosition()​

getDataRange()​

getGridLine(axis)​

getId()​

getInfo()​

getLegendPosition()​

getState()​

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()`

`getAxisTitle(axis)`

`getDataLabelPosition()`

`getDataRange()`

`getGridLine(axis)`

`getId()`

`getInfo()`

`getLegendPosition()`

`getState()`

`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()`