Class RangeList

RangeList

同じシート内の 1 つ以上の 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[]	同じシート内の 1 つ以上の 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 として設定されます。

注: これにより、複数の範囲を選択できます。

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 - チェーンするアクティブな範囲のリスト。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

---

getRanges()

同じシート内の 1 つ以上の Range インスタンスを含むリストを返します。

戻る

Range[] - 範囲のリスト。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

---

setBackground(color)

範囲リストの各 Range の背景色を設定します。色は 表示されます。たとえば、'#ffffff' や 'white' です。

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

パラメータ

名前	型	説明
color	String	CSS 表記の背景色コード（'#ffffff' や 'white' など）。null の値は色をリセットします。

戻る

RangeList - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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'）。null フォント スタイルをリセットします。

戻る

RangeList - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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'）。null フォントの太さをリセットします。

戻る

RangeList - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

---

setTextRotation(degrees)

範囲リストの各 Range にあるセルのテキストの回転設定を設定します。「 入力は、標準のテキストの向きと目的の方向との間の角度に 方向です。入力が 0 の場合は、テキストが標準の向きに設定されていることを示します。

テキスト方向が左から右の場合、正の角度は反時計回り、 右から左の場合は時計回りの方向です

// 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

パラメータ

名前	型	説明
isVertical	Boolean	テキストを積み重ねるかどうかを指定します。

戻る

RangeList - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

---

trimWhitespace()

この範囲リストのすべてのセルの空白（スペース、タブ、改行など）を削除します。 各セルのテキストの先頭と末尾にある空白文字をすべて削除し、部分文字列を減らします 1 つのスペースに置き換えることができます。

<ph type="x-smartling-placeholder">

</ph> 注: カットされたテキストが「+」で始まる場合、または「=」 を含む場合、テキストは文字列値として維持され、数式として解釈されません。

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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

• 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 - この範囲リスト（チェーン用）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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