본문으로 건너뛰기

Cell.Worksheet

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

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.getWorksheet(sheet)
  • 네비게이션 메서드(getChart(), getFilter(), getRange())는 왕복 없이 하위 핸들을 동기 반환하고, 요청은 다음 터미널 호출에서 보냅니다. 그 외 모든 메서드는 Promise를 반환합니다.

메서드​

메서드설명
addChart(chartType, dataRange, opts)이 시트에 차트를 추가하고 그 차트의 핸들을 반환한다.
addTable(dataRange, hasHeaders)이 시트에 표를 만들고 그 표의 핸들을 반환한다.
getChart(oid)ID 로 차트 핸들을 반환한다.
getChartList()이 시트의 차트 요약 목록을 반환한다.
getCommentList()이 시트의 셀 메모 목록을 반환한다.
getConditionalFormatList()이 시트의 조건부 서식 규칙 목록을 반환한다.
getDataValidationList()이 시트의 데이터 유효성 규칙 목록을 반환한다.
getFilter()이 시트의 자동 필터 핸들을 반환한다.
getFreezePanes()틀 고정 상태를 반환한다.
getHyperlinkList()이 시트의 하이퍼링크 목록을 반환한다.
getMergeCellList()이 시트의 병합 셀 목록을 반환한다.
getName()시트 이름을 반환한다.
getRange(range)이 시트의 영역을 가리키는 Range 핸들을 반환한다.
getSelection()이 시트의 선택 영역을 가리키는 Range 핸들을 반환한다.
getSheetInfo()시트 속성을 한 번에 반환한다.
getTabColor()시트 탭 색을 "#RRGGBB" 형태로 반환한다.
getTableList()이 시트의 표 요약 목록을 반환한다.
getUsedRange()값이나 셀 서식이 있는 셀을 모두 감싸는 사각 범위를 반환한다.
getZoom()화면 확대 배율을 반환한다.
goto(range)지정한 영역을 선택하고 그 영역이 보이도록 화면을 스크롤한다.
isGridlinesVisible()눈금선을 표시하는지 반환한다.
isHidden()시트가 숨겨져 있는지 반환한다.
setFreezePanes(rows, cols)틀 고정을 설정한다.
setGridlinesVisible(visible)눈금선 표시 여부를 설정한다.
setHidden(hidden)시트를 숨기거나 다시 표시한다.
setName(name)시트 이름을 변경한다.
setSelection(range)선택 영역을 설정한다.
setTabColor(color)시트 탭 색을 설정한다.
setZoom(zoomFactor)화면 확대 배율을 설정한다.
updateConditionalFormatRules(descriptor)조건부 서식 규칙을 한 번에 편집한다.

메서드 상세​

addChart(chartType, dataRange, opts)​

이 시트에 차트를 추가하고 그 차트의 핸들을 반환한다. 제목은 데이터에서 뽑아 자동으로 붙는다. 시리즈로 쓸 행이나 열은 100 개까지 지원한다.

addChart(
  chartType: ChartType,
  dataRange: string | RangeCoords,
  opts?: AddChartOptions
): Promise<Chart>;

매개변수

이름타입설명
chartTypeChartType차트 종류. 지원하지 않는 종류는 오류가 발생한다
dataRangestring | RangeCoords차트가 사용할 데이터 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")
opts (선택)AddChartOptions추가 옵션

반환값

Promise<Chart>

addTable(dataRange, hasHeaders)​

이 시트에 표를 만들고 그 표의 핸들을 반환한다. 표 이름은 자동으로 정해진다. 머리글을 쓰지 않거나 범위가 한 행뿐이면 맨 위에 빈 머리글 행이 들어가, 아래 내용이 한 행씩 밀리고 표는 범위보다 한 행 넓어진다. 공동 편집 중이거나, 범위가 행 전체·열 전체이거나 시트의 마지막 행을 포함하면 만들 수 없다.

addTable(dataRange: string | RangeCoords, hasHeaders?: boolean): Promise<Table>;

매개변수

이름타입설명
dataRangestring | RangeCoords표로 만들 범위. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")
hasHeaders (선택)boolean범위의 첫 행을 머리글로 쓸지 여부 (기본값: true)

반환값

Promise<Table>

getChart(oid)​

ID 로 차트 핸들을 반환한다. 이 시트에 있는 차트만 대상으로 한다.

getChart(oid: string): Chart;

매개변수

이름타입설명
oidstring차트를 식별하는 고유 ID. getChartList() 결과의 oid 다

반환값

Chart

getChartList()​

이 시트의 차트 요약 목록을 반환한다. 핸들이 필요하면 요약의 oid 로 getChart() 를 호출한다.

getChartList(): Promise<ChartInfo[]>;

반환값

Promise<ChartInfo[]>

getCommentList()​

이 시트의 셀 메모 목록을 반환한다.

getCommentList(): Promise<CommentInfo[]>;

반환값

Promise<CommentInfo[]>

getConditionalFormatList()​

이 시트의 조건부 서식 규칙 목록을 반환한다. 각 항목은 규칙을 다시 추가하거나 옮길 때 그대로 되돌려 넣을 수 있다.

getConditionalFormatList(): Promise<ConditionalFormatInfo[]>;

반환값

Promise<ConditionalFormatInfo[]>

getDataValidationList()​

이 시트의 데이터 유효성 규칙 목록을 반환한다.

getDataValidationList(): Promise<DataValidationRule[]>;

반환값

Promise<DataValidationRule[]>

getFilter()​

이 시트의 자동 필터 핸들을 반환한다. 자동 필터가 설정돼 있지 않아도 핸들은 돌려주므로, 설정 여부는 핸들의 getInfo() 가 주는 enabled 로 확인하고 설정은 create() 로 한다.

getFilter(): Filter;

반환값

Filter

getFreezePanes()​

틀 고정 상태를 반환한다.

getFreezePanes(): Promise<FreezePanes>;

반환값

Promise<FreezePanes>

이 시트의 하이퍼링크 목록을 반환한다.

getHyperlinkList(): Promise<HyperlinkInfo[]>;

반환값

Promise<HyperlinkInfo[]>

getMergeCellList()​

이 시트의 병합 셀 목록을 반환한다. 특정 범위와 겹치는 병합만 필요하면 Range.getMergeCellList() 를 쓴다.

getMergeCellList(): Promise<string[]>;

반환값

Promise<string[]> - 병합된 영역을 A1 표기로 담은 배열

getName()​

시트 이름을 반환한다.

getName(): Promise<string>;

반환값

Promise<string>

getRange(range)​

이 시트의 영역을 가리키는 Range 핸들을 반환한다. 핸들은 행이나 열을 삽입·삭제해도 처음 지정한 좌표를 유지한다.

getRange(range: string | RangeCoords): Range;

매개변수

이름타입설명
rangestring | RangeCoords대상 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10", 행 전체는 "5:5", 열 전체는 "A:C")

반환값

Range

getSelection()​

이 시트의 선택 영역을 가리키는 Range 핸들을 반환한다. 선택 영역은 시트마다 따로 보관되므로 활성 시트가 아닌 시트에서도 조회할 수 있다.

getSelection(): Promise<Range>;

반환값

Promise<Range>

getSheetInfo()​

시트 속성을 한 번에 반환한다. 각 항목은 같은 이름의 개별 조회 메서드와 같은 값이다.

getSheetInfo(): Promise<SheetInfo>;

반환값

Promise<SheetInfo>

getTabColor()​

시트 탭 색을 "#RRGGBB" 형태로 반환한다. 색을 지정하지 않은 시트는 빈 문자열이다.

getTabColor(): Promise<string>;

반환값

Promise<string>

getTableList()​

이 시트의 표 요약 목록을 반환한다. 핸들이 필요하면 요약의 name 으로 Workbook.getTable() 을 호출한다.

getTableList(): Promise<TableInfo[]>;

반환값

Promise<TableInfo[]>

getUsedRange()​

값이나 셀 서식이 있는 셀을 모두 감싸는 사각 범위를 반환한다. 차트·도형과 행 높이·열 너비는 이 범위에 반영하지 않는다.

getUsedRange(): Promise<Range>;

반환값

Promise<Range> - 값도 셀 서식도 없는 시트에서는 null 이다

getZoom()​

화면 확대 배율을 반환한다.

getZoom(): Promise<number>;

반환값

Promise<number> - 1 이 100% 인 배율. 퍼센트로 환산하지 않는다

goto(range)​

지정한 영역을 선택하고 그 영역이 보이도록 화면을 스크롤한다. 대상 시트가 활성 시트가 아니면 먼저 활성 시트로 만들고, 숨긴 시트를 지정하면 숨기지 않은 다른 시트로 대체해 이동한다.

goto(range: string | RangeCoords): Promise<SelectionInfo>;

매개변수

이름타입설명
rangestring | RangeCoords이동할 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")

반환값

Promise<SelectionInfo> - 숨긴 시트를 지정했다면 대체해 이동한 시트의 이름이 담긴다

isGridlinesVisible()​

눈금선을 표시하는지 반환한다.

isGridlinesVisible(): Promise<boolean>;

반환값

Promise<boolean>

isHidden()​

시트가 숨겨져 있는지 반환한다.

isHidden(): Promise<boolean>;

반환값

Promise<boolean>

setFreezePanes(rows, cols)​

틀 고정을 설정한다. 0 이하이거나 null 을 넘기면 그 방향의 고정을 해제한다.

setFreezePanes(rows?: number | null, cols?: number | null): Promise<void>;

매개변수

이름타입설명
rows (선택)number | null고정할 상단 행 수 (기본값: 0)
cols (선택)number | null고정할 좌측 열 수 (기본값: 0)

반환값

Promise<void>

setGridlinesVisible(visible)​

눈금선 표시 여부를 설정한다.

setGridlinesVisible(visible: boolean): Promise<void>;

매개변수

이름타입설명
visiblebooleantrue 면 눈금선을 표시하고 false 면 감춘다

반환값

Promise<void>

setHidden(hidden)​

시트를 숨기거나 다시 표시한다. 숨기지 않은 시트가 이 시트 하나뿐이면 동작하지 않는다. 활성 시트를 숨기면 인접한 숨기지 않은 시트가 활성 시트가 된다.

setHidden(hidden: boolean): Promise<void>;

매개변수

이름타입설명
hiddenbooleantrue 면 숨기고 false 면 다시 표시한다

반환값

Promise<void>

setName(name)​

시트 이름을 변경한다.

setName(name: string): Promise<void>;

매개변수

이름타입설명
namestring새 시트 이름

반환값

Promise<void>

setSelection(range)​

선택 영역을 설정한다. 대상 시트가 활성 시트가 아니면 먼저 활성 시트로 만들며, 숨긴 시트는 활성화할 수 없어 오류가 발생한다. 선택한 영역이 보이도록 화면을 스크롤하려면 goto() 를 쓴다.

setSelection(range: string | RangeCoords): Promise<SelectionInfo>;

매개변수

이름타입설명
rangestring | RangeCoords선택할 영역. A1 표기 문자열로도 지정할 수 있다("A1:B2", 단일 셀은 "E10")

반환값

Promise<SelectionInfo>

setTabColor(color)​

시트 탭 색을 설정한다. 빈 문자열이나 null 을 넘기거나 생략하면 지정된 탭 색을 지운다.

setTabColor(color?: string | null): Promise<void>;

매개변수

이름타입설명
color (선택)string | null탭 색. "#RRGGBB" 외에 3·4·8 자리 hex, "#" 을 생략한 hex, "red" 같은 색 이름도 받는다

반환값

Promise<void>

setZoom(zoomFactor)​

화면 확대 배율을 설정한다. 허용 범위를 벗어난 값은 경계값으로 맞추지 않고 오류가 발생한다.

setZoom(zoomFactor: number): Promise<void>;

매개변수

이름타입설명
zoomFactornumber1 이 100% 인 배율. 0.5 이상 1.5 이하여야 한다

반환값

Promise<void>

updateConditionalFormatRules(descriptor)​

조건부 서식 규칙을 한 번에 편집한다. 규칙 삭제·적용 영역 변경·우선순위 이동을 한 묶음으로 처리해 하나라도 적용할 수 없으면 아무것도 바뀌지 않는다. 규칙의 조건 자체는 바꿀 수 없어, 조건을 바꾸려면 규칙을 지우고 다시 추가한다.

updateConditionalFormatRules(descriptor: ConditionalFormatUpdate): Promise<void>;

매개변수

이름타입설명
descriptorConditionalFormatUpdate적용할 편집 내용

반환값

Promise<void>