Class RangeList

范围列表

同一工作表中的一个或多个 Range 实例的集合。您可以使用此类对非相邻范围或单元格的集合应用操作。

方法

方法返回类型简介
activate()RangeList选择 Range 实例列表。
breakApart()RangeList将范围列表中包含的所有水平或垂直合并的单元格再次拆分为单个单元格。
check()RangeList将范围内的复选框的状态更改为“已选中”。
clear()RangeList清除范围列表中每个 Range 的内容范围、格式和数据验证规则。
clear(options)RangeList清除内容范围、格式、数据验证规则和注释（如使用给定选项指定）。
clearContent()RangeList清除范围列表中每个 Range 的内容，但保留格式设置。
clearDataValidations()RangeList清除范围列表中每个 Range 的数据验证规则。
clearFormat()RangeList清除范围列表中每个 Range 的文本格式。
clearNote()RangeList清除范围列表中每个 Range 的备注。
getRanges()Range[]返回同一工作表中一个或多个 Range 实例的列表。
insertCheckboxes()RangeList将复选框插入到范围中的每个单元格中，并将其配置为勾选时为 true，未勾选时为 false。
insertCheckboxes(checkedValue)RangeList在范围内的每个单元格中插入复选框，并为勾选状态配置自定义值，为未勾选状态配置空字符串。
insertCheckboxes(checkedValue, uncheckedValue)RangeList在范围内的每个单元格中插入复选框，并为勾选和未勾选状态配置自定义值。
removeCheckboxes()RangeList从范围中移除所有复选框。
setBackground(color)RangeList设置范围列表中每个 Range 的背景颜色。
setBackgroundRGB(red, green, blue)RangeList将背景设置为给定的 RGB 颜色。
setBorder(top, left, bottom, right, vertical, horizontal)RangeList为范围列表中的每个 Range 设置边框属性。
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeList为范围列表中的每个 Range 设置边框属性（颜色和/或样式）。
setFontColor(color)RangeList设置范围列表中每个 Range 的字体颜色。
setFontFamily(fontFamily)RangeList为范围列表中的每个 Range 设置字体系列。
setFontLine(fontLine)RangeList为范围列表中的每个 Range 设置字体线条样式。
setFontSize(size)RangeList设置范围列表中每个 Range 的字体大小（以点为单位）。
setFontStyle(fontStyle)RangeList为范围列表中的每个 Range 设置字体样式。
setFontWeight(fontWeight)RangeList为范围列表中的每个 Range 设置字体粗细。
setFormula(formula)RangeList更新范围列表中每个 Range 的公式。
setFormulaR1C1(formula)RangeList更新范围列表中每个 Range 的公式。
setHorizontalAlignment(alignment)RangeList为范围列表中的每个 Range 设置水平对齐方式。
setNote(note)RangeList为范围列表中的每个 Range 设置备注文本。
setNumberFormat(numberFormat)RangeList为范围列表中的每个 Range 设置数字或日期格式。
setShowHyperlink(showHyperlink)RangeList设置范围列表中的每个 Range 是否应显示超链接。
setTextDirection(direction)RangeList设置范围列表中每个 Range 中的单元格的文本方向。
setTextRotation(degrees)RangeList为范围列表中每个 Range 中的单元格设置文本旋转设置。
setValue(value)RangeList为范围列表中的每个 Range 设置值。
setVerticalAlignment(alignment)RangeList为范围列表中的每个 Range 设置垂直对齐方式。
setVerticalText(isVertical)RangeList设置是否堆叠范围列表中每个 Range 的单元格的文本。
setWrap(isWrapEnabled)RangeList为范围列表中的每个 Range 设置文本换行。
setWrapStrategy(strategy)RangeList为范围列表中的每个 Range 设置文本换行策略。
trimWhitespace()RangeList剪除此范围列表中每个单元格中的空白（例如空格、制表符或换行符）。
uncheck()RangeList将范围内的复选框的状态更改为“未选中”。

详细文档

activate()

选择 Range 实例列表。列表中的最后一个范围设为 active range。

注意：这提供了一种多选多个范围的方法。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.activate();

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

返回

RangeList - 活跃范围的列表，用于串联。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

breakApart()

将范围列表中包含的所有水平或垂直合并的单元格再次拆分为单独的单元格。

对范围列表调用此函数相当于选择一组范围，然后选择 Google 表格中的 Format > Merge > Unmerge 菜单项。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • 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 ranges D4 and E6 to 'checked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

clear()

清除范围列表中每个 Range 的内容范围、格式和数据验证规则。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

clear(options)

清除内容范围、格式、数据验证规则和注释，如使用给定选项指定的那样。默认情况下，系统会清除所有数据。 

// The code below clears the contents of the following ranges A:A and C:C in the
// active sheet, but preserves the format, data validation rules, and comments.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

参数

名称类型说明
optionsObject用于指定高级参数的 JavaScript 对象，如下所列。

高级参数

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

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

clearContent()

清除范围列表中每个 Range 的内容，但保留格式设置。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

clearDataValidations()

清除范围列表中每个 Range 的数据验证规则。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

clearFormat()

清除范围列表中每个 Range 的文本格式。

这会清除每个范围的文本格式，但不会重置任何数字格式规则。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

clearNote()

清除范围列表中每个 Range 的备注。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getRanges()

返回同一工作表中一个或多个 Range 实例的列表。

返回

Range[] - 范围列表。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

insertCheckboxes()

将复选框插入到范围中的每个单元格中，并将其配置为 true（已选中）和 false（未选中）。将范围内所有单元格的值设置为 false。 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'true' for checked and 'false' for unchecked. Also, sets the value of each
// cell in the ranges D4 and E6 to 'false'.
rangeList.insertCheckboxes();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

insertCheckboxes(checkedValue)

在范围内的每个单元格中插入复选框，并为勾选状态配置自定义值，为未勾选状态配置空字符串。将范围中每个单元的值设置为空字符串。 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and the empty string for unchecked. Also, sets the value of
// each cell in the ranges D4 and E6 to the empty string.
rangeList.insertCheckboxes('yes');

参数

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

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

insertCheckboxes(checkedValue, uncheckedValue)

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

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and 'no' for unchecked. Also, sets the value of each cell
// in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

参数

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

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

removeCheckboxes()

从范围中移除所有复选框。清除每个单元格的数据验证，如果单元格包含已选中或未选中值，还会清除其值。 

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

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

const rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their
// value.
rangeList1.removeCheckboxes();

const rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear
// their value.
rangeList2.removeCheckboxes();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBackground(color)

设置范围列表中每个 Range 的背景颜色。颜色采用 CSS 表示法表示；例如，'#ffffff' 或 'white'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

参数

名称类型说明
colorStringCSS 表示法中的背景颜色代码，例如 '#ffffff' 或 'white'；null 值会重置颜色。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBackgroundRGB(red, green, blue)

将背景设置为给定的 RGB 颜色。这是 setBackground(color) 调用的便捷封装容器。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

参数

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

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

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

为范围列表中的每个 Range 设置边框属性。有效值为 true（开启）、false（关闭）和 null（不更改）。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves
// the left and right unchanged.
rangeList.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 表示无变化。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

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

为范围列表中的每个 Range 设置边框属性（颜色和/或样式）。 有效值为 true（开启）、false（关闭）和 null（不更改）。颜色以 CSS 表示法表示；例如 '#ffffff' 或 'white'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged
// of the ranges A2:B4 and C1:D4. Also sets the color to 'red', and the border
// to 'DASHED'.
rangeList.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 表示无变化。
colorStringCSS 表示法中的边框颜色，例如 '#ffffff' 或 'white'，null 表示默认颜色（黑色）。
styleBorderStyle边框的样式，null 表示默认样式（实线）。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontColor(color)

设置范围列表中每个 Range 的字体颜色。颜色采用 CSS 表示法；例如 '#ffffff' 或 'white'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

参数

名称类型说明
colorStringCSS 表示法（例如 '#ffffff' 或 'white'）中的字体颜色；null 值会重置颜色。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontFamily(fontFamily)

为范围列表中的每个 Range 设置字体系列。字体系列由字符串标识符（例如 Arial 或 Roboto）描述。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

参数

名称类型说明
fontFamilyString要设置的字体系列；null 值会重置字体系列。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontLine(fontLine)

为范围列表中的每个 Range 设置字体线条样式。线条样式选项为 'underline'、'line-through' 或 'none'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

参数

名称类型说明
fontLineString字体线条样式，可选值为 'underline'、'line-through' 或 'none'；null 值会重置字体线条样式。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontSize(size)

设置范围列表中每个 Range 的字体大小（以点为单位）。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

参数

名称类型说明
sizeInteger字体磅数。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontStyle(fontStyle)

为范围列表中的每个 Range 设置字体样式。字体样式选项为 'italic' 或 'normal'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle('italic');

参数

名称类型说明
fontStyleString字体样式，即 'italic' 或 'normal'；null 值会重置字体样式。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontWeight(fontWeight)

为范围列表中的每个 Range 设置字体粗细。字体粗细选项为 'normal' 或 'bold'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

参数

名称类型说明
fontWeightString字体粗细，值为 'bold' 或 'normal'；null 值会重置字体粗细。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFormula(formula)

更新范围列表中每个 Range 的公式。给定公式必须采用 A1 表示法。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

参数

名称类型说明
formulaString表示要设置的公式的字符串。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFormulaR1C1(formula)

更新范围列表中每个 Range 的公式。给定公式必须采用 R1C1 表示法。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

参数

名称类型说明
formulaString字符串公式。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setHorizontalAlignment(alignment)

为范围列表中的每个 Range 设置水平对齐方式。对齐选项为 'left'、'center' 或 'right'。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment('center');

参数

名称类型说明
alignmentString对齐方式，可以是 'left'、'center' 或 'normal'；null 值会重置对齐方式。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setNote(note)

为范围列表中的每个 Range 设置备注文本。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

参数

名称类型说明
noteString要设置的备注文本；如果值为 null，则移除备注。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setNumberFormat(numberFormat)

为范围列表中的每个 Range 设置数字或日期格式。

Google 表格 API 日期和数字格式指南中介绍了接受的格式模式。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

参数

名称类型说明
numberFormatString数字格式字符串。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

设置范围列表中的每个 Range 是否应显示超链接。 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

参数

名称类型说明
showHyperlinkBoolean是否显示超链接。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setTextDirection(direction)

设置范围列表中每个 Range 中的单元格的文本方向。如果指定的方向为 null，系统会推断方向，然后进行设置。 

// Sets right-to-left text direction each range in the range list.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

参数

名称类型说明
directionTextDirection所需的文本方向；如果为 null，系统会在设置前推断方向。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setTextRotation(degrees)

为范围列表中每个 Range 中的单元格设置文本旋转设置。输入值对应于标准文本方向与所需方向之间的角度。输入零表示文本设置为标准方向。

对于从左到右的文本方向，正角度为逆时针方向，而对于从右到左的文本方向，正角度为顺时针方向。 

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45
// degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

参数

名称类型说明
degreesInteger标准屏幕方向与所需屏幕方向之间的所需角度。 对于从左到右的文本，正角度为逆时针方向。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setValue(value)

为范围列表中的每个 Range 设置值。值可以是数字、字符串、布尔值或日期。如果以“=”开头，则会被解读为公式。 

const sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

参数

名称类型说明
valueObject范围的值。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setVerticalAlignment(alignment)

为范围列表中的每个 Range 设置垂直对齐方式。对齐选项为 'top'、'middle' 或 'bottom'。 

// Sets the vertical alignment to middle for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment('middle');

参数

名称类型说明
alignmentString对齐方式，可为 'top'、'middle' 或 'bottom'；null 值会重置对齐方式。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setVerticalText(isVertical)

设置是否堆叠范围列表中每个 Range 的单元格的文本。如果文本是垂直堆叠的，系统会忽略文本旋转角度设置。 

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

参数

名称类型说明
isVerticalBoolean是否堆叠文本。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setWrap(isWrapEnabled)

为范围列表中的每个 Range 设置文本换行。启用了自动换行的单元格会调整大小，以显示其完整内容。停用换行功能的单元格会尽可能在单元格中显示，而不会调整大小或换行。 

// Enable text wrap for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

参数

名称类型说明
isWrapEnabledBoolean是否换行文本。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setWrapStrategy(strategy)

为范围列表中的每个 Range 设置文本换行策略。 

// Sets the list of ranges to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

参数

名称类型说明
strategyWrapStrategy所需的换行策略。

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

trimWhitespace()

剪除此范围列表中每个单元格中的空白（例如空格、制表符或换行符）。 移除每个单元格文本开头和结尾的所有空格，并将剩余空格字符的任何子序列缩减为一个空格。 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

const rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

  • 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 ranges D4 and E6 to 'unchecked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

返回

RangeList - 此范围列表，用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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