【GAS】スプレッドシートでコンテンツをクリアする

GASでスプレッドシートのコンテンツをクリアするには「clear()」を利用する。

clear()
コンテンツとフォーマット情報のシートをクリアします。
https://developers.google.com/apps-script/reference/spreadsheet/sheet?hl=en#clear

clear()の戻り値

Sheet—クリアされたシート。

スプレッドシートでコンテンツをクリアするGAS

function myFunction() {
  //アクティブなスプレッドシートを返す
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  //アクティブなスプレッドシートを取得
  var sht = ss.getActiveSheet();
 　//シート1のシートをアクティブに
  var actsht = ss.getSheetByName("シート1").activate();
  //A1:C10にBlueのテキストを入力
  sht.getRange("A1:C10").setValue("Blue");
  //clearメソッドでコンテンツ情報をクリアする
  actsht.clear();
  //コンテンツクリアした証拠をテキストで掲載した
  sht.getRange("A1").setValue("クリアしちゃった")
}

スプレッドシートでコンテンツをクリアするGAS実行の様子

cliear()メソッドを利用して、スプレッドシートのコンテンツを全クリアしてみました。

削除したあと、A1セルに削除した証拠テキストを記載してます。

スプレッドシートで書式コンテンツのみをクリアする場合

スプレッドシートの書式のみをクリアするにはclear(optons)と指定する。

clear(options)
指定された詳細オプションで指定された内容および/またはフォーマットのシートをクリアします。
https://developers.google.com/apps-script/reference/spreadsheet/sheet?hl=en#clearoptions

clear(options)の戻り値

Sheet—このシート、連鎖用。

clear(options)のパラメーター

名前	タイプ	説明
`options`	`Object`	以下にリストされている詳細オプションを含むJavaScriptマップ。

通常のパラメーター

名前	タイプ	説明
`contentsOnly`	`Boolean`	コンテンツをクリアするかどうか。
`formatOnly`	`Boolean`	フォーマットをクリアするかどうか。

高度なパラメーター

スプレッドシートで書式コンテンツのみをクリアするGAS

function clear() {
  //アクティブなスプレッドシートを返す
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  //アクティブなスプレッドシートを取得
  var sht = ss.getActiveSheet();
　//シート2のシートをアクティブに
  ss.getSheetByName("シート2").activate();
  //テキストを設置
  var txt0 = "Blueだよ";
  //A1:C10に設置したテキストを太文字に背景色を黄色に
  sht.getRange("A1:C10").setValue(txt0).setFontWeight("bold").setBackground("yellow");
  //B5に設置したテキストの書式のみをクリアしてみた
  // sht.getRange("B5").clear({ formatOnly: true, contentsOnly: false });
}