본문으로 건너뛰기

Cell.Range

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

Generated from the SDK type definitions

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

비고​

메서드​

메서드설명
addConditionalFormat(rule)범위에 조건부 서식 규칙을 추가한다.
autofitColumns()범위에 걸친 열의 너비를 각 열의 내용에 맞춰 조정한다.
autofitRows()범위에 걸친 행의 높이를 각 행의 내용에 맞춰 조정한다.
clearAll()범위의 모든 내용을 지운다.
clearConditionalFormats()범위와 겹치는 조건부 서식 규칙을 지운다.
clearDataValidation()범위와 겹치는 데이터 유효성 검사 규칙을 지운다.
clearFormat()범위의 셀 서식(글꼴·채우기·정렬·테두리·표시 형식)을 지우고 범위 안의 병합을 해제한다.
decreaseIndent()범위의 들여쓰기 수준을 1 내린다.
deleteColumn()범위에 걸친 열을 삭제한다.
deleteComment()범위 안의 메모를 모두 지운다.
deleteRow()범위에 걸친 행을 삭제한다.
deleteValue()범위 안 모든 셀의 값과 수식을 지운다.
getAddress(includeSheetName)이 범위의 A1 주소를 반환한다("B2:C5", 단일 셀이면 "E10").
getAlignment()범위 좌상단 셀의 정렬 서식을 한 번에 반환한다.
getBackgroundColor()범위 좌상단 셀의 바탕색을 반환한다.
getBorder()범위 좌상단 셀의 테두리를 네 변과 대각선으로 나눠 반환한다.
getCellContent()범위 좌상단 셀의 값·표시 문자열·수식을 한 번에 반환한다.
getCellContents()범위 전체의 값·표시 문자열·수식을 행 우선 2차원 배열로 반환한다.
getColumnWidth()범위 첫 열의 너비(px)를 반환한다.
getCoordinates()이 범위의 0-based 좌표를 반환한다.
getDisplayValue()범위 좌상단 셀의 화면 표시 문자열을 반환한다.
getDisplayValues()범위 전체의 화면 표시 문자열을 행 우선 2차원 배열로 반환한다.
getFill()범위 좌상단 셀의 채우기를 반환한다.
getFont()범위 좌상단 셀의 글꼴 서식을 한 번에 반환한다.
getFontColor()범위 좌상단 셀의 글꼴 색을 반환한다.
getFontName()범위 좌상단 셀의 글꼴 이름을 반환한다.
getFontSize()범위 좌상단 셀의 글꼴 크기(pt)를 반환한다.
getFontUnderline()범위 좌상단 셀의 밑줄 종류를 반환한다.
getFormula()범위 좌상단 셀의 수식 문자열을 반환한다.
getFormulas()범위 전체의 수식을 행 우선 2차원 배열로 반환한다.
getHorizontalAlign()범위 좌상단 셀의 가로 정렬을 반환한다.
getHyperlinkList()범위와 겹치는 하이퍼링크 목록을 반환한다.
getIndent()범위 좌상단 셀의 들여쓰기 수준을 반환한다.
getMergeCellList()범위와 겹치는 병합 영역의 주소를 A1 문자열 배열로 반환한다.
getNumberFormat()범위 좌상단 셀의 표시 형식을 반환한다.
getRowHeight()범위 첫 행의 높이(px)를 반환한다.
getValue()범위 좌상단 셀의 원시값인 문자열·숫자·불리언 중 하나의 타입 값이 반환되며, 수식 셀은 계산 결과값을 반환한다.
getValues()범위 전체의 값을 행 우선 2차원 배열로 반환한다.
getVerticalAlign()범위 좌상단 셀의 세로 정렬을 반환한다.
increaseIndent()범위의 들여쓰기 수준을 1 올린다.
insertColumn(count)범위의 첫 열 자리에 열을 삽입한다.
insertRow(count)범위의 첫 행 자리에 행을 삽입한다.
isColumnVisible()범위 첫 열이 표시 상태인지 반환한다.
isFontBold()범위 좌상단 셀이 굵게인지 반환한다.
isFontItalic()범위 좌상단 셀이 기울임인지 반환한다.
isFontStrikethrough()범위 좌상단 셀에 취소선이 있는지 반환한다.
isRowVisible()범위 첫 행이 표시 상태인지 반환한다.
isSingleCell()범위가 셀 하나인지 반환한다.
isWrapText()범위 좌상단 셀에 텍스트 줄바꿈이 적용되어 있는지 반환한다.
merge()범위의 셀을 하나로 병합한다.
removeHyperlink()범위와 포함 관계인 하이퍼링크를 지운다.
setBackgroundColor(color)범위를 단색 바탕색으로 채운다.
setBorder(type, lineStyle, color)범위에 테두리를 적용하거나 지운다.
setColumnVisible(visible)범위에 걸친 열을 표시하거나 숨긴다.
setColumnWidth(width)범위에 걸친 열의 너비를 지정한다.
setComment(text)범위 좌상단 셀에 메모를 넣는다.
setCommentVisible(visible)범위 좌상단 셀 메모의 표시 상태를 바꾼다.
setDataValidation(rule)범위에 데이터 유효성 검사 규칙을 적용한다.
setFontBold(isOn)범위에 굵게를 적용하거나 해제한다.
setFontColor(color)범위의 글꼴 색을 바꾼다.
setFontItalic(isOn)범위에 기울임을 적용하거나 해제한다.
setFontName(name)범위의 글꼴을 바꾼다.
setFontSize(size)범위의 글꼴 크기를 바꾼다.
setFontStrikethrough(isOn)범위에 취소선을 적용하거나 해제한다.
setFontUnderline(isOn, isDouble)범위에 밑줄을 적용하거나 해제한다.
setHorizontalAlign(value)범위의 가로 정렬을 지정한다.
setHyperlink(options)범위에 하이퍼링크를 넣는다.
setNumberFormat(formatCode)범위의 표시 형식을 형식 코드로 지정한다.
setRowHeight(height)범위에 걸친 행의 높이를 지정한다.
setRowVisible(visible)범위에 걸친 행을 표시하거나 숨긴다.
setValue(value)범위의 모든 셀에 같은 값을 넣는다.
setValues(values)범위의 셀마다 다른 값을 넣는다.
setVerticalAlign(value)범위의 세로 정렬을 지정한다.
setWrapText(isOn)범위에 텍스트 줄바꿈을 적용하거나 해제한다.
sort(key, order, options)범위를 지정한 열의 값 기준으로 정렬한다.
unmerge()범위와 겹치는 병합을 모두 해제한다.

메서드 상세​

addConditionalFormat(rule)​

범위에 조건부 서식 규칙을 추가한다. 추가한 규칙이 기존 규칙보다 먼저 적용된다. 규칙 내용이 잘못되었다면 동작하지 않는다.

addConditionalFormat(rule: Record<string, unknown>): Promise<void>;

매개변수

이름타입설명
ruleRecord<string, unknown>규칙 객체. rule_type 은 ConditionalFormatRuleType, cellIs 의 operator 는 ConditionalFormatOperator, timePeriod 의 time_period 는 ConditionalFormatTimePeriod, 시각 규칙의 cfvo[].type 은 ConditionalFormatValueType 어휘를 쓴다. 수식 계열 규칙의 강조 서식은 style 로 지정하며 생략하면 기본 강조를 쓴다. colorScale 은 colors(ARGB 2~3개)로, dataBar 와 iconSet 은 프리셋(data_bar·icon_set)으로 지정한다

반환값

Promise<void>

autofitColumns()​

범위에 걸친 열의 너비를 각 열의 내용에 맞춰 조정한다. 조정한 열은 이후 값을 넣거나 글꼴 크기·들여쓰기를 바꿀 때 숫자 셀의 내용에 맞춰 너비가 넓어질 수 있다.

autofitColumns(): Promise<void>;

반환값

Promise<void>

autofitRows()​

범위에 걸친 행의 높이를 각 행의 내용에 맞춰 조정한다. 조정한 행은 이후 내용이 바뀔 때도 높이가 자동으로 맞춰진다.

autofitRows(): Promise<void>;

반환값

Promise<void>

clearAll()​

범위의 모든 내용을 지운다. 값·수식·서식·병합·하이퍼링크·메모·데이터 유효성·스파크라인·필터·표가 대상이다. 행 전체·열 전체 범위가 병합과 겹치면 오류가 난다.

clearAll(): Promise<void>;

반환값

Promise<void>

clearConditionalFormats()​

범위와 겹치는 조건부 서식 규칙을 지운다. 규칙이 범위 밖까지 걸쳐 있으면 겹치는 부분만 규칙의 적용 범위에서 빼고, 규칙 전체가 범위 안에 들면 규칙 자체를 지운다.

clearConditionalFormats(): Promise<void>;

반환값

Promise<void>

clearDataValidation()​

범위와 겹치는 데이터 유효성 검사 규칙을 지운다. 규칙이 범위 밖까지 걸쳐 있으면 겹치는 부분만 적용 범위에서 뺀다.

clearDataValidation(): Promise<void>;

반환값

Promise<void>

clearFormat()​

범위의 셀 서식(글꼴·채우기·정렬·테두리·표시 형식)을 지우고 범위 안의 병합을 해제한다. 값과 수식은 남는다. 행 전체·열 전체 범위가 병합과 겹치면 오류가 난다.

clearFormat(): Promise<void>;

반환값

Promise<void>

decreaseIndent()​

범위의 들여쓰기 수준을 1 내린다. 0 보다 아래로는 내려가지 않는다.

decreaseIndent(): Promise<void>;

반환값

Promise<void>

deleteColumn()​

범위에 걸친 열을 삭제한다. 시트의 모든 열이나 숨기지 않은 마지막 열까지 없어질 때, 틀 고정 오른쪽 영역이 통째로 없어질 때는 삭제할 수 없다.

deleteColumn(): Promise<void>;

반환값

Promise<void>

deleteComment()​

범위 안의 메모를 모두 지운다.

deleteComment(): Promise<void>;

반환값

Promise<void>

deleteRow()​

범위에 걸친 행을 삭제한다. 범위가 표의 데이터 영역을 통째로 덮으면 표가 사라지지 않도록 데이터 행 하나를 남긴다.

deleteRow(): Promise<void>;

반환값

Promise<void>

deleteValue()​

범위 안 모든 셀의 값과 수식을 지운다. 서식은 그대로 남는다.

deleteValue(): Promise<void>;

반환값

Promise<void>

getAddress(includeSheetName)​

이 범위의 A1 주소를 반환한다("B2:C5", 단일 셀이면 "E10"). 시트 이름을 붙이면 공백이나 특수문자가 든 이름은 따옴표로 감싼다. 이 형태는 getRange() 가 받지 않는다.

getAddress(includeSheetName?: boolean): Promise<string>;

매개변수

이름타입설명
includeSheetName (선택)booleantrue 면 시트 이름을 붙이고, false 면 주소만 반환한다 (기본값: false)

반환값

Promise<string>

getAlignment()​

범위 좌상단 셀의 정렬 서식을 한 번에 반환한다. 각 항목은 같은 이름의 개별 조회 메서드와 같다.

getAlignment(): Promise<AlignmentInfo | undefined>;

반환값

Promise<AlignmentInfo | undefined> - 셀에 서식 정보가 없으면 undefined 다

getBackgroundColor()​

범위 좌상단 셀의 바탕색을 반환한다. 채우기가 없을 때는 물론 그라디언트 채우기일 때도 색 하나로 표현할 수 없어 undefined 다. 채우기 종류까지 알아야 하면 getFill 을 쓴다.

getBackgroundColor(): Promise<string | undefined>;

반환값

Promise<string | undefined> - "#RRGGBB" 형식의 색

getBorder()​

범위 좌상단 셀의 테두리를 네 변과 대각선으로 나눠 반환한다. 실제로 그려진 선만 담긴다.

getBorder(): Promise<BorderInfo | undefined>;

반환값

Promise<BorderInfo | undefined> - 셀에 서식 정보가 없으면 undefined 다

getCellContent()​

범위 좌상단 셀의 값·표시 문자열·수식을 한 번에 반환한다. 각 항목은 getValue·getDisplayValue·getFormula 와 같다.

getCellContent(): Promise<CellContent>;

반환값

Promise<CellContent>

getCellContents()​

범위 전체의 값·표시 문자열·수식을 행 우선 2차원 배열로 반환한다. 배열 크기는 범위 크기와 같다.

getCellContents(): Promise<CellContent[][]>;

반환값

Promise<CellContent[][]>

getColumnWidth()​

범위 첫 열의 너비(px)를 반환한다.

getColumnWidth(): Promise<number>;

반환값

Promise<number>

getCoordinates()​

이 범위의 0-based 좌표를 반환한다. A1 주소가 필요하면 getAddress() 를 쓴다. 시트가 삭제됐으면 SHEET_NOT_FOUND 를 throw 한다.

getCoordinates(): Promise<SheetRangeCoords>;

반환값

Promise<SheetRangeCoords>

getDisplayValue()​

범위 좌상단 셀의 화면 표시 문자열을 반환한다. 표시 형식이 적용된 결과라 저장된 값과 다를 수 있다.

getDisplayValue(): Promise<string>;

반환값

Promise<string> - 셀이 비어 있으면 빈 문자열

getDisplayValues()​

범위 전체의 화면 표시 문자열을 행 우선 2차원 배열로 반환한다. 배열 크기는 범위 크기와 같다.

getDisplayValues(): Promise<string[][]>;

반환값

Promise<string[][]> - 빈 셀 자리는 빈 문자열이다

getFill()​

범위 좌상단 셀의 채우기를 반환한다. 그라디언트 채우기는 종류만 담기고 색·방향 등 나머지는 담기지 않는다.

getFill(): Promise<FillInfo | undefined>;

반환값

Promise<FillInfo | undefined> - 채우기가 없으면 undefined 다

getFont()​

범위 좌상단 셀의 글꼴 서식을 한 번에 반환한다. 각 항목은 같은 이름의 개별 조회 메서드와 같되, underline 만 밑줄이 없을 때 undefined 가 아니라 "none" 이다.

getFont(): Promise<FontInfo | undefined>;

반환값

Promise<FontInfo | undefined> - 셀에 서식 정보가 없으면 undefined 다

getFontColor()​

범위 좌상단 셀의 글꼴 색을 반환한다. 색을 따로 지정하지 않은 셀에는 문서 기본 색이 담긴다.

getFontColor(): Promise<string | undefined>;

반환값

Promise<string | undefined> - "#RRGGBB" 형식의 색

getFontName()​

범위 좌상단 셀의 글꼴 이름을 반환한다. 글꼴을 따로 지정하지 않은 셀에는 문서 기본 글꼴 이름이 담긴다.

getFontName(): Promise<string | undefined>;

반환값

Promise<string | undefined>

getFontSize()​

범위 좌상단 셀의 글꼴 크기(pt)를 반환한다. 크기를 따로 지정하지 않은 셀에는 문서 기본 크기가 담긴다.

getFontSize(): Promise<number | undefined>;

반환값

Promise<number | undefined>

getFontUnderline()​

범위 좌상단 셀의 밑줄 종류를 반환한다.

getFontUnderline(): Promise<"single" | "double" | undefined>;

반환값

Promise<"single" | "double" | undefined> - 밑줄이 없으면 undefined 다

getFormula()​

범위 좌상단 셀의 수식 문자열을 반환한다. 수식이 아닌 셀(상수·빈 셀)이면 undefined 다.

getFormula(): Promise<string | undefined>;

반환값

Promise<string | undefined>

getFormulas()​

범위 전체의 수식을 행 우선 2차원 배열로 반환한다. 배열 크기는 범위 크기와 같다.

getFormulas(): Promise<(string | null)[][]>;

반환값

Promise<(string | null)[][]> - 수식이 아닌 셀 자리는 null 이다

getHorizontalAlign()​

범위 좌상단 셀의 가로 정렬을 반환한다. 명시 지정된 값만 반환하며, HorizontalAlign 밖의 값이 반환될 수 있다.

getHorizontalAlign(): Promise<string | undefined>;

반환값

Promise<string | undefined> - 지정이 없으면 undefined 다

범위와 겹치는 하이퍼링크 목록을 반환한다. 일부만 겹치는 링크도 포함한다.

getHyperlinkList(): Promise<HyperlinkInfo[]>;

반환값

Promise<HyperlinkInfo[]>

getIndent()​

범위 좌상단 셀의 들여쓰기 수준을 반환한다.

getIndent(): Promise<number>;

반환값

Promise<number> - 들여쓰기가 지정되어 있지 않으면 0 이다

getMergeCellList()​

범위와 겹치는 병합 영역의 주소를 A1 문자열 배열로 반환한다. 일부만 겹치는 병합도 범위에 맞춰 잘라내지 않고 병합 영역 전체 주소를 준다. 시트 전체의 병합 목록은 Worksheet.getMergeCellList 로 조회한다.

getMergeCellList(): Promise<string[]>;

반환값

Promise<string[]>

getNumberFormat()​

범위 좌상단 셀의 표시 형식을 반환한다. 형식을 따로 지정하지 않은 셀에도 문서 기본 형식의 코드가 담긴다.

getNumberFormat(): Promise<{ formatCode: string }>;

반환값

Promise<{ formatCode: string }> - formatCode 는 setNumberFormat 에 그대로 넘길 수 있는 형식 코드다

getRowHeight()​

범위 첫 행의 높이(px)를 반환한다.

getRowHeight(): Promise<number>;

반환값

Promise<number>

getValue()​

범위 좌상단 셀의 원시값인 문자열·숫자·불리언 중 하나의 타입 값이 반환되며, 수식 셀은 계산 결과값을 반환한다.

getValue(): Promise<string | number | boolean | undefined>;

반환값

Promise<string | number | boolean | undefined> - 빈 셀은 undefined 다

getValues()​

범위 전체의 값을 행 우선 2차원 배열로 반환한다. 바깥 배열이 행, 안쪽 배열이 열이며 배열 크기는 범위 크기와 같다. 각 값의 형태는 getValue 와 같다.

getValues(): Promise<(string | number | boolean | undefined)[][]>;

반환값

Promise<(string | number | boolean | undefined)[][]> - 빈 셀 자리는 undefined 로 채운다

getVerticalAlign()​

범위 좌상단 셀의 세로 정렬을 반환한다. 명시 지정된 값만 반환하며, VerticalAlign 밖의 값이 반환될 수 있다. 지정이 없는 셀은 아래쪽으로 그려진다.

getVerticalAlign(): Promise<string | undefined>;

반환값

Promise<string | undefined> - 지정이 없으면 undefined 다

increaseIndent()​

범위의 들여쓰기 수준을 1 올린다. 범위의 가로 정렬이 왼쪽이나 오른쪽 하나로 통일되어 있지 않으면 먼저 범위 전체를 왼쪽 정렬로 바꾼 뒤 올린다.

increaseIndent(): Promise<void>;

반환값

Promise<void>

insertColumn(count)​

범위의 첫 열 자리에 열을 삽입한다. 앞 열의 서식을 따라간다. 시트의 첫 열 자리에 삽입하면 서식 없는 열이 들어간다.

insertColumn(count?: number | null): Promise<void>;

매개변수

이름타입설명
count (선택)number | null삽입할 열 수. 1 이상이 아니면 범위의 열 수만큼 삽입한다

반환값

Promise<void>

insertRow(count)​

범위의 첫 행 자리에 행을 삽입한다. 앞 행의 서식을 따라간다. 시트의 첫 행 자리에 삽입하면 서식 없는 행이 들어간다.

insertRow(count?: number | null): Promise<void>;

매개변수

이름타입설명
count (선택)number | null삽입할 행 수. 1 이상이 아니면 범위의 행 수만큼 삽입한다

반환값

Promise<void>

isColumnVisible()​

범위 첫 열이 표시 상태인지 반환한다.

isColumnVisible(): Promise<boolean | undefined>;

반환값

Promise<boolean | undefined>

isFontBold()​

범위 좌상단 셀이 굵게인지 반환한다.

isFontBold(): Promise<boolean | undefined>;

반환값

Promise<boolean | undefined> - 굵게가 아니면 undefined 다

isFontItalic()​

범위 좌상단 셀이 기울임인지 반환한다.

isFontItalic(): Promise<boolean | undefined>;

반환값

Promise<boolean | undefined> - 기울임이 아니면 undefined 다

isFontStrikethrough()​

범위 좌상단 셀에 취소선이 있는지 반환한다.

isFontStrikethrough(): Promise<boolean | undefined>;

반환값

Promise<boolean | undefined> - 취소선이 없으면 undefined 다

isRowVisible()​

범위 첫 행이 표시 상태인지 반환한다.

isRowVisible(): Promise<boolean | undefined>;

반환값

Promise<boolean | undefined>

isSingleCell()​

범위가 셀 하나인지 반환한다. 여러 행이나 여러 열에 걸친 범위는 false 다.

isSingleCell(): Promise<boolean>;

반환값

Promise<boolean>

isWrapText()​

범위 좌상단 셀에 텍스트 줄바꿈이 적용되어 있는지 반환한다.

isWrapText(): Promise<boolean | undefined>;

반환값

Promise<boolean | undefined> - 줄바꿈이 적용되어 있지 않으면 undefined 다

merge()​

범위의 셀을 하나로 병합한다. 병합한 셀에는 좌상단 셀의 값만 남고 나머지 값은 사라진다. 범위가 셀 하나이거나 표와 겹치면 아무것도 하지 않는다. 병합이 범위 밖까지 걸쳐 있으면 오류가 난다.

merge(): Promise<void>;

반환값

Promise<void>

범위와 포함 관계인 하이퍼링크를 지운다. 범위가 링크를 품거나 링크가 범위를 품는 경우이며, 일부만 겹치는 링크는 남는다. 셀 값은 그대로 두고 링크 서식(파란색 밑줄)만 함께 지우며, 지운 링크와 겹쳐 있던 다른 링크의 서식은 되살린다.

removeHyperlink(): Promise<void>;

반환값

Promise<void>

setBackgroundColor(color)​

범위를 단색 바탕색으로 채운다. 색을 주지 않으면 채우기를 지운다.

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

매개변수

이름타입설명
color (선택)string | null"#RRGGBB" 형식의 색. null·undefined·빈 문자열이면 채우기를 지운다

반환값

Promise<void>

setBorder(type, lineStyle, color)​

범위에 테두리를 적용하거나 지운다. type 이 "none" 이면 범위의 테두리를 모두 지우고, 그 밖의 type 은 기존 테두리에 type 이 가리키는 테두리를 병합한다. lineStyle 이 "none" 이면 type 이 가리키는 자리의 선만 지우며 color 는 무시된다. 그릴 내부 선이 없으면 "center"·"middle"·"cross" 는 아무것도 하지 않는다.

setBorder(
  type: BorderType,
  lineStyle?: BorderLineStyle | null,
  color?: string | null
): Promise<void>;

매개변수

이름타입설명
typeBorderType테두리를 그릴 자리
lineStyle (선택)BorderLineStyle | null선 스타일 (기본값: "thin")
color (선택)string | null"#RRGGBB" 형식의 선 색 (기본값: "#000000")

반환값

Promise<void>

setColumnVisible(visible)​

범위에 걸친 열을 표시하거나 숨긴다. visible 이 null 이거나 undefined 면 아무것도 하지 않는다.

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

매개변수

이름타입설명
visiblebooleantrue 면 표시, false 면 숨김

반환값

Promise<void>

setColumnWidth(width)​

범위에 걸친 열의 너비를 지정한다. 숨긴 열에 너비를 지정하면 숨김도 함께 풀린다. 0 이하를 주면 너비를 바꾸지 않고 열을 숨긴다. 지정한 열은 너비가 고정되어 내용이 바뀌어도 자동으로 넓어지지 않는다.

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

매개변수

이름타입설명
widthnumber열 너비(px)

반환값

Promise<void>

setComment(text)​

범위 좌상단 셀에 메모를 넣는다. 메모가 이미 있으면 본문만 바꾸고 표시 상태와 위치는 그대로 둔다.

setComment(text: string): Promise<void>;

매개변수

이름타입설명
textstring메모 본문. 서식 없는 텍스트이며 줄바꿈은 "\n" 이다

반환값

Promise<void>

setCommentVisible(visible)​

범위 좌상단 셀 메모의 표시 상태를 바꾼다. 메모가 없다면 동작하지 않는다.

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

매개변수

이름타입설명
visiblebooleantrue 면 항상 표시, false 면 마우스를 올렸을 때만 표시

반환값

Promise<void>

setDataValidation(rule)​

범위에 데이터 유효성 검사 규칙을 적용한다. 셀 하나에는 규칙 하나만 걸리므로, 겹치는 기존 규칙은 겹치는 만큼 적용 범위에서 물러나고 이 규칙으로 바뀐다. 규칙 내용이 잘못되었다면 동작하지 않는다.

setDataValidation(rule: Record<string, unknown>): Promise<void>;

매개변수

이름타입설명
ruleRecord<string, unknown>규칙 객체. type 은 DataValidationType, operator 는 DataValidationOperator, errorStyle 은 DataValidationErrorStyle 어휘를 쓰며, 타입에 따라 formula 와 안내·오류 메시지를 함께 담는다

반환값

Promise<void>

setFontBold(isOn)​

범위에 굵게를 적용하거나 해제한다.

setFontBold(isOn: boolean): Promise<void>;

매개변수

이름타입설명
isOnbooleantrue 면 적용, false 면 해제

반환값

Promise<void>

setFontColor(color)​

범위의 글꼴 색을 바꾼다.

setFontColor(color: string): Promise<void>;

매개변수

이름타입설명
colorstring"#RRGGBB" 형식의 색

반환값

Promise<void>

setFontItalic(isOn)​

범위에 기울임을 적용하거나 해제한다.

setFontItalic(isOn: boolean): Promise<void>;

매개변수

이름타입설명
isOnbooleantrue 면 적용, false 면 해제

반환값

Promise<void>

setFontName(name)​

범위의 글꼴을 바꾼다.

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

매개변수

이름타입설명
namestring글꼴 이름

반환값

Promise<void>

setFontSize(size)​

범위의 글꼴 크기를 바꾼다.

setFontSize(size: number | string): Promise<void>;

매개변수

이름타입설명
sizenumber | string글꼴 크기(pt)

반환값

Promise<void>

setFontStrikethrough(isOn)​

범위에 취소선을 적용하거나 해제한다.

setFontStrikethrough(isOn: boolean): Promise<void>;

매개변수

이름타입설명
isOnbooleantrue 면 적용, false 면 해제

반환값

Promise<void>

setFontUnderline(isOn, isDouble)​

범위에 밑줄을 적용하거나 해제한다.

setFontUnderline(isOn: boolean, isDouble?: boolean): Promise<void>;

매개변수

이름타입설명
isOnbooleantrue 면 적용, false 면 해제. false 면 isDouble 은 무시된다
isDouble (선택)booleantrue 면 이중 밑줄, false 면 실선 밑줄 (기본값: false)

반환값

Promise<void>

setHorizontalAlign(value)​

범위의 가로 정렬을 지정한다. 지정과 함께 범위의 들여쓰기가 0 으로 초기화된다. HorizontalAlign 밖의 값도 검증 없이 저장되며, "centerContinuous" 와 "center-across" 는 가운데로, 그 밖의 값은 왼쪽으로 그려진다.

setHorizontalAlign(value: HorizontalAlign): Promise<void>;

매개변수

이름타입설명
valueHorizontalAlign가로 정렬

반환값

Promise<void>

범위에 하이퍼링크를 넣는다. 링크와 링크 서식(파란색 밑줄)은 범위 전체에 들어가지만 표시 텍스트는 좌상단 셀에만 들어간다.

setHyperlink(options: HyperlinkOptions): Promise<void>;

매개변수

이름타입설명
optionsHyperlinkOptions-

반환값

Promise<void>

setNumberFormat(formatCode)​

범위의 표시 형식을 형식 코드로 지정한다. 넘긴 코드는 사용자 정의 형식으로 저장된다.

setNumberFormat(formatCode: string): Promise<void>;

매개변수

이름타입설명
formatCodestring엑셀 호환 형식 코드 ("#,##0.00", "yyyy-mm-dd", "0.00%" 등)

반환값

Promise<void>

setRowHeight(height)​

범위에 걸친 행의 높이를 지정한다. 숨긴 행에 높이를 지정하면 숨김도 함께 풀린다. 0 이하를 주면 높이를 바꾸지 않고 행을 숨긴다. 지정한 행은 높이가 고정되어 내용이 바뀌어도 자동으로 맞춰지지 않는다.

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

매개변수

이름타입설명
heightnumber행 높이(px)

반환값

Promise<void>

setRowVisible(visible)​

범위에 걸친 행을 표시하거나 숨긴다. visible 이 null 이거나 undefined 면 아무것도 하지 않는다.

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

매개변수

이름타입설명
visiblebooleantrue 면 표시, false 면 숨김

반환값

Promise<void>

setValue(value)​

범위의 모든 셀에 같은 값을 넣는다. 값은 문자열로 바꾼 뒤 해석하므로 "=" 로 시작하면 수식이 되고, "{=...}" 형태이면 범위 전체를 한 덩어리로 묶는 배열 수식이 된다. 범위가 기존 배열 수식 영역 안의 셀 하나이면 그 영역 전체를 다시 입력한다. 배열 수식은 병합 셀이나 표 영역에 넣을 수 없다. null 은 빈 셀이 되고, 객체는 JSON 표기로 들어가며, Date 처럼 문자열 표기를 갖는 객체는 그 문자열이 들어간다. 배열은 원소를 각각 같은 규칙으로 바꿔 콤마로 이어 넣는다.

setValue(value: string | number | boolean | null | Date | Record<string, unknown> | any[]): Promise<void>;

매개변수

이름타입설명
valuestring | number | boolean | null | Date | Record<string, unknown> | any[]넣을 값. 자기 자신을 품은 배열·객체처럼 문자열 표기를 얻을 수 없는 값은 넣을 수 없다

반환값

Promise<void>

setValues(values)​

범위의 셀마다 다른 값을 넣는다. 바깥 배열 인덱스가 범위 안의 행, 안쪽 배열 인덱스가 범위 안의 열에 대응하며 크기가 범위와 정확히 같아야 한다. 각 값의 해석은 setValue 와 같지만 배열 수식은 넣을 수 없다. null 과 undefined 는 빈 셀이 된다. 전체 행·열 범위에는 쓸 수 없다.

setValues(values: (string | number | boolean | null | undefined | Date | Record<string, unknown> | any[])[][]): Promise<void>;

매개변수

이름타입설명
values(string | number | boolean | null | undefined | Date | Record<string, unknown> | any[])[][]범위 크기와 같은 행 우선 2차원 배열

반환값

Promise<void>

setVerticalAlign(value)​

범위의 세로 정렬을 지정한다. VerticalAlign 밖의 값도 검증 없이 저장되며, "distributed" 는 가운데로, 그 밖의 값은 아래로 그려진다.

setVerticalAlign(value: VerticalAlign): Promise<void>;

매개변수

이름타입설명
valueVerticalAlign세로 정렬

반환값

Promise<void>

setWrapText(isOn)​

범위에 텍스트 줄바꿈을 적용하거나 해제한다.

setWrapText(isOn: boolean): Promise<void>;

매개변수

이름타입설명
isOnbooleantrue 면 적용, false 면 해제

반환값

Promise<void>

sort(key, order, options)​

범위를 지정한 열의 값 기준으로 정렬한다. 범위가 필터나 표 영역 안의 셀 하나이면 그 필터의 정렬로 처리되어 정렬 상태가 문서에 남는다. 머리글 행은 자동으로 가려낸다. 정렬할 값이 없거나 범위 안 병합의 크기가 제각각이면 정렬할 수 없다.

sort(key: number, order: SortOrder, options?: Record<string, unknown>): Promise<void>;

매개변수

이름타입설명
keynumber정렬 기준 열. 범위의 첫 열을 0 으로 세는 0-based 오프셋이며 범위 너비를 벗어날 수 없다
orderSortOrder정렬 방향. SortOrder 의 오름차순·내림차순 두 값만 받는다
options (선택)Record<string, unknown>아직 지원하지 않는 예약 인자. 값이 담긴 객체를 주면 정렬하지 않는다

반환값

Promise<void>

unmerge()​

범위와 겹치는 병합을 모두 해제한다.

unmerge(): Promise<void>;

반환값

Promise<void>