MultiSelectItem

MultiSelectItemクラスはチェックボックス型項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

choices読み取り専用

選択肢を表す配列です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, ...]
});

selectionLabels読み取り専用

現在選択されている選択肢の表示名の配列です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");
  checkboxItem.setSelectedByChoiceLabel("選択肢1", true);
  console.log(checkboxItem.selectionLabels); // ["選択肢1"]

  checkboxItem.setSelectedByChoiceLabel("選択肢2", true);
  console.log(checkboxItem.selectionLabels); // ["選択肢1", "選択肢2"]
});

selectionLength読み取り専用

現在選択されている選択肢の数です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");
  checkboxItem.setSelectedByChoiceLabel("選択肢1", true);
  console.log(checkboxItem.selectionLength); // 1

  checkboxItem.setSelectedByChoiceLabel("選択肢2", true);
  checkboxItem.setSelectedByChoiceLabel("選択肢3", true);
  console.log(checkboxItem.selectionLength); // 3
});

インスタンスメソッド

setSelected

指定したidの選択肢の選択状態を変更します。

構文

setSelected(id, selected);

引数

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

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, { label: "選択肢2", value: 2 }, { label: "選択肢3", value: 3 }]

  checkboxItem.setSelected(1, true);
  checkboxItem.setSelected(2, true);
  checkboxItem.setSelected(1, false);

  console.log(checkboxItem.selectionLabels); // ["選択肢2"]
});

setSelectedByChoiceLabel

指定した選択肢名の選択肢の選択状態を変更します。

構文

setSelectedByChoiceLabel(label, selected);

引数

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

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, { label: "選択肢2", value: 2 }, { label: "選択肢3", value: 3 }]

  checkboxItem.setSelectedByChoiceLabel("選択肢1", true);
  checkboxItem.setSelectedByChoiceLabel("選択肢2", true);
  checkboxItem.setSelectedByChoiceLabel("選択肢1", false);
  checkboxItem.setSelectedByChoiceLabel("選択肢3", true);

  console.log(checkboxItem.selectionLabels); // ["選択肢2", "選択肢3"]
});

setChoiceDisabled

指定したidの選択肢の非活性状態を変更します。
シート詳細画面では利用できません。

構文

setChoiceDisabled(id, disabled);

引数

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

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, ...]

  checkboxItem.setChoiceDisabled(1, true); // 選択肢1は非活性状態になる
});

setChoiceDisabledByLabel

指定した選択肢名の選択肢の非活性状態を変更します。 シート詳細画面では利用できません。

構文

setChoiceDisabledByLabel(label, disabled);

引数

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

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, ...]

  checkboxItem.setChoiceDisabledByLabel("選択肢1", true); // 選択肢1は非活性状態になる
});

selectionsInclude

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

構文

selectionsInclude(id);

引数

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

返値

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, { label: "選択肢2", value: 2 }, { label: "選択肢3", value: 3 }]

  checkboxItem.setSelected(1, true);

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

selectionLabelsInclude

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

構文

selectionLabelsInclude(label);

引数

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

返値

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const checkboxItem = screen.getSheetItemByLabel("チェックボックス");

  console.log(checkboxItem.choices); // [{ label: "選択肢1", value: 1 }, { label: "選択肢2", value: 2 }, { label: "選択肢3", value: 3 }]

  checkboxItem.setSelected(1, true);

  console.log(checkboxItem.selectionLabelsInclude("選択肢1")); // true
});

関連情報

SheetItem