ResponsibilityItem

ResponsibilityItem クラスは社員アプリの担当業務項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

choices読み取り専用

担当業務の選択肢を表す配列です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]
});

mainResponsibility

現在選択されている主担当業務の id を示す数値です。

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");
  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 初期値を確認
  console.log("初期値:", responsibilityItem.mainResponsibility); // 初期値: 1

  // 値を変更
  responsibilityItem.mainResponsibility = 2;

  // 変更後の値を確認
  console.log("変更後:", responsibilityItem.mainResponsibility); // 変更後: 2
});

mainResponsibilityLabel読み取り専用

現在選択されている主担当業務の表示名です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");
  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }]

  // 初期値を確認
  console.log("初期値:", responsibilityItem.mainResponsibility); // 初期値: 1

  // 表示名を確認
  console.log("表示名:", responsibilityItem.mainResponsibilityLabel); // 表示名: 外勤
});

otherResponsibilityLabels読み取り専用

現在選択されている他の担当業務の表示名の配列です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("内勤");
  console.log(responsibilityItem.otherResponsibilityLabels); // ["内勤"]

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("他");
  console.log(responsibilityItem.otherResponsibilityLabels); // ["内勤", "他"]
});

otherResponsibilityLength読み取り専用

現在選択されている他の担当業務の数です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("内勤");
  console.log(responsibilityItem.otherResponsibilityLength); // 1

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("他");
  console.log(responsibilityItem.otherResponsibilityLength); // 2
});

responsibilityLabels読み取り専用

現在選択されている担当業務の表示名の配列です。主担当業務と他の担当業務の両方を含みます。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 主担当業務を確認
  console.log(responsibilityItem.mainResponsibilityLabel); // 外勤

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("内勤");
  console.log(responsibilityItem.responsibilityLabels); // ["外勤", "内勤"]

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("他");
  console.log(responsibilityItem.responsibilityLabels); // ["外勤", "内勤", "他"]
});

responsibilityLength読み取り専用

現在選択されている担当業務の数です。主担当業務と他の担当業務の両方を含みます。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 主担当業務を確認
  console.log(responsibilityItem.mainResponsibilityLabel); // 外勤

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("内勤");
  console.log(responsibilityItem.responsibilityLength); // 2

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("他");
  console.log(responsibilityItem.responsibilityLength); // 3
});

インスタンスメソッド

onMainResponsibilityUpdated

主担当業務が更新されたタイミングで関数を実行するeventHookを登録します。

構文

onMainResponsibilityUpdated(callback);
onMainResponsibilityUpdated(callback, group);

引数

callback

主担当業務が更新されたタイミングで実行する関数です。

group

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

返値

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

例

esmJSPlugin.screen.sheetSave("employee").onEntered(function (screen) {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 主担当業務が更新されたタイミングで関数を実行
  const unregister = responsibilityItem.onMainResponsibilityUpdated(
    function () {
      console.log("main responsibility updated");
      unregister(); // 解除
    }
  );
});

onOtherResponsibilitiesUpdated

他の担当業務が更新されたタイミングで関数を実行するeventHookを登録します。

構文

onOtherResponsibilitiesUpdated(callback);
onOtherResponsibilitiesUpdated(callback, group);

引数

callback

他の担当業務が更新されたタイミングで実行する関数です。

group

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

返値

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

例

esmJSPlugin.screen.sheetSave("employee").onEntered(function (screen) {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 主担当業務が更新されたタイミングで関数を実行
  const unregister = responsibilityItem.onOtherResponsibilitiesUpdated(
    function () {
      console.log("other responsibility updated");
      unregister(); // 解除
    }
  );
});

setMainResponsibility

mainResponsibilityの値を変更します。

構文

setMainResponsibility(id);

引数

id
対象の選択肢を指定するための id を表す数値です。
choicesで確認できます。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 初期値を確認
  console.log("初期値:", responsibilityItem.mainResponsibility); // 初期値: 1

  // 値を変更
  responsibilityItem.setMainResponsibility(2);

  // 変更後の値を確認
  console.log("変更後:", responsibilityItem.mainResponsibility); // 変更後: 2
});

setMainResponsibilityByChoiceLabel

mainResponsibilityの値を指定した選択肢名の主担当業務の選択肢に変更します。

構文

setMainResponsibilityByChoiceLabel(label);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 初期値を確認
  console.log("初期値:", responsibilityItem.mainResponsibilityLabel); // 初期値: 外勤

  // 値を変更
  responsibilityItem.setMainResponsibilityByChoiceLabel("内勤");

  // 変更後の値を確認
  console.log("変更後:", responsibilityItem.mainResponsibilityLabel); // 変更後: 内勤
});

mainResponsibilityEqualsTo

mainResponsibilityが指定した id と一致するかどうかの真偽値を返します。

構文

mainResponsibilityEqualsTo(id);

引数

id
比較対象の id を表す数値です。
choicesで確認できます。

返値

mainResponsibilityが指定した id と一致するかどうかの真偽値です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 初期値を確認
  console.log("初期値:", responsibilityItem.mainResponsibility); // 初期値: 2

  const result = responsibilityItem.mainResponsibilityEqualsTo(2);

  // 変更後の値を確認
  console.log("2と一致するかどうか:", result); // 2と一致するかどうか: true
});

mainResponsibilityLabelEqualsTo

mainResponsibilityLabelが指定した文字列と一致するかどうかの真偽値を返します。

構文

mainResponsibilityLabelEqualsTo(label);

引数

label
比較対象の文字列です。

返値

mainResponsibilityLabelが指定した文字列と一致するかどうかの真偽値です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 初期値を確認
  console.log("初期値:", responsibilityItem.mainResponsibilityLabel); // 初期値: 外勤

  const result = responsibilityItem.mainResponsibilityLabelEqualsTo("外勤");

  // 変更後の値を確認
  console.log("外勤と一致するかどうか:", result); // 外勤と一致するかどうか: true
});

setMainResponsibilityChoiceDisabled

指定したidの主担当業務の選択肢の非活性状態を変更します。
レコード詳細画面では利用できません。

構文

setMainResponsibilityChoiceDisabled(label, disabled);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

disabled
対象を非活性状態にするかどうかを指定するための真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setMainResponsibilityChoiceDisabled(2, true); // 内勤は非活性状態になる
});

setMainResponsibilityChoiceDisabledByLabel

指定した選択肢名の主担当業務の選択肢の非活性状態を変更します。
レコード詳細画面では利用できません。

構文

setMainResponsibilityChoiceDisabledByLabel(label, disabled);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

disabled
対象を非活性状態にするかどうかを指定するための真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setMainResponsibilityChoiceDisabledByLabel("内勤", true); // 内勤は非活性状態になる
});

setOtherResponsibilitySelected

指定したidの他の担当業務の選択肢の選択状態を変更します。

構文

setOtherResponsibilitySelected(id, selected);

引数

id
対象の選択肢を指定するための id を表す数値です。
choicesで確認できます。

selected
対象を選択状態にするかどうかを指定するための真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilitySelected(2, true);
  responsibilityItem.setOtherResponsibilitySelected(3, true);
  responsibilityItem.setOtherResponsibilitySelected(2, false);

  console.log(responsibilityItem.otherResponsibilityLabels); // ["他"]
});

setOtherResponsibilitySelectedByChoiceLabel

指定した選択肢名の他の担当業務の選択肢の選択状態を変更します。

構文

setOtherResponsibilitySelectedByChoiceLabel(label, selected);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

selected
対象を選択状態にするかどうかを指定するための真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("内勤", true);
  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("他", true);
  responsibilityItem.setOtherResponsibilitySelectedByChoiceLabel("内勤", false);

  console.log(responsibilityItem.otherResponsibilityLabels); // ["他"]
});

otherResponsibilitiesInclude

指定したidの選択肢を他の担当業務で選択しているかどうかを表す真偽値を返します。

構文

otherResponsibilitiesInclude(id);

引数

id
対象の選択肢を指定するための id を表す数値です。
choicesで確認できます。

返値

指定したidの選択肢を現在選択しているかどうかを表す真偽値です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilitySelected(1, true);

  console.log(checkboxItem.otherResponsibilitiesInclude(1)); // true
});

otherResponsibilityLabelsInclude

指定した選択肢名の選択肢を他の担当業務で選択しているかどうかを表す真偽値を返します。

構文

otherResponsibilityLabelsInclude(label);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

返値

指定した選択肢名の選択肢を現在選択しているかどうかを表す真偽値です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilitySelected(1, true);

  console.log(checkboxItem.otherResponsibilityLabelsInclude("外勤")); // true
});

setOtherResponsibilityChoiceDisabled

指定したidの他の担当業務の選択肢の非活性状態を変更します。
レコード詳細画面では利用できません。

構文

setOtherResponsibilityChoiceDisabled(id, disabled);

引数

id
対象の選択肢を指定するための id を表す数値です。
choicesで確認できます。

disabled
対象を非活性状態にするかどうかを指定するための真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilityChoiceDisabled(2, true); // 内勤は非活性状態になる
});

setOtherResponsibilityChoiceDisabledByLabel

指定した選択肢名の他の担当業務の選択肢の非活性状態を変更します。
レコード詳細画面では利用できません。

構文

setOtherResponsibilityChoiceDisabledByLabel(label, disabled);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

disabled
対象を非活性状態にするかどうかを指定するための真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  responsibilityItem.setOtherResponsibilityChoiceDisabledByLabel("内勤", true); // 内勤は非活性状態になる
});

responsibilitiesInclude

指定したidの選択肢を担当業務で選択しているかどうかを表す真偽値を返します。主担当業務と他の担当業務の両方を含みます。

構文

responsibilitiesInclude(label);

引数

id
対象の選択肢を指定するための id を表す数値です。
choicesで確認できます。

返値

指定したidの選択肢を現在選択しているかどうかを表す真偽値です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 主担当業務を確認
  console.log(responsibilityItem.mainResponsibilityLabel); // 外勤

  responsibilityItem.setOtherResponsibilitySelected(2, true);

  console.log(checkboxItem.responsibilitiesInclude(1)); // true
  console.log(checkboxItem.responsibilitiesInclude(2)); // true
});

responsibilityLabelsInclude

指定した選択肢名の選択肢を担当業務で選択しているかどうかを表す真偽値を返します。主担当業務と他の担当業務の両方を含みます。

構文

responsibilityLabelsInclude(label);

引数

label
対象の選択肢を指定するための選択肢名を表す文字列です。

返値

指定した選択肢名の選択肢を現在選択しているかどうかを表す真偽値です。

例

esmJSPlugin.sheetSave("employee").onSheetItemsMounted((screen) => {
  const responsibilityItem = screen.getSheetItemByLabel("担当業務");

  // 選択肢を確認
  console.log(responsibilityItem.choices); // [{ label: "外勤", value: 1 }, { label: "内勤", value: 2 }, { label: "他", value: 3 }]

  // 主担当業務を確認
  console.log(responsibilityItem.mainResponsibilityLabel); // 外勤

  responsibilityItem.setOtherResponsibilitySelected(2, true);

  console.log(checkboxItem.responsibilityLabelsInclude("外勤")); // true
  console.log(checkboxItem.responsibilityLabelsInclude("内勤")); // true
});

関連情報

SheetItem