ReceiverItem

ReceiverItem クラスは受取人に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

length

追加されている全ての受取人の数を示す数値です。

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.length); // 4
});

entityIds

追加されている全ての受取人の ID を示す数値の配列です。

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.entityIds); // [1,2,3,4]
});

entityNames

追加されている全ての受取人の名前を示す文字列の配列です。

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.entityNames); // ["佐藤", "佐々木"]
});

インスタンスメソッド

entityNamesInclude

受取人に指定した名前が含まれているかどうかを判定します。

構文

entityNamesInclude(name);

引数

name

受取人の名前を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.entityNames); // ["佐藤", "佐々木"]

  console.log(receiverItem.entityNamesInclude("佐藤")); // true
});

entitiesInclude

受取人に指定した id が含まれているかどうかを判定します。

構文

entitiesInclude(id);

引数

id

受取人の id を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.entitiesInclude); // [1,2,3]

  console.log(receiverItem.entitiesInclude(1)); // true
});

onReceiverAdded

受取人が追加された後に呼び出されるeventHookを登録します。

構文

onReceiverAdded(callback);
onReceiverAdded(callback, group);

引数

callback

受取人が追加されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("businesscard").onEntered(function (screen) {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  const unlisten = ReceiverItem.onReceiverAdded(function () {
    console.log("ReceiverAdded");
    unlisten(); // 解除
  });
});

onReceiverRemoved

受取人が削除された後に呼び出されるeventHookを登録します。

構文

onReceiverRemoved(callback);
onReceiverRemoved(callback, group);

引数

callback

受取人が削除されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("businesscard").onEntered(function (screen) {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  const unlisten = ReceiverItem.onReceiverRemoved(function () {
    console.log("ReceiverRemoved");
    unlisten(); // 解除
  });
});

onReceiversUpdated

受取人が更新された後に呼び出されるeventHookを登録します。

構文

onReceiversUpdated(callback);
onReceiversUpdated(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("businesscard").onEntered(function (screen) {
  const receiverItem = screen.getSheetItemByLabel("受取人");

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

getReceivers

Receiversクラスのインスタンスを返します。

構文

getReceivers();

引数

なし

返値

Receiversクラスのインスタンス

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  const receivers = receiverItem.getReceivers();

  console.log(receivers);
});

getReceiverBy

指定した ID のReceiverクラスのインスタンスを返します。

構文

getReceiverBy(ID);

引数

ID

受取人の ID を示す数値です。

返値

Receiverクラスのインスタンス

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  const receiver = receiverItem.getReceiverBy(1);

  console.log(receiver.entityId);
  // 1
});

getReceiverByIndex

指定した行のReceiverクラスのインスタンスを返します。

構文

getReceiverByIndex(index);

引数

index

受取人が何行目かを示す数値です。

返値

Receiverクラスのインスタンス

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  const receiver = receiverItem.getReceiverByIndex(1);

  console.log(receiver.entityId);
  // 1
});

setReceiverAdded

entityId を指定して、受取人を追加します。

構文

setReceiverAdded(entityId);

引数

entityId

受取人の entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.length);
  // 3

  ReceiverItem.setReceiverAdded(1);

  console.log(receiverItem.length);
  // 4
});

setReceiverRemoved

指定した entityId の受取人を削除します。

構文

setReceiverRemoved(entityId);

引数

entityId

受取人の entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.length);
  // 3

  ReceiverItem.setReceiverRemoved(1);

  console.log(receiverItem.length);
  // 2
});

setReceiverRemovedByIndex

指定した index の受取人を削除します。

構文

setReceiverRemovedByIndex(index);

引数

index

何行目かの受取人を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((screen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  console.log(receiverItem.length);
  // 3

  ReceiverItem.setReceiverRemoved(1);

  console.log(receiverItem.length);
  // 2
});

lengthEqualsTo

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

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((SheetSaveScreen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  receiverItem.onUpdated(function () {
    // 値を確認
    console.log("値:", receiverItem.length); // 値: 7

    const result = receiverItem.lengthEqualsTo(7);

    console.log("受取人数が7であるか:", result); // 受取人数が7であるか: true
  });
});

lengthIsGreaterThan

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

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((SheetSaveScreen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  receiverItem.onUpdated(function () {
    // 値を確認
    console.log("値:", receiverItem.length); // 値: 7

    const result = receiverItem.lengthIsGreaterThan(6);

    console.log("受取人数が6より大きいか:", result); // 受取人数が6より大きいか: true
  });
});

lengthIsGreaterThanOrEqual

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

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((SheetSaveScreen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  receiverItem.onUpdated(function () {
    // 値を確認
    console.log("値:", receiverItem.length); // 値: 7

    const result = receiverItem.lengthIsGreaterThanOrEqual(6);

    console.log("受取人数が6以上か:", result); // 受取人数が6以上か: true
  });
});

lengthIsLessThan

lengthが指定した数値より小さいかどうかを判定します。

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((SheetSaveScreen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  receiverItem.onUpdated(function () {
    // 値を確認
    console.log("値:", receiverItem.length); // 値: 7

    const result = receiverItem.lengthIsLessThan(10);

    console.log("受取人数が10未満か:", result); // 受取人数が10未満か: true
  });
});

lengthIsLessThanOrEqual

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

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("businesscard").onEntered((SheetSaveScreen) => {
  const receiverItem = screen.getSheetItemByLabel("受取人");

  receiverItem.onUpdated(function () {
    // 値を確認
    console.log("値:", receiverItem.length); // 値: 7

    const result = receiverItem.lengthIsLessThanOrEqual(8);

    console.log("受取人数が8以下か:", result); // 受取人数が8以下か: true
  });
});

関連情報

• SheetItem
• Receivers
• Receiver