본문으로 건너뛰기

Cell.Workbook

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

Generated from the SDK type definitions

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

비고​

  • 모듈: Spreadsheet · Office.cell(iframe) · 네임스페이스 Cell
  • 얻는 방법: app.getDocument() / app.getWorkbook() (루트 핸들). Office.cell(iframe)이 반환하는 앱 핸들에서 얻습니다. 문서 메서드는 앱 핸들이 아니라 이 핸들에 있습니다.
  • 네비게이션 메서드(getDefinedName(), getObjectById(), getTable())는 왕복 없이 하위 핸들을 동기 반환하고, 요청은 다음 터미널 호출에서 보냅니다. 그 외 모든 메서드는 Promise를 반환합니다.

메서드​

메서드설명
addDefinedName(name, formula, sheet)정의된 이름을 만든다.
addSheet(name)새 시트를 시트 목록 맨 뒤에 추가하고, 추가한 시트를 활성 시트로 만든다.
copySheet(sheet)시트를 복사해 원본 바로 뒤에 넣고, 복사본을 활성 시트로 만든다.
getDefinedName(name, sheet)전달한 name 을 이름으로 하는 정의된 이름을 반환한다.
getDefinedNameList(sheet)정의된 이름 목록을 반환한다.
getDocumentProperties()문서 속성을 반환한다.
getObjectById(oid)ID 로 객체 핸들을 반환한다.
getSheetList()문서의 시트 구성을 배열로 반환한다.
getTable(name)이름으로 표 핸들을 반환한다.
getWorksheet(sheet)시트 핸들을 반환한다.
moveSheet(from, to)시트 위치를 이동한다.
removeSheet(sheet)시트를 삭제한다.
setActiveSheet(sheet)활성 시트를 변경한다.

메서드 상세​

addDefinedName(name, formula, sheet)​

정의된 이름을 만든다. formula 는 = 로 시작해도 되고 아니어도 된다. 수식에서 시트를 지정하지 않은 참조는 활성 시트 기준으로 해석한다. sheet 를 생략하면 문서 전체에서 쓰는 이름으로 만든다. 같은 이름의 정의된 이름이나 표가 이미 있으면 만들어지지 않고 오류가 발생한다.

addDefinedName(name: string, formula: string, sheet?: number | string): Promise<Name>;

매개변수

이름타입설명
namestring만들 이름
formulastring이름이 가리킬 수식 또는 참조
sheet (선택)number | string특정 시트에서만 쓸 이름이면 그 시트

반환값

Promise<Name>

addSheet(name)​

새 시트를 시트 목록 맨 뒤에 추가하고, 추가한 시트를 활성 시트로 만든다.

addSheet(name: string): Promise<SheetRef>;

매개변수

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

반환값

Promise<SheetRef>

copySheet(sheet)​

시트를 복사해 원본 바로 뒤에 넣고, 복사본을 활성 시트로 만든다.

copySheet(sheet: number | string): Promise<SheetRef>;

매개변수

이름타입설명
sheetnumber | string복사할 시트

반환값

Promise<SheetRef>

getDefinedName(name, sheet)​

전달한 name 을 이름으로 하는 정의된 이름을 반환한다. 이름은 대소문자를 구분하지 않는다. sheet 를 생략하면 문서 전체에서 쓰는 이름만 찾는다.

getDefinedName(name: string, sheet?: number | string): Name;

매개변수

이름타입설명
namestring찾을 이름
sheet (선택)number | string특정 시트에서만 쓰는 이름이면 그 시트

반환값

Name

getDefinedNameList(sheet)​

정의된 이름 목록을 반환한다. 내장 이름, 숨긴 이름, 수식이 없는 이름은 제외한다. sheet 를 생략하면 문서 전체에서 쓰는 이름을 반환한다. formula 는 = 으로 시작한다.

getDefinedNameList(sheet?: number | string): Promise<NameInfo[]>;

매개변수

이름타입설명
sheet (선택)number | string특정 시트에서만 쓰는 이름이면 그 시트

반환값

Promise<NameInfo[]>

getDocumentProperties()​

문서 속성을 반환한다. 문서에 없는 속성은 undefined 값을 가진다.

getDocumentProperties(): Promise<DocumentProperties>;

반환값

Promise<DocumentProperties>

getObjectById(oid)​

ID 로 객체 핸들을 반환한다. 문서의 모든 시트를 대상으로 하며, 현재는 차트 객체만 지원한다. 차트가 아닌 객체는 null 을 반환한다.

getObjectById(oid: string): Chart;

매개변수

이름타입설명
oidstring객체를 식별하는 고유 ID

반환값

Chart

getSheetList()​

문서의 시트 구성을 배열로 반환한다. 배열 인덱스가 곧 시트 인덱스(0-based)이며 숨긴 시트도 포함한다. 각 시트의 상세 속성은 Worksheet 에서 조회한다.

getSheetList(): Promise<SheetSummary[]>;

반환값

Promise<SheetSummary[]>

getTable(name)​

이름으로 표 핸들을 반환한다. 이름은 대소문자를 구분하지 않으며, 핸들에는 실제 저장된 표 이름이 담긴다.

getTable(name: string): Table;

매개변수

이름타입설명
namestring표 이름. 문서 전체에서 유일하다

반환값

Table

getWorksheet(sheet)​

시트 핸들을 반환한다. 시트 이름으로 지정할 때는 대소문자를 구분한다. sheet 를 생략하면 활성 시트를 대상으로 한다.

getWorksheet(sheet?: number | string): Promise<Worksheet>;

매개변수

이름타입설명
sheet (선택)number | string시트 인덱스(0-based, getSheetList() 결과의 배열 인덱스) 또는 시트 이름

반환값

Promise<Worksheet>

moveSheet(from, to)​

시트 위치를 이동한다.

moveSheet(from: number | string, to: number): Promise<void>;

매개변수

이름타입설명
fromnumber | string옮길 시트
tonumber옮겨 놓을 자리의 시트 인덱스(0-based)

반환값

Promise<void>

removeSheet(sheet)​

시트를 삭제한다. 활성 시트를 삭제하면 인접한 시트가 활성 시트가 된다. 남은 시트가 하나뿐이거나 숨기지 않은 시트가 하나뿐이면 삭제할 수 없다.

removeSheet(sheet: number | string): Promise<void>;

매개변수

이름타입설명
sheetnumber | string삭제할 시트

반환값

Promise<void>

setActiveSheet(sheet)​

활성 시트를 변경한다. 숨긴 시트는 활성화할 수 없다.

setActiveSheet(sheet: number | string): Promise<void>;

매개변수

이름타입설명
sheetnumber | string활성화할 시트

반환값

Promise<void>