esmDevelopers
JSプラグイン
esm API
JSプラグイン
esm API
  • Screen

Screen

Screenクラスは画面の遷移に関連するeventHookの登録インタフェースを提供します。

継承

Listenable

インスタンスメソッド

onEntered

対象画面に遷移したタイミングで関数を実行するeventHookを登録します。

構文

onEntered(callback);
onEntered(callback, group);
引数

callback

対象画面に遷移したタイミングで実行する関数です。

group

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

返値

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

例

const unregister = esmJSPlugin.screen
  .sheetSave("customer")
  .onEntered(function (screen) {
    console.log("entered");
    unregister(); // 解除
  });

onLeft

対象画面から離れたタイミングで関数を実行するeventHookを登録します。

構文

onLeft(callback);
onLeft(callback, group);
引数

callback

対象画面から離れたタイミングで実行する関数です。

group

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

返値

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

例

const unregister = esmJSPlugin.screen
  .sheetSave("customer")
  .onLeft(function (screen) {
    console.log("left");
    unregister(); // 解除
  });

関連情報

  • screen
  • Listenable
  • eventHook