clear 選択範囲を削除する | GoogleAppsScript リファレンス Spreadsheet

スプレッドシートの範囲内削除が可能です。

実行例 clear 選択範囲を削除する

こちらのセル情報から範囲内削除をすることで

以下のように特定の範囲を指定して削除することが可能です。

リファレンス

clear()

削除対象のrangeを指定します。例えば上記の例であればA2:B3です。

rangeに対してclearを実行することで削除できます。

実行サンプル

今回はA2:B3の範囲を使ってB列の残りを拡張するため以下の通り、記述します。

function myFunction() {
  var sheet = SpreadsheetApp.getActiveSheet();
  // 削除範囲を指定します
  var range = sheet.getRange("A2:B3");
  range.clear();
}

実行に成功すると下記の通り、A3:B10までA1:B2の値を参考にして自動的に値が入ります。

オプションを指定して利用する

NameTypeDescription
commentsOnlyBooleanコメントのみをクリアするかどうか。
contentsOnlyBoolean内容のみをクリアするかどうか。
formatOnlyBooleanフォーマットのみをクリアするかどうか。フォーマットをクリアすると、データ検証ルールもクリアされることに注意してください。
validationsOnlyBooleanデータ検証ルールのみをクリアするかどうか。
skipFilteredRowsBooleanフィルターされた行のクリアを回避するかどうか。

例えば書式のみをクリアする場合は以下のように記述します。

上記に対してA2:B3の書式クリアを実行します。書式クリアはformatOnlyを指定します。

function myFunction() {
  var sheet = SpreadsheetApp.getActiveSheet();
  // 削除範囲を指定します
  var range = sheet.getRange("A2:B3");
  range.clear({formatOnly:true});
}

上記の通り、書式クリアを行うことが可能です。また複数指定可能なため{}で囲うことに注意してください。複数指定は以下のように記述します。

function myFunction() {
  var sheet = SpreadsheetApp.getActiveSheet();
  // 削除範囲を指定します
  var range = sheet.getRange("A2:B3");
  range.clear({formatOnly:true, contentsOnly:true});
}

上記の指定により、書式+内容をクリアすることが可能です。

clearContentやclearFormatを利用する

clearのユースケースとしては値のみ消したい、書式のみ消したいの2パターンが多いと思いますが、専用のメソッドが用意されています。いずれもclearにオプション指定する書き方と動きは同一です。

function myFunction() {
  var sheet = SpreadsheetApp.getActiveSheet();
  var range = sheet.getRange("A2:B3");
  // 選択範囲を値のみを消して書式はそのままにします
  range.clearContent();
  // 選択範囲の書式のみを削除します
  range.clearFormat();
}

シンプルに書けますね。

タイトルとURLをコピーしました