Class RangeList

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 的儲存格文字 請參考閱讀清單，進一步瞭解 如何選擇 Kubeflow Pipelines SDK 或 TFX
setWrap(isWrapEnabled)	RangeList	為範圍清單中的每個 Range 設定文字換行。
setWrapStrategy(strategy)	RangeList	為範圍清單中的每個 Range 設定文字包裝策略。
trimWhitespace()	RangeList	移除這份範圍清單中每個儲存格中的空白字元 (例如空格、Tab 鍵或換行字元)。
uncheck()	RangeList	將範圍內核取方塊的狀態變更為「未勾選」。

內容詳盡的說明文件

activate()

選取 Range 執行個體清單。清單的最後一個範圍設為 active range。

注意：這項功能可讓您選取多個範圍。

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

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

回攻員

RangeList：用於鏈結的有效範圍清單。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

breakApart()

將範圍清單內含的所有水平或垂直合併儲存格，拆分成 個別儲存格

在範圍清單呼叫此函式相當於選取一組範圍和 選取 [格式]合併 >取消合併試算表選單項目。

var sheet = SpreadsheetApp.getActiveSheet();
var 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'.
var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

clear()

清除以下項目中各 Range 的內容、格式和資料驗證規則範圍： 範圍清單

var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

參數

名稱	類型	說明
options	Object	指定進階參數的 JavaScript 物件，如下所示。

進階參數

名稱	類型	說明
commentsOnly	Boolean	是否僅清除留言。
contentsOnly	Boolean	是否僅清除內容。
formatOnly	Boolean	是否僅清除格式；請注意 格式也會清除資料驗證規則。
validationsOnly	Boolean	是否僅清除資料驗證規則。
skipFilteredRows	Boolean	是否清除篩除的資料列。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

clearContent()

清除範圍清單中每個 Range 的內容，格式維持不變。

var sheet = SpreadsheetApp.getActiveSheet();
var 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 的資料驗證規則。

var sheet = SpreadsheetApp.getActiveSheet();
var 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 的文字格式。

這會清除每個範圍的文字格式，但不會重設任何數字格式規則。

var sheet = SpreadsheetApp.getActiveSheet();
var 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 的附註。

var sheet = SpreadsheetApp.getActiveSheet();
var 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。

var 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)

在範圍中的每個儲存格中插入核取方塊，並為勾選和 未勾選的空字串。將範圍內每個儲存格的值設為空字串。

var 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');

參數

名稱	類型	說明
checkedValue	Object	核取方塊資料驗證勾選的值。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

insertCheckboxes(checkedValue, uncheckedValue)

在範圍中的每個儲存格中插入核取方塊，並為勾選的項目設定自訂值 以及未勾選狀態將範圍中每個儲存格的值設為自訂未勾選值。

var 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');

參數

名稱	類型	說明
checkedValue	Object	核取方塊資料驗證勾選的值。
uncheckedValue	Object	核取方塊資料驗證的未勾選值。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

• 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 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();

var 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'

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

參數

名稱	類型	說明
color	String	CSS 標記法的背景顏色代碼，例如 '#ffffff' 或 'white'。null 值會重設顏色。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setBackgroundRGB(red, green, blue)

將背景設為指定的 RGB 顏色。這是 setBackground(color) 呼叫周圍的便利包裝函式。

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

參數

名稱	類型	說明
red	Integer	以 RGB 標記法表示的紅色值。
green	Integer	以 RGB 標記法表示的綠色值。
blue	Integer	採用 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 (無變更)。

var sheet = SpreadsheetApp.getActiveSheet();
var 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);

參數

名稱	類型	說明
top	Boolean	true 代錶框線，false 代表無，null 表示不變。
left	Boolean	true 代錶框線，false 代表無，null 表示不變。
bottom	Boolean	true 代錶框線，false 代表無，null 表示不變。
right	Boolean	true 代錶框線，false 代表無，null 表示不變。
vertical	Boolean	true 代表內部垂直框線，false 代表無，null 表示不變。
horizontal	Boolean	true 代表內部水平框線，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'

var sheet = SpreadsheetApp.getActiveSheet();
var 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);

參數

名稱	類型	說明
top	Boolean	true 代錶框線，false 代表無，null 表示不變。
left	Boolean	true 代錶框線，false 代表無，null 表示不變。
bottom	Boolean	true 代錶框線，false 代表無，null 表示不變。
right	Boolean	true 代錶框線，false 代表無，null 表示不變。
vertical	Boolean	true 代表內部垂直框線，false 代表無，null 表示不變。
horizontal	Boolean	true 代表內部水平框線，false 代表無，null 表示不變。
color	String	CSS 標記法的邊框顏色，例如 '#ffffff' 或 'white'，預設顏色為 null。
style	BorderStyle	框線的樣式，null 代表預設樣式 (實線)。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFontColor(color)

設定範圍清單中每個 Range 的字型顏色。顏色在 CSS 中表示 標記法；例如 '#ffffff' 或 'white'

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

參數

名稱	類型	說明
color	String	CSS 標記法中的字型顏色，例如 '#ffffff' 或 'white'。換 null 值會重設顏色。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFontFamily(fontFamily)

設定範圍清單中每個 Range 的字型系列。字型系列 字串識別碼，例如 Arial 或 Roboto。

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

參數

名稱	類型	說明
fontFamily	String	要設定的字型系列；null 值會重設字型系列。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFontLine(fontLine)

設定範圍清單中每個 Range 的字型行樣式。線條樣式選項 為 'underline'、'line-through' 或 'none'。

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

參數

名稱	類型	說明
fontLine	String	字型行樣式，可以是 'underline'、'line-through' 或 'none'；null 值會重設字型行樣式。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFontSize(size)

設定範圍清單中每個 Range 的字型大小 (以點為單位)。

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

參數

名稱	類型	說明
size	Integer	字型大小。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFontStyle(fontStyle)

設定範圍清單中每個 Range 的字型樣式。字型樣式選項包括 'italic' 或 'normal'。

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

參數

名稱	類型	說明
fontStyle	String	字型樣式：'italic' 或 'normal'；1 個null 值會重設字型樣式。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFontWeight(fontWeight)

設定範圍清單中每個 Range 的字型粗細。字型粗細選項有 'normal' 或 'bold'。

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

參數

名稱	類型	說明
fontWeight	String	字型粗細，為 'bold' 或 'normal'；1 個null 值會重設字型粗細。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFormula(formula)

更新範圍清單中每個 Range 的公式。指定的公式必須採用 A1 標記法。

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

參數

名稱	類型	說明
formula	String	字串，代表要設定的公式。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setFormulaR1C1(formula)

更新範圍清單中每個 Range 的公式。指定的公式必須採用 R1C1 標記法。

var sheet = SpreadsheetApp.getActiveSheet();
var 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])');

參數

名稱	類型	說明
formula	String	字串公式。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setHorizontalAlignment(alignment)

設定範圍清單中每個 Range 的水平對齊方式。對齊選項 為 'left'、'center' 或 'right'。

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

參數

名稱	類型	說明
alignment	String	對齊，可為 'left'、'center' 或 'normal'；換 null 值會重設對齊。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setNote(note)

設定範圍清單中每個 Range 的記事文字。

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

參數

名稱	類型	說明
note	String	要設定的記事文字；null 值會移除記事。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setNumberFormat(numberFormat)

設定範圍清單中每個 Range 的數字或日期格式。

如要瞭解系統接受的格式設定模式，請參閱 Sheets API 日期和數字格式指南。

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

參數

名稱	類型	說明
numberFormat	String	數字格式字串，

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setShowHyperlink(showHyperlink)

設定範圍清單中的每個 Range 是否應顯示超連結。

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

參數

名稱	類型	說明
showHyperlink	Boolean	是否顯示超連結。

回攻員

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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

參數

名稱	類型	說明
direction	TextDirection	所需的文字方向：如果 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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

參數

名稱	類型	說明
degrees	Integer	標準方向與所需螢幕方向之間的所需角度。 在從左到右的文字中，正角度會按逆時針方向呈現。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setValue(value)

設定範圍清單中每個 Range 的值。這個值可以是數字、字串 布林值或日期。如果開頭為「=」就會解為公式

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

參數

名稱	類型	說明
value	Object	範圍的值。

回攻員

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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment("middle");

參數

名稱	類型	說明
alignment	String	對齊，可為 'top'、'middle' 或 'bottom'；換 null 值會重設對齊。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

setVerticalText(isVertical)

設定是否堆疊範圍中每個 Range 的儲存格文字 請參考閱讀清單，進一步瞭解 如何選擇 Kubeflow Pipelines SDK 或 TFX如果是垂直堆疊的文字，則會忽略文字旋轉角度設定。

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

參數

名稱	類型	說明
isVertical	Boolean	是否堆疊文字。

回攻員

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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

參數

名稱	類型	說明
isWrapEnabled	Boolean	是否自動換行。

回攻員

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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

參數

名稱	類型	說明
strategy	WrapStrategy	想要的包裝策略。

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

---

trimWhitespace()

移除這份範圍清單中每個儲存格中的空白字元 (例如空格、Tab 鍵或換行字元)。 移除每個儲存格文字開頭和結尾的所有空白字元，並減少所有子序列 將剩餘的空白字元轉換為單一空格

注意：如果產生的剪輯文字開頭為「+」或「=」 字元，文字仍會為字串值，且不會解讀為公式。

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)']);

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

var 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

另請參閱

• Range.trimWhitespace()

---

uncheck()

將範圍內核取方塊的狀態變更為「未勾選」。忽略範圍中的儲存格 但目前不包含已設定的勾選或未勾選值。

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the ranges D4 and E6 to 'unchecked'.
var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

回攻員

RangeList：這份範圍清單，用於鏈結。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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