同じシート内の 1 つ以上の Range
インスタンスのコレクション。このクラスを使用すると、隣接しない範囲やセルのコレクションにオペレーションを適用できます。
Methods
詳細なドキュメント
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()
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
の背景色を設定します。色は 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
- この範囲リスト(チェーン用)。
承認
この方法を使用するスクリプトには、次の 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 | フォントの色('#ffffff' や 'white' などの CSS 表記)。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
のセルのテキスト回転設定を設定します。入力は、標準のテキストの向きと目的の向きとの間の角度に対応します。ゼロを入力すると、テキストは標準の向きに設定されます。
テキスト方向の左から右の場合、正の角は反時計回り、右から左は時計回りです。
// 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 つのスペースに減らします。
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
関連ドキュメント
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