カスタムメニューの記述をできるだけ短く記述したい

Question

スプレッドシートのメニューから各シートに飛ぶGASの記述を書いたのですが、できるだけコードを短く書きたいです。

カスタムメニューから各シートに遷移するスクリプトなのですが、いまのままだとシートを追加するごとに更新する必要があり、できるだけ更新箇所を減らそうと思って、いろいろと分けて書いてみました所、煮詰まった状態になります。

コードの書き方が同じことの繰り返しが多くどうみても悪いのですが、どういった関数の記述方法で短くできるのか調べてみてもわからなかったのでお聞きしてみました。

よろしくお願いいたします。

var sheetName1 = "シート1";
var sheetName2 = "シート2";
var sheetName3 = "シート3";

var functionName1 = "myFunction1";
var functionName2 = "myFunction2";
var functionName3 = "myFunction3";

function onOpen() {
  var ui = SpreadsheetApp.getUi();
  var menu = ui.createMenu("カスタムメニュー");
  menu.addItem(sheetName1, functionName1);
  menu.addItem(sheetName2, functionName2);
  menu.addItem(sheetName3, functionName3);
  menu.addToUi();
}

function onClickItem(num) {
  var sheetNum = eval("sheetName" + num);
  var objSpreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  var objSheet = objSpreadsheet.getSheetByName(sheetNum);
  objSpreadsheet.setActiveSheet(objSheet);
}

function myFunction1() {
  var name = arguments.callee.name;
  var num = name.replace(/[^0-9]/g, "");
  onClickItem(num);
}

function myFunction2() {
  var name = arguments.callee.name;
  var num = name.replace(/[^0-9]/g, "");
  onClickItem(num);
}

function myFunction3() {
  var name = arguments.callee.name;
  var num = name.replace(/[^0-9]/g, "");
  onClickItem(num);
}

Comments

[m.ts10806]

作業依頼でしょうか。

[xu0124]

作業依頼ではないです。
コードの書き方が同じことの繰り返しが多くどうみても悪いのですが、どういった関数の記述方法で短くできるのか調べてみてもわからなかったのでお聞きしてみました。

[m.ts10806]

では、もうちょっと質問の仕方かえたほうがいいです。
具体的にというか。
「スマート」って個人感覚の比率が大きい表現なので、
ゴールが見えない。アンケート要素が強いと非推奨にもなりますし。

[m.ts10806]

あと中身一緒なのにコードわける理由が分からないというか。

[xu0124]

説明不足で失礼いたしました。
カスタムメニューから各シートに遷移するスクリプトなのですが、いまのままだとシートを追加するごとに更新する必要があり、できるだけ更新箇所を減らそうと思って、いろいろと分けて書いてみました所、煮詰まった状態になります。

[退会済みユーザー]

んー、
① ファイル内のシート名の一覧を列挙して
② ①のシート名の数だけ、カスタムメニューのアイテムを追加して
③ ②カスタムメニューアイテムをクリックしたら、該当シートをアクティブにする
ということ？
で、これで合っているなら次は①②③をそれぞれ調査すればいい訳だ。頑張って下さい。

[xu0124]

おっしゃるとおりなのはわかっているのですが、メニューのコマンドに変数が入らないので困ってました。

[退会済みユーザー]

最初からそれを質問すれば良かったじゃないですか。。。

[xu0124]

変数に至ったのは自分で考えて導き出した結論で、エンジニアのこなれている方々はもっと良い別の方法があることも想定してしました。カスタムメニューってよく使う事例だと思ってましたので。

Answer 1

一応できましたが無名関数の追加タイミングにクセがあり苦戦しました。
実装に当たりいくつかポイントを書きます。

質問者さんからもらった情報

カスタムメニューからは引数が取れない
まあ、関数名を文字列で取っているし、リファレンスを見たが引数もないのでまともな方法じゃ無理だわな。

検証ポイント1

カスタムメニューで指定する関数名がグローバルスコープから辿れる事
辿れれば良いのでこんな感じの関数であれば…

// 宣言
const hoge = {
  fuga: function() { Browser.msgBox('hello'); };
}

こんな感じにドットで繋いでメニューアイテムを入れれば呼び出せる。

// 呼び出しメニューアイテム
SpreadsheetApp.getActiveSpreadsheet().addMenu('シート名一覧', {[
  name: （シート名）,
  functionName: 'hoge.fuga'
]});

検証ポイント2

グローバルスコープに関数を追加するが、初期化タイミングで追加しておく必要がある
私が検証した範疇ではonOpenより前。
onOpen後は、globalThis等に関数を追加してもメニューからは呼び出せませんでした。
下のようなコードで関数が定義されているかどうかをチェックしてたんですが、
追加処理をした関数内では生きているが、処理を抜けてしまうとglobalThisから消えてしまっていた。

let msg = '';
Object.keys(globalThis).filter(key => typeof(globalThis[key] === 'function').forEach(key => {
  if (msg) {
    msg += '\n';
  }
  msg += 'key: ' + key + ', funcName: ' + globalThis[key]?.name;
});
Browser.msgBox(msg);

書いたコード

const APP_ACTIVE = SpreadsheetApp.getActive();
const SHEETS = APP_ACTIVE.getSheets();
const test = (() => {
  let result = {};
  for (let i = 0; i < SHEETS.length; i++) {
    result['_moveTo' + i] = function() {
      SHEETS[i].activate();
    }
  }
  return result;
})();

function onOpen() {
  let userMenus = [];

  // メニューと動的関数を生成する
  for (let i = 0; i < SHEETS.length; i++) {
    const customFunctionName = 'test._moveTo' + i;

    // カスタムメニューを追加
    userMenus.push({
      name: SHEETS[i].getSheetName(),
      functionName: customFunctionName,
    });
  }
  SpreadsheetApp.getActiveSpreadsheet().addMenu('シート名一覧', userMenus);
}

普段はこんなに至れり尽くせりにコードを出さないんですが
今回のは色々応用が利きそうで自分の勉強にもなってテンションが上がったので掲載します。
（Qiitaにでもまとめて書こうかな…）

以上。

Comments

[xu0124]

ありがとうございます！！！
じつはあれから数時間格闘して、自分でも目次を自動生成して動くものができたのですが、シート名に記号がはいっていると動かなかったので、記号が入っていてもしっかり稼働するこちらのコードがとても素晴らしいので参考にさせていただきます。

[mir]

こういう書き方で変数を使って動的に関数を生成して、メニューに使えるのですね。横から失礼しますが、とても勉強になったのでコメント入れさせていただきました。

>Qiitaにでもまとめて書こうかな…
需要多いと思いますので、是非お願いしたいです。

Answer 2

無名関数を使ってみることにしました。