IntroductionSource

継承

Targets

インスタンスプロパティ

entityId読み取り専用

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

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.entityId); // 1
});

entityName読み取り専用

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

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.entityName); // 佐藤
});

date

入力している日付を示す文字列です。

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.date); // "2020/12/11"

  introductionsource.date = "2022/12/22";

  console.log(introductionsource.date); //  "2022/12/22"
});

referable

紐づいているシートの参照権限があるかどうかを示す真偽値です。

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.referable); //　true
});

インスタンスメソッド

setDate

YYYY/MM/DD の形式の文字列を受け取り、date の値を変更します。

構文

setDate(date);

引数

date
YYYY/MM/DD の形式の文字列です。

返値

なし

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.date); // "2020/12/11"

  introductionsource.setDate("2022/12/22");

  console.log(introductionsource.date); //  "2022/12/22"
});

dateIsBefore

date が指定した日付より前の日付かどうかの真偽値を返します。

構文

dateIsBefore(date);

引数

date
比較対象の日付 (YYYY/MM/DD の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  // 初期値を確認
  console.log("初期値:", introductionsource.date); // 初期値: 2024/12/18

  const result = introductionsource.dateIsBefore("2024/12/20");

  console.log("指定日より前か:", result); // 指定日より前か:true
});

dateIsAfter

date が指定した日付より後の日付かどうかの真偽値を返します。

構文

dateIsAfter(date);

引数

date
比較対象の日付 (YYYY/MM/DD の形式)。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  // 初期値を確認
  console.log("初期値:", introductionsource.date); // 初期値: 2024/12/18

  const result = introductionsource.dateIsAfter("2024/12/20");

  console.log("指定日より後か:", result); // 指定日より後か:false
});

dateIsBetween

date が指定した日付の間にあるかどうかの真偽値を返します。

構文

dateIsBetween(beforeDate, afterDate);

引数

beforeDate
範囲の開始日 (YYYY/MM/DD の形式)
afterDate
範囲の終了日 (YYYY/MM/DD の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.date); // 初期値: 2024/12/18

  const result = introductionsource.dateIsBetween("2024/12/15", "2024/12/20");

  console.log("指定範囲内か:", result); // 指定範囲内か:true
});

isReferable

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

構文

isReferable();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.isReferable()); //　true
});

entityIdEqualsTo

指定した数字とentityIdが等しいことを判定します。

構文

entityIdEqualsTo(ID);

引数

ID
紹介元の ID を示す数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("businesscard").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  console.log(introductionsource.entityId); // 1

  const result = entityIdEqualsTo(1);

  console.log("結果", result); // 結果:true
});

entityNameEqualsTo

構文

entityNameEqualsTo(label);

引数

label

比較対象の文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);

  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: 佐藤

  const result = introductionsource.entityNameEqualsTo("佐藤");

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

entityNameLengthEqualsTo

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

構文

entityNameLengthEqualsTo(number);

引数

number

比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: "佐藤"

  const result = introductionsource.entityNameLengthEqualsTo(7);

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

entityNameLengthIsGreaterThan

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

構文

entityNameLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: "佐藤"

  const result = introductionsource.entityNameLengthIsGreaterThan(6);

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

entityNameLengthIsGreaterThanOrEqual

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

構文

entityNameLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: "佐藤"

  const result = introductionsource.entityNameLengthIsGreaterThanOrEqual(6);

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

entityNameLengthIsLessThan

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

構文

entityNameLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: "佐藤"

  const result = introductionsource.entityNameLengthIsLessThan(10);

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

entityNameLengthIsLessThanOrEqual

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

構文

entityNameLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: "佐藤"

  const result = introductionsource.entityNameLengthIsLessThanOrEqual(8);

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

entityNameContains

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

構文

entityNameContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const introductionsourceItem = SheetSaveScreen.getSheetItemByLabel("紹介元");

  const introductionsource = introductionsourceItem.getIntroductionSourceByIndex(1);
  // 初期値を確認
  console.log("初期値:", introductionsource.entityName); // 初期値: "佐藤"

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