ResponsibleDepartmentItem

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

継承

SheetItem

インスタンスプロパティ

length

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

mainChargeId

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

  responsibleDepartmentItem.mainChargeId = 2;

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

entityIds

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

entityNames

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

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

インスタンスメソッド

entityNamesInclude

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

構文

entityNamesInclude();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

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

entityIdsInclude

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

構文

entityIdsInclude();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

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

onResponsibleDepartmentAdded

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

構文

onResponsibleDepartmentAdded(callback);
onResponsibleDepartmentAdded(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

  const unlisten = responsibleDepartmentItem.onResponsibleDepartmentAdded(
    function () {
      console.log("ResponsibleDepartmentAdded");
      unlisten(); // 解除
    }
  );
});

onResponsibleDepartmentRemoved

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

構文

onResponsibleDepartmentRemoved(callback);
onResponsibleDepartmentRemoved(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

  const unlisten = responsibleDepartmentItem.onResponsibleDepartmentRemoved(
    function () {
      console.log("ResponsibleDepartmentRemoved");
      unlisten(); // 解除
    }
  );
});

onResponsibleDepartmentsUpdated

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

構文

onResponsibleDepartmentsUpdated(callback);
onResponsibleDepartmentsUpdated(callback, group);

引数

callback

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

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("customer").onEntered(function (screen) {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

getResponsibleDepartments

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

構文

getResponsibleDepartments();

引数

なし

返値

ResponsibleDepartmentsクラスのインスタンス

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");
  const responsibleDepartments = responsibleDepartmentItem.getResponsibleDepartments();

  console.log(responsibleDepartments);
});

getResponsibleDepartmentBy

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

構文

getResponsibleDepartmentBy(ID);

引数

ID

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

返値

ResponsibleDepartmentクラスのインスタンス

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

  const facility = responsibleDepartmentItem.getResponsibleDepartmentBy(1);

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

getResponsibleDepartmentByIndex

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

構文

getResponsibleDepartmentByIndex(index);

引数

index

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

返値

ResponsibleDepartmentクラスのインスタンス

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");
  
  console.log(responsibleDepartmentItem.entityIds); // [1,2,3,4]

  const facility = responsibleDepartmentItem.getResponsibleDepartmentByIndex(0);

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

setResponsibleDepartmentAdded

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

構文

setResponsibleDepartmentAdded(entityId);

引数

entityId

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

  responsibleDepartmentItem.setResponsibleDepartmentAdded(1);

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

setResponsibleDepartmentRemoved

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

構文

setResponsibleDepartmentRemoved(entityId);

引数

entityId

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

  responsibleDepartmentItem.setResponsibleDepartmentRemoved(1);

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

setResponsibleDepartmentRemovedByIndex

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

構文

setResponsibleDepartmentRemovedByIndex(index);

引数

index

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const responsibleDepartmentItem = screen.getSheetItemByLabel("自社担当部署");

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

  responsibleDepartmentItem.setResponsibleDepartmentRemovedByIndex(1);

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

lengthEqualsTo

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

構文

lengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

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

    const result = responsibleDepartmentItem.lengthEqualsTo(7);

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

lengthIsGreaterThan

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

構文

lengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

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

    const result = responsibleDepartmentItem.lengthIsGreaterThan(6);

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

lengthIsGreaterThanOrEqual

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

構文

lengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

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

    const result = responsibleDepartmentItem.lengthIsGreaterThanOrEqual(6);

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

lengthIsLessThan

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

構文

lengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

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

    const result = responsibleDepartmentItem.lengthIsLessThan(10);

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

lengthIsLessThanOrEqual

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

構文

lengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

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

    const result = responsibleDepartmentItem.lengthIsLessThanOrEqual(8);

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

hasNoMainCharge

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

構文

hasNoMainCharge();

引数

なし

返値

真偽値

例

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

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

setMainChargeById

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

構文

setMainChargeById(id);

引数

id

id を示す文字列です。

返値

真偽値

例

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

setMainChargeByName

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

構文

setMainChargeByName(name);

引数

name

名前を示す文字列です。

返値

真偽値

例

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

setNoMainCharge

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

構文

setNoMainCharge();

引数

なし

返値

なし

例

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

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

関連情報

• SheetItem
• ResponsibleDepartments
• ResponsibleDepartment