ResponsibleEmployeeItem

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

継承

SheetItem

インスタンスプロパティ

length

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

mainChargeId

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

  responsibleEmployeeItem.mainChargeId = 2;

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

entityIds

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

entityNames

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

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

インスタンスメソッド

entityNamesInclude

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

構文

entityNamesInclude();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

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

entityIdsInclude

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

構文

entityIdsInclude();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

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

onResponsibleEmployeeAdded

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

構文

onResponsibleEmployeeAdded(callback);
onResponsibleEmployeeAdded(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

  const unlisten = responsibleEmployeeItem.onResponsibleEmployeeAdded(
    function () {
      console.log("ResponsibleEmployeeAdded");
      unlisten(); // 解除
    }
  );
});

onResponsibleEmployeeRemoved

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

構文

onResponsibleEmployeeRemoved(callback);
onResponsibleEmployeeRemoved(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

  const unlisten = responsibleEmployeeItem.onResponsibleEmployeeRemoved(
    function () {
      console.log("ResponsibleEmployeeRemoved");
      unlisten(); // 解除
    }
  );
});

onResponsibleEmployeesUpdated

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

構文

onResponsibleEmployeesUpdated(callback);
onResponsibleEmployeesUpdated(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

getResponsibleEmployees

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

構文

getResponsibleEmployees();

引数

なし

返値

ResponsibleEmployeesクラスのインスタンス

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");
  const responsibleEmployees = responsibleEmployeeItem.getResponsibleEmployees();

  console.log(responsibleEmployees);
});

getResponsibleEmployeeBy

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

構文

getResponsibleEmployeeBy(ID);

引数

ID

自社担当社員の ID を示す数値です。

返値

ResponsibleEmployeeクラスのインスタンス

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

  const facility = responsibleEmployeeItem.getResponsibleEmployeeBy(1);

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

getResponsibleEmployeeByIndex

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

構文

getResponsibleEmployeeByIndex(index);

引数

index

自社担当社員が何行目かを示す数値です。

返値

ResponsibleEmployeeクラスのインスタンス

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

  const facility = responsibleEmployeeItem.getResponsibleEmployeeByIndex(0);

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

setResponsibleEmployeeAdded

entityId を指定して、自社担当社員を追加します。

構文

setResponsibleEmployeeAdded(entityId);

引数

entityId

自社担当社員の entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

  responsibleEmployeeItem.setResponsibleEmployeeAdded(1);

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

setResponsibleEmployeeRemoved

指定した entityId の自社担当社員を削除します。

構文

setResponsibleEmployeeRemoved(entityId);

引数

entityId

自社担当社員の entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

  responsibleEmployeeItem.setResponsibleEmployeeRemoved(1);

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

setResponsibleEmployeeRemovedByIndex

指定した index の自社担当社員を削除します。

構文

setResponsibleEmployeeRemovedByIndex(index);

引数

index

何行目かの自社担当社員を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

  responsibleEmployeeItem.setResponsibleEmployeeRemoved(1);

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

lengthEqualsTo

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

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

    const result = responsibleEmployeeItem.lengthEqualsTo(7);

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

lengthIsGreaterThan

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

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

    const result = responsibleEmployeeItem.lengthIsGreaterThan(6);

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

lengthIsGreaterThanOrEqual

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

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

    const result = responsibleEmployeeItem.lengthIsGreaterThanOrEqual(6);

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

lengthIsLessThan

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

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

    const result = responsibleEmployeeItem.lengthIsLessThan(10);

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

lengthIsLessThanOrEqual

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

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onEntered((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

    const result = responsibleEmployeeItem.lengthIsLessThanOrEqual(8);

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

hasNoMainCharge

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

構文

hasNoMainCharge();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");

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

setMainChargeById

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

構文

setMainChargeById(id);

引数

id

id を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");
  responsibleEmployeeItem.setMainChargeById(1);
});

setMainChargeByName

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

構文

setMainChargeByName(name);

引数

name

名前を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");
  responsibleEmployeeItem.setMainChargeByName("佐藤");
});

setNoMainCharge

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

構文

setNoMainCharge();

引数

なし

返値

なし

例

esmJSPlugin.sheetEntry("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const responsibleEmployeeItem = screen.getSheetItemByLabel("自社担当社員");
  responsibleEmployeeItem.setNoMainCharge();

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

関連情報

• SheetItem
• ResponsibleEmployees
• ResponsibleEmployee