TreeViewItem

TreeViewItemクラスは、顧客シートの顧客タイプ項目、商品シートの商品カテゴリ項目、社員シートの部署項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

selection

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

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  //選択肢を確認
  console.log(customerTypeItem.nodes); // [{ name: "法人", id: 1 }, { name: "事業所", id: 2 }]

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

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

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

selectionLabel読み取り専用

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  //選択肢を確認
  console.log(customerTypeItem.nodes); // [{ name: "法人", id: 1 }, { name: "事業所", id: 2 }]

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

  // 表示名を確認
  console.log("表示名:", customerTypeItem.selectionLabel); // 表示名: 法人
});

selectionLabelLength読み取り専用

selectionLabel の文字数を表します。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");

  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  console.log("文字数:", customerTypeItem.selectionLabelLength); // 文字数: 2
});

nodes読み取り専用

選択肢の配列です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");

  console.log(customerTypeItem.nodes); // [{ name: "法人", id: 1 }, { name: "事業所", id: 2 }]
});

インスタンスメソッド

setSelection

selectionの値を変更します。

構文

setSelection(id);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  //選択肢を確認
  console.log(customerTypeItem.nodes); // [{ name: "法人", id: 1 }, { name: "事業所", id: 2 }]

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

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

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

setSelectionByLabel

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

構文

setSelectionByLabel(label);

引数

label
選択する選択肢の表示名です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  //選択肢を確認
  console.log(customerTypeItem.nodes); // [{ name: "法人", id: 1 }, { name: "事業所", id: 2 }]

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

  // 値を変更
  customerTypeItem.setSelectionByLabel("事業所");

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

selectionEqualsTo

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

構文

selectionEqualsTo(id);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");

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

  const result = customerTypeItem.selectionEqualsTo(1);

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

selectionLabelEqualsTo

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

構文

selectionLabelEqualsTo(label);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");

  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: 法人

  const result = customerTypeItem.selectionLabelEqualsTo("法人");

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

setAllNodesOpen

選択ツリーを全て展開します。
シート詳細画面では利用できません。

構文

setAllNodesOpen();

引数

なし

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  customerTypeItem.setAllNodesOpen();
});

selectionLabelLengthEqualsTo

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

構文

selectionLabelLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  const result = customerTypeItem.selectionLabelLengthEqualsTo(2);

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

selectionLabelLengthIsGreaterThan

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

構文

selectionLabelLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  const result = customerTypeItem.selectionLabelLengthIsGreaterThan(3);

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

selectionLabelLengthIsGreaterThanOrEqual

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

構文

selectionLabelLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  const result = customerTypeItem.selectionLabelLengthIsGreaterThanOrEqual(3);

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

selectionLabelLengthIsLessThan

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

構文

selectionLabelLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  const result = customerTypeItem.selectionLabelLengthIsLessThan(3);

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

selectionLabelLengthIsLessThanOrEqual

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

構文

selectionLabelLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  const result = customerTypeItem.selectionLabelLengthIsLessThanOrEqual(3);

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

selectionLabelContains

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

構文

selectionLabelContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const customerTypeItem = screen.getSheetItemByLabel("顧客タイプ");
  // 初期値を確認
  console.log("初期値:", customerTypeItem.selectionLabel); // 初期値: "法人"

  const containsSoft = customerTypeItem.selectionLabelContains("事業");
  console.log("「事業」が含まれるか:", containsSoft); // 「事業」が含まれるか: false
});

関連情報

SheetItem