ResponsibleGroupItem

ResponsibleGroupItem クラスは自社担当グループに対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

length

追加されている全ての自社担当グループの数を示す数値です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

mainChargeId

主担当の id を示す文字列です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  console.log(responsibleGroupItem.mainChargeId); // 1

  responsibleGroupItem.mainChargeId = 2;

  console.log(responsibleGroupItem.mainChargeId); // 2
});

entityIds

追加されている全ての自社担当グループの ID を示す数値の配列です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

entityNames

追加されている全ての自社担当グループの名前を示す文字列の配列です。

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

インスタンスメソッド

entityNamesInclude

自社担当グループに指定した名前が含まれているかどうかを判定します。

構文

entityNamesInclude();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  console.log(responsibleGroupItem.entityNames); // ["佐藤", "鈴木"]

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

entityIdsInclude

自社担当グループに指定した ID が含まれているかどうかを判定します。

構文

entityIdsInclude();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  console.log(responsibleGroupItem.entityIds); // [1,2,3]

  console.log(responsibleGroupItem.entityIdsInclude(1)); // true
});

onResponsibleGroupAdded

自社担当グループが追加された後に呼び出されるeventHookを登録します。

構文

onResponsibleGroupAdded(callback);
onResponsibleGroupAdded(callback, group);

引数

callback

自社担当グループが追加されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  const unlisten = responsibleGroupItem.onResponsibleGroupAdded(function () {
    console.log("ResponsibleGroupAdded");
    unlisten(); // 解除
  });
});

onResponsibleGroupRemoved

自社担当グループが削除された後に呼び出されるeventHookを登録します。

構文

onResponsibleGroupRemoved(callback);
onResponsibleGroupRemoved(callback, group);

引数

callback

自社担当グループが削除されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  const unlisten = responsibleGroupItem.onResponsibleGroupRemoved(function () {
    console.log("ResponsibleGroupRemoved");
    unlisten(); // 解除
  });
});

onResponsibleGroupsUpdated

自社担当グループが更新された後に呼び出されるeventHookを登録します。

構文

onResponsibleGroupsUpdated(callback);
onResponsibleGroupsUpdated(callback, group);

引数

callback

自社担当グループが更新されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

getResponsibleGroups

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

構文

getResponsibleGroups();

引数

なし

返値

ResponsibleGroupsクラスのインスタンス

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");
  const responsibleGroups = responsibleGroupItem.getResponsibleGroups();

  console.log(responsibleGroups);
});

getResponsibleGroupBy

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

構文

getResponsibleGroupBy(ID);

引数

ID

自社担当グループの ID を示す数値です。

返値

ResponsibleGroupクラスのインスタンス

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  const facility = responsibleGroupItem.getResponsibleGroupBy(1);

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

getResponsibleGroupByIndex

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

構文

getResponsibleGroupByIndex(index);

引数

index

自社担当グループが何行目かを示す数値です。

返値

ResponsibleGroupクラスのインスタンス

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

  const facility = responsibleGroupItem.getResponsibleGroupByIndex(0);

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

setResponsibleGroupAdded

entityId を指定して、自社担当グループを追加します。

構文

setResponsibleGroupAdded(entityId);

引数

entityId

自社担当グループの entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

  responsibleGroupItem.setResponsibleGroupAdded(1);

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

setResponsibleGroupRemoved

指定した entityId の自社担当グループを削除します。

構文

setResponsibleGroupRemoved(entityId);

引数

entityId

自社担当グループの entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

  responsibleGroupItem.setResponsibleGroupRemoved(1);

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

setResponsibleGroupRemovedByIndex

指定した index の自社担当グループを削除します。

構文

setResponsibleGroupRemovedByIndex(index);

引数

index

何行目かの自社担当グループを示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

  responsibleGroupItem.setResponsibleGroupRemoved(1);

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

lengthEqualsTo

lengthが指定した数値と同じかどうかを判定します。

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

    const result = responsibleGroupItem.lengthEqualsTo(7);

    console.log("自社担当グループ数が7と同じか:", result); // 自社担当グループ数が7と同じか: true
  });
});

lengthIsGreaterThan

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

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

    const result = responsibleGroupItem.lengthIsGreaterThan(6);

    console.log("自社担当グループ数が6より大きいか:", result); // 自社担当グループ数が6より大きいか: true
  });
});

lengthIsGreaterThanOrEqual

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

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

    const result = responsibleGroupItem.lengthIsGreaterThanOrEqual(6);

    console.log("自社担当グループ数が6以上か:", result); // 自社担当グループ数が6以上か: true
  });
});

lengthIsLessThan

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

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

    const result = responsibleGroupItem.lengthIsLessThan(10);

    console.log("自社担当グループ数が10未満か:", result); // 自社担当グループ数が10未満か: true
  });
});

lengthIsLessThanOrEqual

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

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

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

    const result = responsibleGroupItem.lengthIsLessThanOrEqual(8);

    console.log("自社担当グループ数が8以下か:", result); // 自社担当グループ数が8以下か: true
  });
});

hasNoMainCharge

主担当を設定しないかどうかを判定します。

構文

hasNoMainCharge();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");

  console.log(responsibleGroupItem.hasNoMainCharge()); // true
});

setMainChargeById

指定した id を主担当に設定します。

構文

setMainChargeById(id);

引数

id

id を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");
  responsibleGroupItem.setMainChargeById(1);
});

setMainChargeByName

指定した名前を主担当に設定します。

構文

setMainChargeByName(name);

引数

name

名前を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");
  responsibleGroupItem.setMainChargeByName("佐藤");
});

setNoMainCharge

主担当を設定しないに変更します。

構文

setNoMainCharge();

引数

なし

返値

なし

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleGroupItem = screen.getSheetItemByLabel("自社担当グループ");
  responsibleGroupItem.setNoMainCharge();

  console.log(responsibleGroupItem.hasNoMainCharge()); // true
});

関連情報

• SheetItem
• ResponsibleGroups
• ResponsibleGroup