GAS スプレッドシートのシートが非表示であるかを判定する

GAS スプレッドシートのシートが非表示であるかを判定する

GAS(Google Apps Script)で、スプレッドシートのシートが非表示であるかを判定する手順を記述してます。「isSheetHidden」で可能です。ここでは全シートから非表示のものだけ取得する方法も記述してます。

環境

  • OS windows11 home
  • ブラウザ chrome 100.0.4896.127

シートが非表示であるかを判定

シートが非表示であるかを判定するには、「isSheetHidden()」を使用します。

sheet.isSheetHidden()
// 非表示:true, 非表示ではない:false

以下の「シート」の「シート1」を非表示にして判定してみます。

コードを実行します。

function myFunction() {

  // GASを作成したスプレッドシート
  let spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

  // スプレッドシートの最初のワークシートを取得
  let sheet = spreadsheet.getSheets()[0];

 // 非表示であればtrue
  if (sheet.isSheetHidden()) {
    // シート名を取得して表示
    Logger.log(sheet.getName());
  }

}

判定されていることが確認できます。

全てのシートを確認

全てのシートを確認したい場合は「getSheets」で全シートを取得してから「for-of」などでループ処理して判定します。

function myFunction() {

  // GASを作成したスプレッドシート
  let spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

  // 全てのシートを取得
  let sheets = spreadsheet.getSheets();

  // 全てのシートを確認
  for (const item of sheets) {
    if (item.isSheetHidden()) {
      // 表示のシート名を表示
      Logger.log(item.getName());
    }
  }
}