Targets

Targetsクラスは複数の Target インスタンスを内包するクラスです。

継承

• Target
• Listenable

インスタンスプロパティ

entities

内包する Target インスタンスの配列です。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onMounted(function () {
    // 各要素のラベルを出力
    sheetItems.entities.forEach(function (sheetItem) {
      F;
      console.log(sheetItem.label);
    });
  });
});

length読み取り専用

entities の要素数です。

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onMounted(function () {
    // 個数を出力
    console.log(sheetItem.length);
  });
});

インスタンスメソッド

onMounted

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

構文

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

引数

callback

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

group

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

返値

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

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

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

onUpdated

entities の構成要素が変更されたタイミングで関数を実行するeventHookを登録します。

構文

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

引数

callback

entities の構成要素が変更されたタイミングで実行する関数です。

group

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

返値

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

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

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

lengthEqualsTo

lengthが引数で指定した数値と等しいかどうかを判定します。

構文

lengthEqualsTo(number);

引数

number

比較対象となる数値です。

返値

真偽値

length と numberが等しい場合に true、そうでない場合に false を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onUpdated(function () {
    if (sheetItems.lengthEqualsTo(5)) {
      console.log("項目数は5です。");
    } else {
      console.log("項目数は5ではありません。");
    }
  });
});

lengthIsGreaterThan

lengthが引数で指定した数値より大きいかどうかを判定します。

構文

lengthIsGreaterThan(number);

引数

number

比較対象となる数値です。

返値

真偽値

lengthが number より大きい場合に true、そうでない場合に false を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onUpdated(function () {
    if (sheetItems.lengthIsGreaterThan(5)) {
      console.log("項目数は5より大きいです。");
    } else {
      console.log("項目数は5以下です。");
    }
  });
});

lengthIsGreaterThanOrEqual

lengthが引数で指定した数値以上かどうかを判定します。

構文

lengthIsGreaterThanOrEqual(number);

引数

number

比較対象となる数値です。

返値

真偽値

lengthが number 以上の場合に true、そうでない場合に false を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onUpdated(function () {
    if (sheetItems.lengthIsGreaterThanOrEqual(5)) {
      console.log("項目数は5以上です。");
    } else {
      console.log("項目数は5未満です。");
    }
  });
});

lengthIsLessThan

lengthが引数で指定した数値未満かどうかを判定します。

構文

lengthIsLessThan(number);

引数

number

比較対象となる数値です。

返値

真偽値

lengthが number より未満の場合に true、そうでない場合に false を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onUpdated(function () {
    if (sheetItems.lengthIsLessThan(5)) {
      console.log("項目数は5未満です。");
    } else {
      console.log("項目数は5以上です。");
    }
  });
});

lengthIsLessThanOrEqual

lengthが引数で指定した数値以下かどうかを判定します。

構文

lengthIsLessThanOrEqual(number);

引数

number

比較対象となる数値です。

返値

真偽値

lengthが number 以下の場合に true、そうでない場合に false を返します。

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const sheetItems = screen.getSheetItems();

  // entitiesが初期化されたタイミングで関数を実行
  sheetItems.onUpdated(function () {
    if (sheetItems.lengthIsLessThanOrEqual(5)) {
      console.log("項目数は5以下です。");
    } else {
      console.log("項目数は5より大きいです。");
    }
  });
});

関連情報

• Target
• Listenable
• eventHook