Item

Itemクラスは基礎的なeventHookの登録インタフェースを提供するクラスです。

継承

インスタンスメソッド

onMounted

インスタンスが初期化されたタイミングで関数を実行するeventHookを登録します。

構文

onMounted(callback);
onMounted(callback, group);

引数

callback

インスタンスが初期化されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const customerNameItem = screen.getSheetItemByLabel("顧客名");

  // インスタンスが初期化されたタイミングで関数を実行
  const unregister = customerNameItem.onMounted(function () {
    console.log("mounted");
    unregister(); // 解除
  });
});

onUpdated

インスタンスが更新されたタイミングで関数を実行するeventHookを登録します。

構文

onUpdated(callback);
onUpdated(callback, group);

引数

callback

インスタンスが更新されたタイミングで実行する関数です。

group

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const customerNameItem = screen.getSheetItemByLabel("顧客名");

  // インスタンスが更新されたタイミングで関数を実行
  const unregister = customerNameItem.onUpdated(function () {
    console.log("updated");
    unregister(); // 解除
  });
});

onDestroyed

インスタンスが破棄されたタイミングで関数を実行するeventHookを登録します。

構文

onDestroyed(callback);
onDestroyed(callback, group);

引数

callback

インスタンスが破棄されたタイミングで実行する関数です。

group

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const customerNameItem = screen.getSheetItemByLabel("顧客名");

  // インスタンスが更新されたタイミングで関数を実行
  const unregister = customerNameItem.onDestroyed(function () {
    console.log("destroyed");
    unregister(); // 解除
  });
});