SingleSelectItem

SingleSelectItem クラスはプルダウンとラジオボタン型項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

selection

現在選択されている値の id を示す数値です。

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  //選択肢を確認
  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]

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

  // 値を変更
  singleSelectItem.selection = 2;

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

selectionLabel読み取り専用

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  //選択肢を確認
  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]

  // IDを確認
  console.log("ID:", singleSelectItem.selection); // ID: 1

  // 表示名を確認
  console.log("表示名:", singleSelectItem.selectionLabel); // 表示名: 存続
});

selectionLabelLength読み取り専用

selectionLabel の文字数を表します。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );

  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  console.log("文字数:", singleSelectItem.selectionLabelLength); // 文字数: 7
});

choices読み取り専用

選択肢の配列です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );

  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]
});

インスタンスメソッド

setSelection

selectionの値を変更します。

構文

setSelection(id);

引数

id
選択する値の id を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  //選択肢を確認
  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]

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

  // 値を変更
  singleSelectItem.setSelection(2);

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

setSelectionByLabel

selectionの値を指定した選択肢名の選択肢に変更します。

構文

setSelectionByLabel(label);

引数

label
選択する値の label です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  //選択肢を確認
  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]

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

  // 値を変更
  singleSelectItem.setSelectionByLabel("倒産");

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

setChoiceDisabled

指定した id の選択肢を選択できないようにします。
シート詳細画面では利用できません。

構文

setChoiceDisabled(id);

引数

id
選択肢の id を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  //選択肢を確認
  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]

  singleSelectItem.setChoiceDisabled(2);
});

setChoiceDisabledByLabel

指定した選択肢名の選択肢を選択できないようにします。
シート詳細画面では利用できません。

構文

setChoiceDisabledByLabel(label, disabled);

引数

label
選択肢の選択肢名です。

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  //選択肢を確認
  console.log(singleSelectItem.choices); // [{ label:"存続",value:1 },{ label:"倒産",value:2 }]

  singleSelectItem.setChoiceDisabledByLabel("倒産", true); // 倒産は非活性状態になる
});

selectionEqualsTo

selectionが指定した id と一致するかどうかを判定します。

構文

selectionEqualsTo(id);

引数

id
比較対象の id を示す数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );

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

  const result = singleSelectItem.selectionEqualsTo(1);

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

selectionLabelEqualsTo

selectionLabelが指定した文字列と一致するかどうかを判定します。

構文

selectionLabelEqualsTo(label);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );

  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: 存続

  const result = singleSelectItem.selectionLabelEqualsTo("存続");

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

selectionLabelLengthEqualsTo

数値を受け取り、selectionLabel の文字数が指定した数値と同じかどうかを判定します。

構文

selectionLabelLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  const result = singleSelectItem.selectionLabelLengthEqualsTo(7);

  console.log("文字数が7かどうか:", result); // 文字数が7どうか: false
});

selectionLabelLengthIsGreaterThan

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

構文

selectionLabelLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  const result = singleSelectItem.selectionLabelLengthIsGreaterThan(6);

  console.log("文字数が6より大きいか:", result); // 文字数が6より大きいか: false
});

selectionLabelLengthIsGreaterThanOrEqual

selectionLabel の文字数が指定した数値以上かどうかを判定します。

構文

selectionLabelLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  const result = singleSelectItem.selectionLabelLengthIsGreaterThanOrEqual(6);

  console.log("文字数が6以上か:", result); // 文字数が6以上か: false
});

selectionLabelLengthIsLessThan

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

構文

selectionLabelLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  const result = singleSelectItem.selectionLabelLengthIsLessThan(10);

  console.log("文字数が10未満か:", result); // 文字数が10未満か: true
});

selectionLabelLengthIsLessThanOrEqual

selectionLabel の文字数が指定した数値以下かどうかを判定します。

構文

selectionLabelLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  const result = singleSelectItem.selectionLabelLengthIsLessThanOrEqual(8);

  console.log("文字数が8以下か:", result); // 文字数が8以下か: true
});

selectionLabelContains

指定した文字列が selectionLabel に含まれているかどうかを判定します。

構文

selectionLabelContains(substring);

引数

substring
検索対象の文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const singleSelectItem = SheetSaveScreen.getSheetItem(
    "customers.customer.existing_flg"
  );
  // 初期値を確認
  console.log("初期値:", singleSelectItem.selectionLabel); // 初期値: "存続"

  const containsSoft = singleSelectItem.selectionLabelContains("ソフト");
  console.log("「ソフト」が含まれるか:", containsSoft); // 「ソフト」が含まれるか: false
});

関連情報

• SheetItem
• SheetSaveScreen