Class Range

范围

访问和修改电子表格范围。范围可以是工作表中的单个单元格,也可以是工作表中的一组相邻单元格。

方法

方法返回类型简介
activate()Range将指定的范围设为 active range,并将范围中的左上角单元格设为 current cell
activateAsCurrentCell()Range将指定的单元格设置为 current cell
addDeveloperMetadata(key)Range将具有指定键的开发者元数据添加到范围内。
addDeveloperMetadata(key, visibility)Range向指定范围添加具有指定键和可见性的开发者元数据。
addDeveloperMetadata(key, value)Range将具有指定键的开发者元数据添加到范围中。
addDeveloperMetadata(key, value, visibility)Range向指定范围添加具有指定键、值和可见性的开发者元数据。
applyColumnBanding()Banding为范围应用默认列条带主题。
applyColumnBanding(bandingTheme)Banding将指定的列条带主题应用于范围。
applyColumnBanding(bandingTheme, showHeader, showFooter)Banding将指定的列条带主题应用于具有指定页眉和页脚设置的范围。
applyRowBanding()Banding为范围应用默认行频主题。
applyRowBanding(bandingTheme)Banding将指定的行条带主题应用于范围。
applyRowBanding(bandingTheme, showHeader, showFooter)Banding将指定的行带主题应用于具有指定页眉和页脚设置的范围。
autoFill(destination, series)void根据此范围内的数据填充 destinationRange
autoFillToNeighbor(series)void根据相邻单元格计算使用新数据填充的范围,并根据此范围中包含的数据自动使用新值填充该范围。
breakApart()Range将范围中的所有多列单元格再次拆分为单独的单元格。
canEdit()Boolean确定用户是否有权修改范围中的每个单元格。
check()Range将范围中复选框的状态更改为“已选中”。
clear()Range清除内容、格式和数据验证规则的范围。
clear(options)Range按照指定的高级选项,清除内容、格式、数据验证规则和/或注释的范围。
clearContent()Range清除范围内容,保留格式不变。
clearDataValidations()Range清除范围的数据验证规则。
clearFormat()Range清除此范围的格式。
clearNote()Range清除给定单元格中的备注。
collapseGroups()Range收起整个范围内的所有群组。
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)void将范围的格式复制到指定位置。
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)void将范围的格式复制到指定位置。
copyTo(destination)void将数据从一个单元格范围复制到另一个单元格范围。
copyTo(destination, copyPasteType, transposed)void将数据从一个单元格范围复制到另一个单元格范围。
copyTo(destination, options)void将数据从一个单元格范围复制到另一个单元格范围。
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)void将范围的内容复制到指定位置。
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)void将范围的内容复制到指定位置。
createDataSourcePivotTable(dataSource)DataSourcePivotTable根据数据源创建空数据源数据透视表,锚定在范围内的第一个单元格。
createDataSourceTable(dataSource)DataSourceTable基于数据源创建一个空数据源表,该表将锚定到此范围内的第一个单元格。
createDeveloperMetadataFinder()DeveloperMetadataFinder返回一个 DeveloperMetadataFinderApi,用于查找此范围内的开发者元数据。
createFilter()Filter创建过滤器并将其应用于工作表中的指定范围。
createPivotTable(sourceData)PivotTable根据锚定到此范围中第一个单元格的指定 sourceData 来创建空数据透视表。
createTextFinder(findText)TextFinder为范围创建文本查找器,以查找和替换此范围中的文本。
deleteCells(shiftDimension)void删除此范围单元格。
expandGroups()Range展开收起的范围(其范围或控件切换开关与此范围相交)。
getA1Notation()String以 A1 表示法返回范围的字符串说明。
getBackground()String返回范围内左上角单元格的背景颜色(例如 '#ffffff')。
getBackgroundObject()Color返回范围内左上角单元格的背景颜色。
getBackgroundObjects()Color[][]返回范围中单元格的背景颜色。
getBackgrounds()String[][]返回范围内的单元格的背景颜色(例如 '#ffffff')。
getBandings()Banding[]返回此范围内所有单元格应用的所有条带。
getCell(row, column)Range返回范围内的给定单元格。
getColumn()Integer返回此范围的起始列位置。
getDataRegion()Range返回在四个基数 Direction 中扩展的范围的副本,以覆盖包含相应数据的所有相邻单元格。
getDataRegion(dimension)Range如果指定的维度为 Dimension.ROWS,则返回范围扩展的 Direction.UPDirection.DOWN 的副本;如果维度为 Dimension.COLUMNS,则返回 Direction.NEXTDirection.PREVIOUS
getDataSourceFormula()DataSourceFormula返回范围内第一个单元格的 DataSourceFormula,如果单元格不包含数据源公式,则返回 null
getDataSourceFormulas()DataSourceFormula[]返回范围中单元格的 DataSourceFormula
getDataSourcePivotTables()DataSourcePivotTable[]获取与范围相交的所有数据源数据透视表。
getDataSourceTables()DataSourceTable[]获取与范围相交的所有数据源表。
getDataSourceUrl()String返回此范围内数据的网址,该网址可用于创建图表和查询。
getDataTable()DataTable以 DataTable 的形式返回此对象中的数据。
getDataTable(firstRowIsHeader)DataTable以 DataTable 的形式返回此范围内的数据。
getDataValidation()DataValidation返回范围中左上角单元格的数据验证规则。
getDataValidations()DataValidation[][]返回范围内所有单元格的数据验证规则。
getDeveloperMetadata()DeveloperMetadata[]获取与此范围关联的开发者元数据。
getDisplayValue()String返回范围中左上角单元格的显示值。
getDisplayValues()String[][]返回此范围中的矩形网格值。
getFilter()Filter返回此范围所属的工作表上的过滤条件;如果工作表上没有任何过滤条件,则返回 null
getFontColorObject()Color返回单元格左上角相应单元格的字体颜色。
getFontColorObjects()Color[][]返回范围内的单元格的字体颜色。
getFontFamilies()String[][]返回范围内的单元格的字体系列。
getFontFamily()String返回单元格左上角的字体集。
getFontLine()String获取范围左上角的单元格线条样式('underline''line-through''none')。
getFontLines()String[][]获取范围内的单元格的线条样式('underline''line-through''none')。
getFontSize()Integer返回单元格左上角相应单元格字体大小的字体大小。
getFontSizes()Integer[][]返回范围中单元格的字体大小。
getFontStyle()String返回单元格左上角的字体样式('italic''normal')。
getFontStyles()String[][]返回范围内的单元格的字体样式。
getFontWeight()String返回单元格左上角字体粗细(正常/粗体)的范围。
getFontWeights()String[][]返回范围内的单元格的字体粗细。
getFormula()String返回范围左上角的单元格的公式(A1 表示法);如果单元格为空或不包含公式,则为空字符串。
getFormulaR1C1()String返回给定单元格的公式(R1C1 表示法);如果没有,则返回 null
getFormulas()String[][]返回范围中单元格的公式(A1 表示法)。
getFormulasR1C1()String[][]返回范围中单元格的公式(R1C1 表示法)。
getGridId()Integer返回范围的父工作表的网格 ID。
getHeight()Integer返回范围的高度。
getHorizontalAlignment()String返回单元格左上角文本(水平/左上角)的水平对齐方式。
getHorizontalAlignments()String[][]返回单元格内相应单元格的水平对齐方式。
getLastColumn()Integer返回结束列的位置。
getLastRow()Integer返回结束行位置。
getMergedRanges()Range[]返回代表已合并单元格的 Range 对象数组,这些单元格完全位于当前范围内,或包含当前范围内的至少一个单元格。
getNextDataCell(direction)Range从范围第一行和首行的单元格开始,返回给定方向上的下一个单元格,即包含数据的连续单元格范围的边缘,或电子表格方向上单元格边缘的单元格。
getNote()String返回与指定范围关联的备注。
getNotes()String[][]返回与范围中的单元格相关联的备注。
getNumColumns()Integer返回此范围内的列数。
getNumRows()Integer返回此范围内的行数。
getNumberFormat()String获取给定范围左上角的单元格的数字或日期格式。
getNumberFormats()String[][]返回单元格中数字或日期的格式。
getRichTextValue()RichTextValue返回范围左上角的单元格的富文本值;如果单元格值不是文本,则返回 null
getRichTextValues()RichTextValue[][]返回范围中单元格的富文本值。
getRow()Integer返回此范围的行位置。
getRowIndex()Integer返回此范围的行位置。
getSheet()Sheet返回此范围所属的工作表。
getTextDirection()TextDirection返回范围左上角的单元格的文本方向。
getTextDirections()TextDirection[][]返回范围中单元格的文本方向。
getTextRotation()TextRotation返回范围左上角的单元格的文本旋转设置。
getTextRotations()TextRotation[][]返回范围中单元格的文本旋转设置。
getTextStyle()TextStyle返回范围左上角的单元格的文本样式。
getTextStyles()TextStyle[][]返回范围中单元格的文本样式。
getValue()Object返回范围中左上角单元格的值。
getValues()Object[][]返回此范围中的矩形网格值。
getVerticalAlignment()String返回单元格在范围左上角的垂直对齐方式(顶部/中间/底部)。
getVerticalAlignments()String[][]返回范围中单元格的垂直对齐方式。
getWidth()Integer以列为单位返回范围的宽度。
getWrap()Boolean返回单元格中的文本是否换行。
getWrapStrategies()WrapStrategy[][]返回范围内的单元格的文本换行策略。
getWrapStrategy()WrapStrategy返回范围左上角的单元格的文本换行策略。
getWraps()Boolean[][]返回单元格中的文本是否换行。
insertCells(shiftDimension)Range在此范围内插入空白单元格。
insertCheckboxes()Range在相应范围的每个单元格中插入复选框,并配置 true 表示已选中,false 表示未选中。
insertCheckboxes(checkedValue)Range在相应范围的每个单元格中插入复选框,并配置一个自定义值(针对已选中)和空字符串(对于取消选中状态)。
insertCheckboxes(checkedValue, uncheckedValue)Range将复选框插入范围内的每个单元格,并配置自定义值作为已选中和未选中状态的值。
isBlank()Boolean如果范围完全为空,则返回 true
isChecked()Boolean返回范围内所有单元格的复选框状态是否为“已勾选”。
isEndColumnBounded()Boolean确定范围的末尾是否绑定到特定列。
isEndRowBounded()Boolean确定范围的末尾是否绑定到特定行。
isPartOfMerge()Boolean如果当前范围内的单元格与已合并的单元格重叠,则返回 true
isStartColumnBounded()Boolean确定范围的开头是否绑定到特定列。
isStartRowBounded()Boolean确定范围的开头是否绑定到特定行。
merge()Range将范围中的单元格合并为一个文本块。
mergeAcross()Range合并该范围中各列内的单元格。
mergeVertically()Range将范围中的单元格合并。
moveTo(target)void从此范围剪切并粘贴(格式和值)到目标范围。
offset(rowOffset, columnOffset)Range返回给定范围的行数和列数(可以是负数)相对于此范围的新范围。
offset(rowOffset, columnOffset, numRows)Range返回相对于当前范围的新范围,其左上角与当前范围相隔给定的行和列,并且具有指定的单元格高度。
offset(rowOffset, columnOffset, numRows, numColumns)Range返回相对于当前范围的新范围,其左上角通过给定行和列相对于当前范围偏移,并且具有指定的单元格高度和宽度。
protect()Protection创建一个对象,该对象可防止除了拥有权限的用户修改该范围。
randomize()Range随机排列给定范围中各行的顺序。
removeCheckboxes()Range移除范围中的所有复选框。
removeDuplicates()Range移除此范围中包含与之前任何行中的值重复的行。
removeDuplicates(columnsToCompare)Range移除此范围中包含指定列中与前一行重复的值的行。
setBackground(color)Range以 CSS 表示法(例如 '#ffffff''white')设置范围内所有单元格的背景颜色。
setBackgroundObject(color)Range设置范围内所有单元格的背景颜色。
setBackgroundObjects(color)Range用于设置背景颜色的矩形网格(必须与此范围的尺寸匹配)。
setBackgroundRGB(red, green, blue)Range使用 RGB 值(0 到 255 之间的整数,包括 0 和 255)将背景设置为指定的颜色。
setBackgrounds(color)Range用于设置背景颜色的矩形网格(必须与此范围的尺寸匹配)。
setBorder(top, left, bottom, right, vertical, horizontal)Range设置边框属性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)Range设置颜色和/或样式的边框属性。
setDataValidation(rule)Range为范围中的所有单元格设置一条数据验证规则。
setDataValidations(rules)Range为范围中的所有单元格设置数据验证规则。
setFontColor(color)Range设置 CSS 表示法中的字体颜色(例如 '#ffffff''white')。
setFontColorObject(color)Range设置指定范围的字体颜色。
setFontColorObjects(colors)Range设置矩形字体网格(必须与此范围的尺寸匹配)。
setFontColors(colors)Range设置矩形字体网格(必须与此范围的尺寸匹配)。
setFontFamilies(fontFamilies)Range设置矩形字体网格系列(必须与此范围的尺寸匹配)。
setFontFamily(fontFamily)Range设置字体系列,例如“ Arial”或“Helvetica”。
setFontLine(fontLine)Range设置指定范围('underline''line-through''none')的字体线条样式。
setFontLines(fontLines)Range设置矩形矩形网格网格(必须与此范围的尺寸匹配)。
setFontSize(size)Range设置要使用的字体大小。
setFontSizes(sizes)Range用于设置字体大小的矩形网格(必须与此范围的尺寸匹配)。
setFontStyle(fontStyle)Range为指定范围('italic''normal')设置字体样式。
setFontStyles(fontStyles)Range设置矩形字体网格(必须与此范围的尺寸匹配)。
setFontWeight(fontWeight)Range为指定范围(正常/粗体)设置字体粗细。
setFontWeights(fontWeights)Range用于设置字体粗细的矩形网格(必须与此范围的尺寸匹配)。
setFormula(formula)Range更新此范围的公式。
setFormulaR1C1(formula)Range更新此范围的公式。
setFormulas(formulas)Range用于设置公式中的矩形网格(必须与此范围的维度相匹配)。
setFormulasR1C1(formulas)Range用于设置公式中的矩形网格(必须与此范围的维度相匹配)。
setHorizontalAlignment(alignment)Range设置给定范围(左侧/中心/右侧)的水平(从左到右)对齐。
setHorizontalAlignments(alignments)Range设置水平对齐的矩形网格。
setNote(note)Range将备注设置为指定值。
setNotes(notes)Range用于设置矩形备注网格(必须与此范围的尺寸匹配)。
setNumberFormat(numberFormat)Range将数字或日期格式设置为指定的格式字符串。
setNumberFormats(numberFormats)Range用于设置数字或日期格式的矩形网格(必须与此范围的尺寸匹配)。
setRichTextValue(value)Range为范围中的单元格设置富文本值。
setRichTextValues(values)Range设置富文本值的矩形网格。
setShowHyperlink(showHyperlink)Range设置该范围是否应显示超链接。
setTextDirection(direction)Range设置范围中单元格的文本方向。
setTextDirections(directions)Range设置文本方向的矩形网格。
setTextRotation(degrees)Range为范围中的单元格设定文本旋转设置。
setTextRotation(rotation)Range为范围中的单元格设定文本旋转设置。
setTextRotations(rotations)Range用于设置文本旋转功能的矩形网格。
setTextStyle(style)Range为范围中的单元格设置文本样式。
setTextStyles(styles)Range设置矩形文本网格。
setValue(value)Range设置范围的值。
setValues(values)Range设置一个矩形值网格(必须与此范围的尺寸匹配)。
setVerticalAlignment(alignment)Range设置给定范围(顶部/中间/底部)的垂直(顶部至底部)对齐。
setVerticalAlignments(alignments)Range设置垂直对齐的矩形网格(必须与此范围的尺寸匹配)。
setVerticalText(isVertical)Range设置是否堆叠范围内的单元格文本。
setWrap(isWrapEnabled)Range设置指定范围的单元格换行。
setWrapStrategies(strategies)Range设置矩形封装网格策略。
setWrapStrategy(strategy)Range为范围内的单元格设置文本换行策略。
setWraps(isWrapEnabled)Range设置矩形换行策略网格(必须与此范围的尺寸匹配)。
shiftColumnGroupDepth(delta)Range将范围的列分组深度更改为指定量。
shiftRowGroupDepth(delta)Range将范围的行分组深度更改为指定量。
sort(sortSpecObj)Range根据指定的列和顺序对指定范围内的单元格进行排序。
splitTextToColumns()void根据自动检测的分隔符将一列文本拆分为多列。
splitTextToColumns(delimiter)void将某列的文本拆分为多列,并将指定字符串用作自定义分隔符。
splitTextToColumns(delimiter)void根据指定的分隔符将一列文本拆分为多列。
trimWhitespace()Range去除此范围中的每个单元格中的空格(例如空格、制表符或换行符)。
uncheck()Range将范围中复选框的状态更改为“未选中”。

详细文档

activate()

将指定的范围设为 active range,并将范围中的左上角单元格设为 current cell

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D10
var activeRange = selection.getActiveRange();

返回

Range - 此范围,用于串联。


activateAsCurrentCell()

将指定的单元格设置为 current cell

如果指定的单元格存在于现有范围内,则该范围将成为当前单元格,而当前单元格为当前单元格。

如果指定的单元格不在任何现有范围内,则将移除现有选择,并将单元格转换为当前单元格和有效范围。

注意:指定的 Range 必须由一个单元格组成,否则会抛出异常。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('B5');
range.activate();

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key)

将具有指定键的开发者元数据添加到范围内。

参数

名称类型说明
keyString新开发者元数据的键。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key, visibility)

向指定范围添加具有指定键和可见性的开发者元数据。

参数

名称类型说明
keyString新开发者元数据的键。
visibilityDeveloperMetadataVisibility新开发者元数据的公开范围。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key, value)

将具有指定键的开发者元数据添加到范围中。

参数

名称类型说明
keyString新开发者元数据的键。
valueString新开发者元数据的值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key, value, visibility)

向指定范围添加具有指定键、值和可见性的开发者元数据。

参数

名称类型说明
keyString新开发者元数据的键。
valueString新开发者元数据的值。
visibilityDeveloperMetadataVisibility新开发者元数据的公开范围。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

applyColumnBanding()

为范围应用默认列条带主题。默认情况下,该条带有页眉,但没有页脚颜色。

返回

Banding - 新条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

applyColumnBanding(bandingTheme)

将指定的列条带主题应用于范围。默认情况下,该条带有页眉,但没有页脚颜色。

参数

名称类型说明
bandingThemeBandingTheme要应用于范围中的列的颜色主题。

返回

Banding - 新条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

applyColumnBanding(bandingTheme, showHeader, showFooter)

将指定的列条带主题应用于具有指定页眉和页脚设置的范围。

参数

名称类型说明
bandingThemeBandingTheme要应用于范围中的列的颜色主题。
showHeaderBoolean如果为 true,则条带主题标题颜色将应用于第一列。
showFooterBoolean如果为 true,则条带主题页脚颜色将应用于最后一列。

返回

Banding - 新条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

applyRowBanding()

为范围应用默认行频主题。默认情况下,该条带有页眉,但没有页脚颜色。

返回

Banding - 新条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

applyRowBanding(bandingTheme)

将指定的行条带主题应用于范围。默认情况下,该条带有页眉,但没有页脚颜色。

参数

名称类型说明
bandingThemeBandingTheme要应用于范围中各行的颜色主题。

返回

Banding - 新条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

applyRowBanding(bandingTheme, showHeader, showFooter)

将指定的行带主题应用于具有指定页眉和页脚设置的范围。

参数

名称类型说明
bandingThemeBandingTheme要应用于范围中各行的颜色主题。
showHeaderBoolean如果为 true,则条带主题标题颜色会应用于第一行。
showFooterBoolean如果为 true,则条带主题页脚颜色会应用于最后一行。

返回

Banding - 新条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoFill(destination, series)

根据此范围内的数据填充 destinationRange。新值还由指定的 series 类型确定。目标范围必须包含此范围,并且仅朝一个方向扩展。例如,以下代码会根据 A1:A4 中的当前值使用一系列递增的数字填充 A1:A20

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

参数

名称类型说明
destinationRange要自动填充值的范围。目标范围应包含此范围,并且仅向一个方向(向上、向下、向左或向右)扩展。
seriesAutoFillSeries用于计算新值的自动填充系列的类型。该系列的效果因源数据的类型和数量而异。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoFillToNeighbor(series)

根据相邻单元格计算使用新数据填充的范围,并根据此范围中包含的数据自动使用新值填充该范围。这些新值还由指定的 series 类型确定。

计算的目标范围会考虑周围的数据来确定新值应插入的位置:如果在自动填充的列的左侧或右侧有数据,则新值仅延伸到此相邻的数据。

例如,如果 A1:A20 填充了一系列递增数字,并且系统针对包含一系列日期的 B1:B4 范围调用此方法,则新值只会插入 B5:B20 中。通过这种方式,这些新值“粘滞”在包含 A 列值的单元格中。

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

参数

名称类型说明
seriesAutoFillSeries用于计算新值的自动填充系列的类型。该系列的效果因源数据的类型和数量而异。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

breakApart()

将范围中的所有多列单元格重新拆分为单独的单元格。

针对某个范围调用此函数等同于选择范围,然后点击“格式”->“合并”->“取消合并”。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

canEdit()

确定用户是否有权修改范围中的每个单元格。电子表格所有者始终可以修改受保护的范围和工作表。

返回

Boolean - 如果用户有权修改范围中的每个单元格,则返回 true;否则为 false

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

check()

将范围内复选框的状态更改为“已选中”。忽略该范围内当前未配置勾选值或未勾选值的单元格。

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clear()

清除内容、格式和数据验证规则的范围。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clear();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clear(options)

按照指定的高级选项,清除内容、格式、数据验证规则和/或注释的范围。默认情况下,所有数据都会被清除。

// The code below clears range C2:G8 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});

参数

名称类型说明
optionsObject一个 JavaScript 对象,用于指定高级参数,如下所示。

高级参数

名称类型说明
commentsOnlyBoolean是否仅清除评论。
contentsOnlyBoolean是否仅清除内容。
formatOnlyBoolean是否仅清除格式;请注意,清除格式也会清除数据验证规则。
validationsOnlyBoolean是否仅清除数据验证规则。
skipFilteredRowsBoolean是否避免清除过滤的行。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearContent()

清除范围内容,保留格式不变。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearContent();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearDataValidations()

清除范围的数据验证规则。

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearFormat()

清除此范围的格式。

这会清除范围中的单元格的文本格式,但不会重置任何数字格式规则。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearFormat();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearNote()

清除给定单元格中的备注。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearNote();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

collapseGroups()

收起整个范围内的所有群组。如果没有任何组完全在该范围内,则部分位于该范围内的最深展开组会收起。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are collapsed.
range.collapseGroups();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copyFormatToRange(gridId, column, columnEnd, row, rowEnd)

将范围的格式复制到指定位置。如果目标位置大于或小于来源范围,则相应来源会相应地重复或被截断。请注意,此方法仅复制格式。

有关 gridId 参数的详细说明,请参阅 getGridId()

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

参数

名称类型说明
gridIdInteger工作表中工作表的唯一 ID(无论位置如何)。
columnInteger目标范围的第一列。
columnEndInteger目标范围的结束列。
rowInteger目标范围的起始行。
rowEndInteger目标范围的最后一行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


copyFormatToRange(sheet, column, columnEnd, row, rowEnd)

将范围的格式复制到指定位置。如果目标位置大于或小于来源范围,则相应来源会相应地重复或被截断。请注意,此方法仅复制格式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

参数

名称类型说明
sheetSheet目标工作表。
columnInteger目标范围的第一列。
columnEndInteger目标范围的结束列。
rowInteger目标范围的起始行。
rowEndInteger目标范围的最后一行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copyTo(destination)

将数据从一个单元格范围复制到另一个单元格范围。值和格式都会被复制。

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

参数

名称类型说明
destinationRange要复制到的目标范围;仅与左上角的单元格位置相关。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copyTo(destination, copyPasteType, transposed)

将数据从一个单元格范围复制到另一个单元格范围。

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

参数

名称类型说明
destinationRange要复制到的目标范围;仅与左上角的单元格位置相关。
copyPasteTypeCopyPasteType指定如何将范围内容粘贴到目的地的类型。
transposedBoolean是否应将范围粘贴到转置的方向上。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copyTo(destination, options)

将数据从一个单元格范围复制到另一个单元格范围。默认情况下,系统会复制相应值和格式,但您可以使用高级参数替换这些值和格式。

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

参数

名称类型说明
destinationRange要复制到的目标范围;仅与左上角的单元格位置相关。
optionsObject一个 JavaScript 对象,用于指定高级参数,如下所示。

高级参数

名称类型说明
formatOnlyBoolean指定应仅复制格式
contentsOnlyBoolean指定只复制内容

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copyValuesToRange(gridId, column, columnEnd, row, rowEnd)

将范围的内容复制到指定位置。如果目的地大于或小于来源范围,则来源就会相应地重复或被截断。

有关 gridId 参数的详细说明,请参阅 getGridId()

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

参数

名称类型说明
gridIdInteger工作表中工作表的唯一 ID(无论位置如何)。
columnInteger目标范围的第一列。
columnEndInteger目标范围的结束列。
rowInteger目标范围的起始行。
rowEndInteger目标范围的最后一行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


copyValuesToRange(sheet, column, columnEnd, row, rowEnd)

将范围的内容复制到指定位置。如果目的地大于或小于来源范围,则来源就会相应地重复或被截断。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

参数

名称类型说明
sheetSheet目标工作表。
columnInteger目标范围的第一列。
columnEndInteger目标范围的结束列。
rowInteger目标范围的起始行。
rowEndInteger目标范围的最后一行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourcePivotTable(dataSource)

基于数据源创建空数据源数据透视表,其锚定在该范围的第一个单元格中。

此示例展示了如何创建和配置新的数据源数据透视表。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

参数

名称类型说明
dataSourceDataSource作为创建数据透视表的数据源。

返回

DataSourcePivotTable - 新创建的数据源数据透视表。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourceTable(dataSource)

基于数据源创建空数据源表,该表将锚定到此范围内的第一个单元格。

此示例展示了如何创建和配置新的数据源表。

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

参数

名称类型说明
dataSourceDataSource作为创建数据透视表的数据源。

返回

DataSourceTable - 新创建的数据源表。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDeveloperMetadataFinder()

返回一个 DeveloperMetadataFinderApi,用于查找此范围内的开发者元数据。元数据完全位于该范围内,前提是元数据完全在该范围内。例如,与行“3:3”关联的元数据不在范围“A1:D5”的范围内,而是在范围“1:5”的范围内。

返回

DeveloperMetadataFinder - 用于搜索此范围内元数据的开发者元数据查找器。


createFilter()

创建过滤器并将其应用于工作表中的指定范围。您不能在一个工作表中创建多个过滤条件。如需在创建过滤器后对其进行访问和修改,请使用 getFilter()Sheet.getFilter()

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
使用此方法可为 Grid 页(默认工作表类型)创建过滤器。 网格工作表是指未连接到数据库的工作表。如需创建其他类型的过滤器,请参阅以下内容:

返回

Filter - 新的过滤条件。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createPivotTable(sourceData)

根据锚定到此范围中第一个单元格的指定 sourceData 来创建空数据透视表。

参数

名称类型说明
sourceDataRange要创建数据透视表的数据。

返回

PivotTable - 新创建的 PivotTable

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createTextFinder(findText)

为相应范围创建文本查找器,以查找和替换此范围中的文本。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

// Returns the first occurrence of 'dog'.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

参数

名称类型说明
findTextString要搜索的文本。

返回

TextFinder - 范围的 TextFinder


deleteCells(shiftDimension)

删除此范围单元格。工作表中沿所提供的维度的现有数据会移至已删除的范围。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

参数

名称类型说明
shiftDimensionDimension用于移动现有数据的维度。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

expandGroups()

展开收起的范围(其范围或控件切换开关与此范围相交)。控制切换开关位置是指在群组显示之前或之后显示控制切换开关的索引(具体取决于设置)。如果同一位置有多个组,则最宽的组会展开。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are expanded.
range.expandGroups();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getA1Notation()

返回采用 A1 表示法表示的范围字符串说明。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

返回

String - 以 A1 表示法表示的范围的字符串说明。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getBackground()

返回范围内左上角单元格的背景颜色(例如 '#ffffff')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

返回

String - 背景的颜色代码。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getBackgroundObject()

返回范围内左上角单元格的背景颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

返回

Color - 范围内左上角单元格的背景颜色。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getBackgroundObjects()

返回范围中单元格的背景颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

返回

Color[][] - 背景颜色的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getBackgrounds()

返回范围内的单元格的背景颜色(例如 '#ffffff')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

返回

String[][] - 背景的二维颜色代码数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getBandings()

返回此范围内所有单元格应用的所有条带。

返回

Banding[] - 在此范围内的所有单元格中应用的所有条带。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCell(row, column)

返回范围内的给定单元格。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

参数

名称类型说明
rowInteger单元格的范围范围。
columnInteger单元格范围(相对于范围)。

返回

Range - 包含指定坐标处的单个单元格的范围。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumn()

返回此范围的起始列位置。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

返回

Integer - 范围在电子表格中的起始列位置。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataRegion()

返回在四个基数 Direction 中扩展的范围的副本,以覆盖包含相应数据的所有相邻单元格。如果范围被包含对角线中的空白单元格的空单元格括起,则会返回范围本身。这类似于在编辑器中选择范围并输入 Ctrl+A

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

返回

Range - 相应范围的数据区域或整个电子表格的范围。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataRegion(dimension)

如果指定的维度为 Dimension.ROWS,则返回范围扩展的 Direction.UPDirection.DOWN 的副本;如果维度为 Dimension.COLUMNS,则返回 Direction.NEXTDirection.PREVIOUS。该范围扩展的原理是检测范围(类似于表)中的数据。扩展范围涵盖所有沿指定维度(包括表边界)的数据的相邻单元格。如果原始范围沿指定维度被空单元格包围,则返回范围本身。这类似于在编辑器中选择范围并为列输入 Ctrl+Space,或在编辑器中输入 Shift+Space

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

参数

名称类型说明
dimensionDimension要扩展范围所依据的维度。

返回

Range - 该范围的数据范围或涵盖每一列或原始范围跨越的每行的范围。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceFormula()

返回范围内第一个单元格的 DataSourceFormula,如果单元格不包含数据源公式,则返回 null

返回

DataSourceFormula - 单元格的 DataSourceFormula

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceFormulas()

返回范围中单元格的 DataSourceFormula

返回

DataSourceFormula[] - 由 DataSourceFormula 组成的数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourcePivotTables()

获取与范围相交的所有数据源数据透视表。

返回

DataSourcePivotTable[] - 数据源数据透视表的列表。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceTables()

获取与范围相交的所有数据源表。

返回

DataSourceTable[] - 数据源表列表。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceUrl()

返回此范围内数据的网址,该网址可用于创建图表和查询。

Code.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

piechart.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

返回

String - 此范围的网址,可作为数据源传递给其他 API(例如图表)。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataTable()

以 DataTable 的形式返回此对象中的数据。

返回

DataTable - 作为数据表的数据。


getDataTable(firstRowIsHeader)

以 DataTable 的形式返回此范围内的数据。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

参数

名称类型说明
firstRowIsHeaderBoolean是否将第一行视为标题。

返回

DataTable - 作为数据表的数据。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataValidation()

返回范围中左上角单元格的数据验证规则。如果未在单元格上设置数据验证,此方法会返回 null

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

返回

DataValidation - 范围内左上角单元格的数据验证规则。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataValidations()

返回范围内所有单元格的数据验证规则。如果给定单元格尚未设置数据验证,此方法会针对该单元格在数组中的位置返回 null

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

返回

DataValidation[][] - 与范围中的单元格相关联的数据验证规则的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDeveloperMetadata()

获取与此范围关联的开发者元数据。

返回

DeveloperMetadata[] - 与此范围关联的开发者元数据。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDisplayValue()

返回范围中左上角单元格的显示值。值为 String。 显示的值会考虑日期、时间和货币格式设置,包括电子表格的语言区域设置自动应用的格式。空单元格会返回空字符串。

返回

String - 此单元格内显示的值。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDisplayValues()

返回此范围中的矩形网格值。

返回显示值的二维数组,按行编入索引,然后按列编入索引。值为 String 对象。显示的值会考虑日期、时间和货币格式,包括电子表格的语言区域设置自动应用的格式。空单元格由数组中的空字符串表示。请注意,范围索引从 1, 1 开始,但 JavaScript 数组将从 [0][0] 编入索引。

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

返回

String[][] - 二维值数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilter()

返回此范围所属的工作表上的过滤条件;如果工作表上没有任何过滤条件,则返回 null

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

返回

Filter - 过滤条件。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontColorObject()

返回单元格左上角相应单元格的字体颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

返回

Color - 范围内左上角单元格的字体颜色。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontColorObjects()

返回范围内的单元格的字体颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

返回

Color[][] - 与范围中的单元格相关联的字体颜色的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontFamilies()

返回范围内的单元格的字体系列。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围中的单元格相关联的字体系列的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontFamily()

返回单元格左上角的字体集。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontFamily());

返回

String - 单元格的字体系列。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontLine()

获取范围左上角的单元格线条样式('underline''line-through''none')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontLine());

返回

String - 字体行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontLines()

获取范围('underline''line-through''none')中单元格的线条样式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围中的单元格相关联的字体行的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontSize()

返回单元格左上角相应单元格中字体大小的字体大小。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontSize());

返回

Integer - 字号的字体大小。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontSizes()

返回范围中单元格的字体大小。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontSizes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

Integer[][] - 与范围中的单元格相关联的文本大小的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontStyle()

返回单元格左上角相应范围的字体样式('italic''normal')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontStyle());

返回

String - 单元格中文本的字体样式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontStyles()

返回范围内的单元格的字体样式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontStyles();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围单元格关联的文本样式的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontWeight()

返回单元格左上角字体粗细(正常/粗体)的范围。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontWeight());

返回

String - 单元格中文本的字体粗细。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFontWeights()

返回范围内的单元格的字体粗细。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontWeights();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围中的单元格相关联的文本的二维字体粗细数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFormula()

返回范围左上角单元格的公式(A1 表示法);如果单元格为空或不包含公式,则为空字符串。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This assumes you have a function in B5 that sums up
// B2:B4
var range = sheet.getRange("B5");

// Logs the calculated value and the formula
Logger.log("Calculated value: %s Formula: %s",
           range.getValue(),
           range.getFormula());

返回

String - 单元格的公式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFormulaR1C1()

返回给定单元格的公式(R1C1 表示法);如果没有,则返回 null

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

返回

String - 采用 R1C1 表示法的公式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFormulas()

返回范围中单元格的公式(A1 表示法)。对于没有公式的单元格,二维数组中的条目是空字符串。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulas();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

返回

String[][] - 字符串格式的公式二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFormulasR1C1()

返回范围中单元格的公式(R1C1 表示法)。对于没有公式的单元格,2D 数组中的条目为 null

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulasR1C1();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

返回

String[][] - 采用二维公式的二维数组,采用 R1C1 表示法。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getGridId()

返回范围的父工作表的网格 ID。ID 是随机的非负 int 值。

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

返回

Integer - 父工作表的网格 ID。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getHeight()

返回范围的高度。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// logs 3.0
Logger.log(range.getHeight());

返回

Integer - 范围的高度。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getHorizontalAlignment()

返回单元格左上角文本(水平/左上角)的水平对齐方式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getHorizontalAlignment());

返回

String - 单元格中的文本水平对齐方式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getHorizontalAlignments()

返回单元格内相应单元格的水平对齐方式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围中的单元格关联的文本水平对齐的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLastColumn()

返回结束列的位置。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastColumn());

返回

Integer - 范围在电子表格中的结束列位置。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLastRow()

返回结束行位置。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastRow());

返回

Integer - 范围在电子表格中的结束行位置。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getMergedRanges()

返回一个 Range 对象数组,表示完全位于当前范围内的单元格或包含当前范围内至少一个单元格的合并单元格。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B3");

var mergedRanges = range.getMergedRanges();
for (var i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

返回

Range[] - 一组 Range 对象,表示与范围重叠的合并单元格。


getNextDataCell(direction)

从范围第一行和首行的单元格开始,返回给定方向上的下一个单元格,即包含数据的连续单元格范围的边缘,或电子表格方向上单元格边缘的单元格。等同于在编辑器中输入 Ctrl+[arrow key]

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("C3:E5");
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

参数

名称类型说明
directionDirection下一个数据区域边缘单元格的查找方向。

返回

Range - 数据区域边缘单元格或电子表格边缘的单元格。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNote()

返回与指定范围关联的备注。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getNote());

返回

String - 与给定单元格关联的备注。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNotes()

返回与范围中的单元格相关联的备注。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getNotes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围单元格关联的二维备注数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNumColumns()

返回此范围内的列数。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

返回

Integer - 此范围中的列数。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNumRows()

返回此范围内的行数。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

返回

Integer - 此范围中的行数。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNumberFormat()

获取给定范围左上角的单元格的数字或日期格式。Sheets API 文档中介绍了返回的格式模式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

返回

String - 范围左上角的单元格的数字格式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNumberFormats()

返回单元格中数字或日期的格式。Sheets API 文档中介绍了返回的格式模式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formats = range.getNumberFormats();
for (var i in formats) {
  for (var j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

返回

String[][] - 数字格式的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRichTextValue()

返回范围左上角的单元格的富文本值。如果单元格值不是文本,则返回 null

// Get the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
Logger.log(richText);

返回

RichTextValue - 范围内左上角单元格的富文本值;如果单元格值不是文本,则设为 null

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRichTextValues()

返回范围中单元格的富文本值。

// Get the Rich Text values for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var j = 0; j < values[i].length; j++) {
    Logger.log(values[i][j]);
  }
}

返回

RichTextValue[][] - 富文本值的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRow()

返回此范围的行位置。与 getRowIndex() 相同。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2");
Logger.log(range.getRow());

返回

Integer - 范围的行位置。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRowIndex()

返回此范围的行位置。与 getRow() 相同。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2");
Logger.log(range.getRowIndex());

返回

Integer - 范围的行位置。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


getSheet()

返回此范围所属的工作表。

返回

Sheet - 此范围所属的工作表。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTextDirection()

返回范围左上角的单元格的文本方向。如果单元格文本方向是通过自动检测确定的,则返回 null

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

返回

TextDirection - 范围内左上角单元格的文本方向。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTextDirections()

返回范围中单元格的文本方向。对于使用自动检测的单元格,2D 数组中的条目为 null

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

返回

TextDirection[][] - 二维文本方向数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTextRotation()

返回范围左上角的单元格的文本旋转设置。

// Log the text rotation settings for a cell.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

返回

TextRotation - 文本旋转设置。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTextRotations()

返回范围中单元格的文本旋转设置。

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var rotation = results[i][j];
    Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation);
  }
}

返回

TextRotation[][] - 与范围单元格关联的二维文本旋转数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTextStyle()

返回范围左上角的单元格的文本样式。

// Get the text style of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

返回

TextStyle - 范围内左上角单元格的文本样式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getTextStyles()

返回范围中单元格的文本样式。

// Get the text styles for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

返回

TextStyle[][] - 二维文本样式数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getValue()

返回范围中左上角单元格的值。该值的类型可以是 NumberBooleanDateString,具体取决于单元格的值。空单元格会返回空字符串。

返回

Object - 此单元格中的值。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getValues()

返回此范围中的矩形网格值。

返回一个二维值数组,按行编入索引,然后按列。该值的类型可以是 NumberBooleanDateString,具体取决于单元格的值。空单元格由数组中的空字符串表示。请注意,范围索引从 1, 1 开始,但 JavaScript 数组将从 [0][0] 编入索引。

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);
在 Web 应用中,Date 值不是合法参数。如果范围包含值为 Date 的单元格,则 getValues() 无法向 Web 应用返回数据。而应将从工作表中检索的所有值转换为受支持的 JavaScript 原语(如 NumberBooleanString)。

返回

Object[][] - 二维值数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getVerticalAlignment()

返回单元格在范围左上角的垂直对齐方式(顶部/中间/底部)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getVerticalAlignment());

返回

String - 单元格中文本的垂直对齐方式。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getVerticalAlignments()

返回范围中单元格的垂直对齐方式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

返回

String[][] - 与范围单元格关联的文本垂直对齐的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWidth()

以列为单位返回范围的宽度。

返回

Integer - 范围内的列数。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWrap()

返回单元格中的文本是否换行。如需获取更精细的封装策略,请使用 getWrapStrategy()

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getWrap());

返回

Boolean - 此单元格中的文本是否换行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWrapStrategies()

返回单元格范围内的文本换行策略。

// Get the text wrapping strategies for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

返回

WrapStrategy[][] - 文本封装策略的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWrapStrategy()

返回范围左上角的单元格的文本换行策略。

// Get the text wrapping strategy of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getWrapStrategy());

返回

WrapStrategy - 范围内左上角单元格的文本换行策略。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getWraps()

返回单元格中的文本是否换行。如需获取更精细的封装策略,请使用 getWrapStrategies()

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var isWrapped = results[i][j];
    if (isWrapped) {
       Logger.log("Cell [%s, %s] has wrapped text", i, j);
    }
  }
}

返回

Boolean[][] - 与范围单元格关联的文本垂直对齐的二维数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCells(shiftDimension)

在此范围内插入空白单元格。新单元格会保留之前占据此范围内的单元格中的任何格式。工作表中沿所提供的维度的现有数据会从插入的范围中移开。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

参数

名称类型说明
shiftDimensionDimension用于移动现有数据的维度。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCheckboxes()

在相应范围的每个单元格中插入复选框,并配置 true 表示已选中,false 表示未选中。将范围中所有单元格的值设置为 false

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'.
range.insertCheckboxes();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCheckboxes(checkedValue)

在相应范围的每个单元格中插入复选框,并配置一个自定义值(针对已选中)和空字符串(对于取消选中状态)。将范围中每个单元格的值设置为空字符串。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

参数

名称类型说明
checkedValueObject复选框数据验证的选中值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertCheckboxes(checkedValue, uncheckedValue)

将复选框插入范围内的每个单元格,并配置自定义值作为已选中和未选中状态的值。将范围中每个单元格的值设置为自定义未选中的值。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

参数

名称类型说明
checkedValueObject复选框数据验证的选中值。
uncheckedValueObject复选框数据验证的未选中值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isBlank()

如果范围完全为空,则返回 true

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.isBlank());

返回

Boolean - 如果范围为空,则为 true;否则为 false

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isChecked()

返回范围内所有单元格的复选框状态是否为“已勾选”。如果某些单元格已被选中而其他单元格未选中,或者某些单元格没有复选框数据验证,则返回 null

var range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

返回

Boolean - true(如果范围内的所有单元格均已选中),如果范围内的所有单元格都未选中,则为 false;如果任何单元格未选中或没有复选框数据验证,则为 null

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isEndColumnBounded()

确定范围的末尾是否绑定到特定列。例如,对于范围绑定到范围末尾的列的 A1:B10B:B 范围,此方法会返回 true;对于范围 3:7A1:5(范围仅绑定到范围末尾的特定行),此方法会返回 false

返回

Boolean - 如果范围的末尾绑定到特定列,则为 true;否则为 false

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isEndRowBounded()

确定范围的末尾是否绑定到特定行。例如,对于范围绑定到范围末尾的行的 A1:B103:7 范围,此方法会返回 true;对于范围 B:BA1:C 范围(仅绑定到范围末尾的特定列),此方法会返回 false

返回

Boolean - 如果范围的末尾绑定到特定行,则为 true;否则为 false

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isPartOfMerge()

如果当前范围内的单元格与已合并的单元格重叠,则返回 true

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B3");

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

返回

Boolean - 如果范围与合并的任何单元格重叠,则返回 true,否则返回 false


isStartColumnBounded()

确定范围的开头是否绑定到特定列。例如,对于范围开头的 A1:B10B:B 范围,此方法会返回 true;对于范围 3:7(仅绑定到范围开头的行),此方法会返回 false

返回

Boolean - 如果范围的开头绑定到特定列,则为 true;否则为 false

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isStartRowBounded()

确定范围的开头是否绑定到特定行。例如,对于范围为在范围开头处绑定到行的 A1:B103:7 范围,此方法会返回 true;对于范围 B:B (范围仅绑定到范围开始时的特定列),此方法会返回 false

返回

Boolean - 如果范围起点绑定到特定行,则为 true;否则为 false

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

merge()

将范围中的单元格合并为一个文本块。

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

mergeAcross()

合并该范围中跨相应列的各个单元格。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

mergeVertically()

将范围中的单元格合并。

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveTo(target)

从此范围剪切并粘贴(格式和值)到目标范围。

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

参数

名称类型说明
targetRange要将此范围复制到的目标范围;仅左上角单元格位置相关。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

offset(rowOffset, columnOffset)

返回给定范围的行数和列数(可以是负数)相对于此范围的新范围。新范围的大小与原始范围相同。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

参数

名称类型说明
rowOffsetInteger自范围的左上角单元格行数;负值表示范围左上角的单元格行数。
columnOffsetInteger范围左上角的单元格的列数;负值表示范围左上角的单元格左侧的列数。

返回

Range - 此范围,用于串联。


offset(rowOffset, columnOffset, numRows)

返回相对于当前范围的新范围,其左上角与当前范围相隔给定的行和列,并且具有给定高度的单元格。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

参数

名称类型说明
rowOffsetInteger自范围的左上角单元格行数;负值表示范围左上角的单元格行数。
columnOffsetInteger范围左上角的单元格的列数;负值表示范围左上角的单元格左侧的列数。
numRowsInteger新范围中行高。

返回

Range - 此范围,用于串联。


offset(rowOffset, columnOffset, numRows, numColumns)

返回相对于当前范围的新范围,其左上角通过给定行和列与当前范围偏移,并且具有给定单元格高度和宽度。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2:C3
var newRange = cell.offset(1, 1, 2, 2);

参数

名称类型说明
rowOffsetInteger自范围的左上角单元格行数;负值表示范围左上角的单元格行数。
columnOffsetInteger范围左上角的单元格的列数;负值表示范围左上角的单元格左侧的列数。
numRowsInteger新范围中行高。
numColumnsInteger新范围中的列宽。

返回

Range - 此范围,用于串联。


protect()

创建一个对象,该对象可防止除了拥有权限的用户修改该范围。在脚本实际更改范围的编辑器列表(通过调用 Protection.removeEditor(emailAddress)Protection.removeEditor(user)Protection.removeEditors(emailAddresses)Protection.addEditor(emailAddress)Protection.addEditor(user)Protection.addEditors(emailAddresses) 或为 Protection.setDomainEdit(editable) 设置新值)之前,权限会镜像电子表格本身的权限,这意味着该范围实际上不会受到保护。如果该范围已被保护,则此方法会创建与现有范围重叠的新受保护范围。如果某个单元格受多个受保护范围保护,并且其中任一范围阻止特定用户修改单元格,则不允许该用户修改单元格。

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

返回

Protection - 表示保护设置的对象。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

randomize()

随机排列给定范围中各行的顺序。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Randomizes the range
range.randomize();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeCheckboxes()

移除范围中的所有复选框。清除每个单元格的数据验证,并在相应单元格包含已选中或未选中的值时清除其值。

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeDuplicates()

移除此范围中包含与之前任何行中的值重复的行。值相同但字母大小写、格式或公式不同的行会被视为重复行。此方法还会移除在视图中隐藏的重复行(例如,因过滤条件而隐藏)。系统不会移除超出此范围的内容。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove duplicate rows in the range.
range.removeDuplicates();

返回

Range - 移除重复项后生成的范围。系统会针对移除的每一行将范围的大小缩小一行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeDuplicates(columnsToCompare)

移除此范围中包含指定列中与前一行重复的值的行。值相同但字母大小写、格式或公式不同的行会被视为重复行。此方法还会移除在视图中隐藏的重复行(例如,因过滤条件而隐藏)。系统不会移除超出此范围的内容。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

参数

名称类型说明
columnsToCompareInteger[]要分析是否存在重复值的列。如果未提供任何列,则分析所有列,确认是否存在重复。

返回

Range - 移除重复项后生成的范围。系统会针对移除的每一行将范围的大小缩小一行。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackground(color)

以 CSS 表示法(例如 '#ffffff''white')设置范围内所有单元格的背景颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
range.setBackground("red");

参数

名称类型说明
colorString采用 CSS 表示法的颜色代码(例如 '#ffffff''white');值 null 可重置颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgroundObject(color)

设置范围中所有单元格的背景颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

参数

名称类型说明
colorColor要设置的背景颜色;null 值会重置背景颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgroundObjects(color)

用于设置背景颜色的矩形网格(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

参数

名称类型说明
colorColor[][]一个二维颜色数组;null 值会重置颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgroundRGB(red, green, blue)

使用 RGB 值(0 到 255 之间的整数,包括 0 和 255)将背景设置为指定的颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

参数

名称类型说明
redInteger红色值(采用 RGB 表示法)。
greenInteger绿色值(采用 RGB 表示法)。
blueInteger以 RGB 表示法表示的蓝色值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBackgrounds(color)

用于设置背景颜色的矩形网格(必须与此范围的尺寸匹配)。颜色采用 CSS 表示法(例如 '#ffffff''white')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

参数

名称类型说明
colorString[][]一个二维颜色数组,采用 CSS 表示法(例如 '#ffffff''white');null 值用于重置颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBorder(top, left, bottom, right, vertical, horizontal)

设置边框属性。有效值为 true(开启)、false(关闭)和 null(无变化)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

参数

名称类型说明
topBooleantrue 表示边框,false 表示无边框,null 表示无更改。
leftBooleantrue 表示边框,false 表示无边框,null 表示无更改。
bottomBooleantrue 表示边框,false 表示无边框,null 表示无更改。
rightBooleantrue 表示边框,false 表示无边框,null 表示无更改。
verticalBooleantrue 表示内部垂直边框,false 表示无边框,null 表示无更改。
horizontalBooleantrue 表示内部水平边框,false 表示无边框,null 表示不更改。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

设置颜色和/或样式的边框属性。有效值为 true(开启)、false(关闭)和 null(未更改)。对于颜色,请使用 CSS 表示法中的颜色(例如 '#ffffff''white')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);

参数

名称类型说明
topBooleantrue 表示边框,false 表示无边框,null 表示无更改。
leftBooleantrue 表示边框,false 表示无边框,null 表示无更改。
bottomBooleantrue 表示边框,false 表示无边框,null 表示无更改。
rightBooleantrue 表示边框,false 表示无边框,null 表示无更改。
verticalBooleantrue 表示内部垂直边框,false 表示无边框,null 表示无更改。
horizontalBooleantrue 表示内部水平边框,false 表示无边框,null 表示不更改。
colorString采用 CSS 表示法的颜色(例如 '#ffffff''white'),默认颜色为 null(黑色)。
styleBorderStyle边框样式,默认样式:null(默认)。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setDataValidation(rule)

为范围中的所有单元格设置一条数据验证规则。

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

参数

名称类型说明
ruleDataValidation要设置的数据验证规则,或 null 以移除数据验证。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setDataValidations(rules)

为范围中的所有单元格设置数据验证规则。此方法采用一个二维数据验证数组,依次按行和列编制索引。数组维度必须与范围维度相对应。

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

参数

名称类型说明
rulesDataValidation[][]要设置的二维数据验证规则数组;null 值用于移除数据验证。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontColor(color)

设置 CSS 表示法中的字体颜色(例如 '#ffffff''white')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontColor("red");

参数

名称类型说明
colorString字体颜色,采用 CSS 表示法(例如 '#ffffff''white');null 值会重置颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontColorObject(color)

设置指定范围的字体颜色。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

var cell = sheet.getRange("B2");
cell.setFontColor(color);

参数

名称类型说明
colorColor要设置的字体颜色;值为 null 会重置颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontColorObjects(colors)

用于设置矩形颜色网格网格(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

参数

名称类型说明
colorsColor[][]一个二维颜色数组;null 值会重置字体颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontColors(colors)

设置矩形字体网格(必须与此范围的尺寸匹配)。颜色采用 CSS 表示法(例如 '#ffffff''white')。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

参数

名称类型说明
colorsObject[][]一个二维颜色数组,采用 CSS 表示法(例如 '#ffffff''white');null 值用于重置颜色。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontFamilies(fontFamilies)

设置矩形字体网格系列(必须与此范围的尺寸匹配)。字体系列示例包括“Nearline”或“Helvetica”。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

参数

名称类型说明
fontFamiliesObject[][]一个二维字体系列数组;null 值会重置字体系列。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontFamily(fontFamily)

设置字体系列,例如“ Arial”或“Helvetica”。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

参数

名称类型说明
fontFamilyString要设置的字体系列;值 null 会重置字体系列。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontLine(fontLine)

设置指定范围('underline''line-through''none')的字体线条样式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

参数

名称类型说明
fontLineString字体线条样式,即 'underline''line-through''none'null 值用于重置字体线条样式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontLines(fontLines)

设置矩形网格网格样式(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

参数

名称类型说明
fontLinesObject[][]一个二维字体线条样式数组('underline''line-through''none');null 值会重置字体线条样式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontSize(size)

设置字体大小,字体大小为要使用的点大小。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontSize(20);

参数

名称类型说明
sizeInteger以点号表示的字体大小。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontSizes(sizes)

用于设置字体大小的矩形网格(必须与此范围的尺寸匹配)。尺寸以点为单位。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

参数

名称类型说明
sizesObject[][]一个二维尺寸数组。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontStyle(fontStyle)

为指定范围('italic''normal')设置字体样式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

参数

名称类型说明
fontStyleString字体样式,即 'italic''normal'null 值用于重置字体样式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontStyles(fontStyles)

设置矩形字体网格(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

参数

名称类型说明
fontStylesObject[][]一个二维字体样式数组,'italic''normal'null 值用于重置字体样式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontWeight(fontWeight)

为指定范围(正常/粗体)设置字体粗细。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

参数

名称类型说明
fontWeightString字体粗细,为 'bold''normal'null 值用于重置字体粗细。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFontWeights(fontWeights)

用于设置字体粗细的矩形网格(必须与此范围的尺寸匹配)。字体粗细的示例为“粗体”。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

参数

名称类型说明
fontWeightsObject[][]一个字体二维数组,可以是 'bold''normal'null 值用于重置字体粗细。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormula(formula)

更新此范围的公式。指定的公式必须采用 A1 表示法。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

参数

名称类型说明
formulaString一个字符串,表示要为单元格设置的公式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulaR1C1(formula)

更新此范围的公式。指定的公式必须采用 R1C1 表示法。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

参数

名称类型说明
formulaString字符串公式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulas(formulas)

用于设置公式中的矩形网格(必须与此范围的维度相匹配)。指定的公式必须采用 A1 表示法。此方法采用一个二维公式数组,依次按行和列编入索引。数组维度必须与范围维度相对应。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

参数

名称类型说明
formulasString[][]公式的二维字符串数组。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFormulasR1C1(formulas)

用于设置公式中的矩形网格(必须与此范围的维度相匹配)。指定的公式必须采用 R1C1 表示法。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

参数

名称类型说明
formulasString[][]采用 R1C1 格式的二维公式数组。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHorizontalAlignment(alignment)

为给定范围(左侧/中心/右侧)设置水平(左到右)对齐。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

参数

名称类型说明
alignmentString对齐方式:'left''center''normal'null 值用于重置对齐方式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHorizontalAlignments(alignments)

设置水平对齐的矩形网格。请参阅 setHorizontalAlignment(alignment)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

参数

名称类型说明
alignmentsObject[][]二维对齐数组,可以是 'left''center''normal'null 值可用于重置对齐。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


setNote(note)

将备注设置为指定值。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

参数

名称类型说明
noteString要为范围设置的备注值;使用 null 值可移除备注。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNotes(notes)

用于设置矩形备注网格(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

参数

名称类型说明
notesObject[][]一个二维备注数组;null 值用于移除备注。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


setNumberFormat(numberFormat)

将数字或日期格式设置为指定的格式字符串。Sheets API 文档中介绍了可接受的格式模式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

参数

名称类型说明
numberFormatString数字格式的字符串。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNumberFormats(numberFormats)

用于设置数字或日期格式的矩形网格(必须与此范围的尺寸匹配)。这些值是格式表格字符串,如 Sheets API 文档中所述。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

参数

名称类型说明
numberFormatsObject[][]一个二维数字格式数组。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRichTextValue(value)

为范围中的单元格设置富文本值。

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

参数

名称类型说明
valueRichTextValue所需的富文本值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRichTextValues(values)

设置富文本值的矩形网格。

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

参数

名称类型说明
valuesRichTextValue[][]所需的富文本值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

设置该范围是否应显示超链接。

参数

名称类型说明
showHyperlinkBoolean是否显示超链接。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirection(direction)

设置范围中单元格的文本方向。如果指定的方向是 null,系统会推断出该方向,然后对其进行设置。

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

参数

名称类型说明
directionTextDirection所需的文本方向;如果为 null,则在设置之前系统会推断出方向。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextDirections(directions)

设置文本方向的矩形网格。如果指定的方向是 null,则系统会推断出方向,然后进行设置。

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

参数

名称类型说明
directionsTextDirection[][]所需的文本方向;如果指定的方向是 null,则系统会在设置之前推断该方向。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(degrees)

为范围中的单元格设定文本旋转设置。输入对应于标准文本方向和所需方向之间的角度。输入值 0 表示文本设置为标准方向。

对于从左到右的文本方向,正角呈逆时针方向,而从右到左的方向则呈顺时针方向。

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

参数

名称类型说明
degreesInteger标准屏幕方向与所需屏幕方向之间的夹角。 对于从左到右的文本,正角呈逆时针方向。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotation(rotation)

为范围中的单元格设定文本旋转设置。

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

参数

名称类型说明
rotationTextRotation所需的文本旋转设置。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextRotations(rotations)

用于设置文本旋转功能的矩形网格。

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

参数

名称类型说明
rotationsTextRotation[][]所需的文本旋转设置。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextStyle(style)

为范围中的单元格设置文本样式。

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

参数

名称类型说明
styleTextStyle所需的文本样式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setTextStyles(styles)

设置矩形文本网格。

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

参数

名称类型说明
stylesTextStyle[][]所需的文本样式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValue(value)

设置范围的值。该值可以是数字、字符串、布尔值或日期。如果以 '=' 开头,则会被解释为公式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setValue(100);

参数

名称类型说明
valueObject范围的值。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setValues(values)

设置矩形值网格(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

参数

名称类型说明
valuesObject[][]一个二维值数组。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignment(alignment)

为给定范围(顶部/中间/底部)设置垂直(顶部至底部)对齐方式。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

参数

名称类型说明
alignmentString对齐方式:'top''middle''bottom'null 值用于重置对齐方式。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setVerticalAlignments(alignments)

用于设置矩形垂直网格对齐(必须与此范围的尺寸匹配)。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

参数

名称类型说明
alignmentsObject[][]一个二维对齐数组,可以是 'top''middle''bottom'null 值可用于重置对齐。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


setVerticalText(isVertical)

设置是否堆叠范围内的单元格文本。如果文本是垂直堆叠的,度数文本旋转设置将被忽略。

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

参数

名称类型说明
isVerticalBoolean是否堆叠文字。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrap(isWrapEnabled)

设置指定范围的单元格换行。

已启用自动换行(默认)功能的单元格会调整大小,以显示其完整内容。已停用换行功能的单元格会尽可能地显示内容,而不会调整其大小或运行多行内容。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setWrap(true);

参数

名称类型说明
isWrapEnabledBoolean是否自动换行。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategies(strategies)

用于设置矩形的封装策略网格。

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

参数

名称类型说明
strategiesWrapStrategy[][]所需的封装策略。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWrapStrategy(strategy)

为相应范围内的单元格设置文本换行策略。

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

参数

名称类型说明
strategyWrapStrategy所需的封装策略。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setWraps(isWrapEnabled)

设置矩形换行策略网格(必须与此范围的尺寸匹配)。已启用自动换行(默认)功能的单元格会调整大小,以显示完整的内容。已停用换行功能的单元格会尽可能多地在单元格中显示,而不会调整大小或运行至多行。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

参数

名称类型说明
isWrapEnabledObject[][]二维封装变量,用于确定是否封装单元格中的文本。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

另请参阅


shiftColumnGroupDepth(delta)

将范围的列分组深度按指定的数量更改。

此操作会创建、修改或删除与范围相交的群组。对于正增量,系统会创建和修改组;对于负增量,系统会销毁和/或修改组。

当减小分组深度低于 0 或大于 8 时,没有任何影响。

如果 column group control positionBEFORE,则会在尝试偏移第一行的深度时抛出错误。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

参数

名称类型说明
deltaInteger更改此范围的列组深度的金额。

返回

Range - 此范围,用于串联。

抛出

Error - 尝试在控件位置处于 GroupControlTogglePosition.BEFORE 时改变第一列的深度

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

shiftRowGroupDepth(delta)

将范围的行分组深度更改为指定量。

此操作会创建、修改或删除与范围相交的群组。对于正增量,系统会创建和修改组;对于负增量,系统会销毁和/或修改组。

当减小分组深度低于 0 或大于 8 时,没有任何影响。

如果 row group control positionBEFORE,则会在尝试偏移第一行的深度时抛出错误。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

参数

名称类型说明
deltaInteger更改此范围的行组深度的金额。

返回

Range - 此范围,用于串联。

抛出

Error - 尝试在控件位置处于 GroupControlTogglePosition.BEFORE 时改变第一行的深度

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(sortSpecObj)

根据指定的列和顺序对指定范围内的单元格进行排序。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

参数

名称类型说明
sortSpecObjObject要排序的列。

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns()

根据自动检测的分隔符,将一列文本拆分为多列。

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns(delimiter)

将某列文本拆分为多列,并将指定字符串用作自定义分隔符。

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

参数

名称类型说明
delimiterString要拆分的自定义分隔符。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

splitTextToColumns(delimiter)

根据指定的分隔符将一列文本拆分为多列。

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

参数

名称类型说明
delimiterTextToColumnsDelimiter要拆分的预设分隔符。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

trimWhitespace()

去除此范围中的每个单元格中的空格(例如空格、制表符或换行符)。移除每个单元格文本开头和结尾的所有空格,并将剩余空格字符的所有子序列减少到一个空格中。

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

uncheck()

将范围中复选框的状态更改为“未选中”。忽略该范围中当前未包含选中值或未选中值的单元格。

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'unchecked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

返回

Range - 此范围,用于串联。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

已废弃的方法