Selection

Selection クラスは紐づき型項目内の各シートに対して操作を行うためのメンバーを持っています。

継承

Targets

インスタンスプロパティ

selectionsId読み取り専用

紐づいているシートの ID を示す数値です。

例

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

  const selection = relationalItem.getSelection(1);

  console.log(selection.selectionId); // 1
});

selectionType読み取り専用

紐づいているシートのシート名を示す文字列です。

例

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

  const selection = relationalItem.getSelection(1);

  console.log(selection.selectionType); // customer
});

name読み取り専用

入力されている文字列です。

例

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

  const selection = relationalItem.getSelectionBy(1);

  console.log(selection.name); // ソフトブレーン

});

nameLength読み取り専用

name の文字数を表します。

例

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

  const selection = relationalItem.getSelectionBy(1);

  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  console.log("文字数:", selection.nameLength); // 文字数: 7
});

referable

紐づいているシートの閲覧権限があるかどうかの真偽値です。

例

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

  const selection = relationalItem.getSelectionByIndex(1);

  console.log(selection.selectionId); // NaN

  console.log(selection.referable); // false
});

インスタンスメソッド

nameLengthEqualsTo

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

構文

nameLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const selection = relationalItem.getSelectionBy(1);
  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  const result = selection.nameLengthEqualsTo(7);

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

nameLengthIsGreaterThan

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

構文

nameLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const selection = relationalItem.getSelectionBy(1);
  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  const result = selection.nameLengthIsGreaterThan(6);

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

nameLengthIsGreaterThanOrEqual

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

構文

nameLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const selection = relationalItem.getSelectionBy(1);
  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  const result = selection.nameLengthIsGreaterThanOrEqual(6);

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

nameLengthIsLessThan

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

構文

nameLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const selection = relationalItem.getSelectionBy(1);
  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  const result = selection.nameLengthIsLessThan(10);

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

nameLengthIsLessThanOrEqual

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

構文

nameLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const selection = relationalItem.getSelectionBy(1);
  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  const result = selection.nameLengthIsLessThanOrEqual(8);

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

nameContains

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

構文

nameContains(substring);

引数

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

返値

真偽値

例

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

  const selection = relationalItem.getSelectionBy(1);
  // 初期値を確認
  console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

  const containsSoft = selection.nameContains("ソフト");
  console.log("「ソフト」が含まれるか:", containsSoft); // 「ソフト」が含まれるか: true

  const containsBrain = selection.nameContains("ブレイン");
  console.log("「ブレイン」が含まれるか:", containsBrain); // 「ブレイン」が含まれるか: false
});

nameEqualsTo

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

構文

nameEqualsTo(string);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
const selection = SheetSaveScreen.getSheetItem(
"customers.customer.customer_name"
);
// 初期値を確認
console.log("初期値:", selection.name); // 初期値: "ソフトブレーン"

const isEqual = selection.nameEqualsTo("ソフトブレーン");
console.log("「ソフトブレーン」と一致するか:", isEqual); // 「ソフトブレーン」と一致するか: true
})

isReferable

紐づいているシートの閲覧権限があるかどうかを判定します

構文

isReferable();

引数

なし

返値

真偽値

例

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

  const selection = relationalItem.getSelectionByIndex(1);

  console.log(selection.selectionId); // NaN

  console.log(selection.isReferable()); // false
});

関連情報

• Targets
• Selections
• RelationItem