ScheduleItem

ScheduleItem クラスは日付型項目のスケジュール紐づきに対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

subject

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

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  // 値を変更
  scheduleDateItem.subject = "資料を作成します";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.subject); // 変更後: "資料を作成します"
});

subjectLength読み取り専用

subject の文字数を表します。

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  console.log("文字数:", scheduleDateItem.subjectLength); // 文字数: 7
});

scheduleType

現在選択されているスケジュールタイプの id を示す数値です。

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]

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

  // 値を変更
  scheduleDateItem.scheduleType = 2;

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

scheduleTypeLabel読み取り専用

現在選択されているスケジュールタイプの表示名です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]

  // IDを確認
  console.log("ID:", scheduleDateItem.scheduleType); // ID: 1

  // 表示名を確認
  console.log("表示名:", scheduleDateItem.scheduleTypeLabel); // 表示名: 外出
});

scheduleTypeLabelLength読み取り専用

scheduleTypeLabel の文字数を表します。

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

  console.log("文字数:", scheduleDateItem.scheduleTypeLabelLength); // 文字数: 2
});

scheduleTypeChoices読み取り専用

選択肢の配列です。

例

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

  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]
});

date

入力されている日付の文字列です。YYYY/MM/DD の形式で表現されます。

例

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

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

  // 値を変更
  scheduleDateItem.date = "2024/12/31";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.date); // 変更後: "2024/12/31"
});

year

入力されている年を示す数値です。

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.year); // 初期値: 2024

  // 値を変更
  scheduleDateItem.year = 2025;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.date); // 変更後: 2025
});

month

入力されている月を示す数値です。

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.month); // 初期値: 10

  // 値を変更
  scheduleDateItem.month = 12;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.month); // 変更後: 12
});

day

入力されている日を示す数値です。

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.day); // 初期値: 18

  // 値を変更
  scheduleDateItem.day = 31;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.day); // 変更後: 31
});

allDay

終日の予定かどうかを示す真偽値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.allDay); // 初期値: false

  // 値を変更
  scheduleDateItem.allDay = true;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.allDay); // 変更後: true
});

beginDatetime

入力されている日時の文字列です。YYYY/MM/DD HH:MM の形式で表現されます。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: "2024/12/18 11:30"

  // 値を変更
  scheduleDateItem.beginDatetime = "2024/12/31 11:40";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginDatetime); // 変更後: "2024/12/31 11:40"
});

beginDate

入力されている日付の文字列です。YYYY/MM/DD の形式で表現されます。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  // 値を変更
  scheduleDateItem.beginDate = "2024/12/31";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginDate); // 変更後: "2024/12/31"
});

beginYear

入力されている年を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginYear); // 初期値: 2024

  // 値を変更
  scheduleDateItem.beginYear = 2025;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginYear); // 変更後: 2025
});

beginMonth

入力されている月を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginMonth); // 初期値: 10

  // 値を変更
  scheduleDateItem.beginMonth = 12;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginMonth); // 変更後: 12
});

beginDay

入力されている日を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDay); // 初期値: 18

  // 値を変更
  scheduleDateItem.beginDay = 31;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginDay); // 変更後: 31
});

beginTime

入力されている時間の文字列です。HH:MM の形式で表現されます。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: "11:30"

  // 値を変更
  scheduleDateItem.beginTime = "12:30";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginTime); // 変更後: "12:30"
});

beginHour

入力されている時を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginHour); // 初期値: 11

  // 値を変更
  scheduleDateItem.beginHour = 12;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginHour); // 変更後: 12
});

beginMinute

入力されている分を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginMinute); // 初期値: 30

  // 値を変更
  scheduleDateItem.beginMinute = 40;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginMinute); // 変更後: 40
});

endDatetime

入力されている日時の文字列です。YYYY/MM/DD HH:MM の形式で表現されます。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: "2024/12/18 11:30"

  // 値を変更
  scheduleDateItem.endDatetime = "2024/12/31 11:40";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endDatetime); // 変更後: "2024/12/31 11:40"
});

endDate

入力されている日付の文字列です。YYYY/MM/DD の形式で表現されます。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  // 値を変更
  scheduleDateItem.endDate = "2024/12/31";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endDate); // 変更後: "2024/12/31"
});

endYear

入力されている年を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endYear); // 初期値: 2024

  // 値を変更
  scheduleDateItem.endYear = 2025;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endYear); // 変更後: 2025
});

endMonth

入力されている月を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endMonth); // 初期値: 10

  // 値を変更
  scheduleDateItem.endMonth = 12;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endMonth); // 変更後: 12
});

endDay

入力されている日を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDay); // 初期値: 18

  // 値を変更
  scheduleDateItem.endDay = 31;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endDay); // 変更後: 31
});

endTime

入力されている時間の文字列です。HH:MM の形式で表現されます。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: "11:30"

  // 値を変更
  scheduleDateItem.endTime = "12:30";

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endTime); // 変更後: "12:30"
});

endHour

入力されている時を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endHour); // 初期値: 11

  // 値を変更
  scheduleDateItem.endHour = 12;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endHour); // 変更後: 12
});

endMinute

入力されている分を示す数値です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endMinute); // 初期値: 30

  // 値を変更
  scheduleDateItem.endMinute = 40;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endMinute); // 変更後: 40
});

participantNames

参加者の名前を示す文字列の配列です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐々木","佐藤"]
});

referable

スケジュールの参照権限があるかないかを示す真偽値です。

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.referable); // true
});

noRegistration

スケジュールを登録するかどうかの真偽値です。

例

esmJSPlugin.sheetSave("customer").onMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.noRegistration); // 初期値: true

  // 値を変更
  scheduleDateItem.noRegistration = false;

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.noRegistration); // 変更後: false
});

インスタンスメソッド

setSubject

文字列を受け取り、入力内容を変更します。

構文

setSubject(text);

引数

text
入力内容を示す文字列です。

返値

なし

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  // 値を変更
  scheduleDateItem.setSubject("資料を作成します");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.subject); // 変更後: "資料を作成します"
});

subjectLengthEqualsTo

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

構文

subjectLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  const result = scheduleDateItem.subjectLengthEqualsTo(7);

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

subjectLengthIsGreaterThan

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

構文

subjectLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  const result = scheduleDateItem.subjectLengthIsGreaterThan(6);

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

subjectLengthIsGreaterThanOrEqual

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

構文

subjectLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  const result = scheduleDateItem.subjectLengthIsGreaterThanOrEqual(6);

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

subjectLengthIsLessThan

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

構文

subjectLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  const result = scheduleDateItem.subjectLengthIsLessThan(10);

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

subjectLengthIsLessThanOrEqual

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

構文

subjectLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  const result = scheduleDateItem.subjectLengthIsLessThanOrEqual(8);

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

subjectContains

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

構文

subjectContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

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

subjectEqualsTo

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

構文

subjectEqualsTo(string);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.subject); // 初期値: "資料を作成する"

  const isEqual = scheduleDateItem.subjectEqualsTo("資料を作成する");
  console.log("「資料を作成する」と一致するか:", isEqual); // 「資料を作成する」と一致するか: true
});

setScheduleType

スケジュールタイプの id を指定してscheduleTypeの値を変更します。

構文

setScheduleType(id);

引数

id
選択するスケジュールタイプの id を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]

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

  // 値を変更
  scheduleDateItem.setScheduleType(2);

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

setScheduleTypeByLabel

スケジュールタイプの表示名を指定してscheduleTypeの値を変更します。

構文

setScheduleTypeByLabel(label);

引数

label
選択するスケジュールタイプの label です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: 外出

  // 値を変更
  scheduleDateItem.setScheduleTypeByLabel("来客");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.scheduleTypeLabel); // 変更後: 来客
});

setChoiceDisabled

指定した id の選択肢を選択できないようにします。 登録変更でのみ使用できます。

構文

setChoiceDisabled(id);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]

  scheduleDateItem.setChoiceDisabled(2);
});

setChoiceDisabledByLabel

指定した選択肢名の選択肢を選択できないようにします。 登録変更でのみ使用できます。

構文

setChoiceDisabledByLabel(label, disabled);

引数

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

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(scheduleDateItem.scheduleTypeChoices); // [{ label:"外出",value:1 },{ label:"来客",value:2 }]

  scheduleDateItem.setChoiceDisabledByLabel("来客", true); // 来客は非活性状態になる
});

scheduleTypeEqualsTo

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

構文

scheduleTypeEqualsTo(id);

引数

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

返値

真偽値

例

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

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

  const result = scheduleTypeEqualsTo(1);

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

scheduleTypeLabelEqualsTo

構文

scheduleTypeLabelEqualsTo(label);

引数

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

返値

真偽値

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: 外出

  const result = scheduleTypeLabelEqualsTo("外出");

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

scheduleTypeLabelLengthEqualsTo

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

構文

scheduleTypeLabelLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

  const result = scheduleDateItem.scheduleTypeLabelLengthEqualsTo(7);

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

scheduleTypeLabelLengthIsGreaterThan

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

構文

scheduleTypeLabelLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

  const result = scheduleDateItem.scheduleTypeLabelLengthIsGreaterThan(6);

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

scheduleTypeLabelLengthIsGreaterThanOrEqual

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

構文

scheduleTypeLabelLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

  const result =
    scheduleDateItem.scheduleTypeLabelLengthIsGreaterThanOrEqual(6);

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

scheduleTypeLabelLengthIsLessThan

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

構文

scheduleTypeLabelLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

  const result = scheduleDateItem.scheduleTypeLabelLengthIsLessThan(10);

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

scheduleTypeLabelLengthIsLessThanOrEqual

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

構文

scheduleTypeLabelLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

  const result = scheduleDateItem.scheduleTypeLabelLengthIsLessThanOrEqual(8);

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

scheduleTypeLabelContains

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

構文

scheduleTypeLabelContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.scheduleTypeLabel); // 初期値: "外出"

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

participantsInclude

指定したステータスに指定した id の参加者が存在するか判定します。

構文

participantsInclude(id, state);

引数

id

参加者の id を示す数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantsInclude(1)); // true
});

participantNamesInclude

指定したステータスに指定した名前の参加者が存在するか判定します。

構文

participantNamesInclude(name, state);

引数

name

参加者の名前を示す文字列です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐藤","佐々木"]

  console.log(scheduleDateItem.participantNamesInclude("佐藤")); // true
});

participantLengthEqualsTo

指定したステータスに指定した数の参加者がいるかどうかを判定します。

構文

participantLengthEqualsTo(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐藤","佐々木"]

  console.log(scheduleDateItem.participantLengthEqualsTo(2)); //true
});

participantLengthIsGreaterThan

指定したステータスの参加者数が指定した数よりも多いかどうかを判定します。

構文

participantLengthGreaterThan(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐藤","佐々木"]

  console.log(scheduleDateItem.participantLengthIsGreaterThan(1)); //true
});

participantLengthIsGreaterThanOrEqual

指定したステータスの参加者数が指定した数以上かどうかを判定します。

構文

participantLengthGreaterThanOrEqual(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐藤","佐々木"]

  console.log(scheduleDateItem.participantLengthIsGreaterThanOrEqual(1)); //true
});

participantLengthIsLessThan

指定したステータスの参加者数が指定した数よりも少ないかどうかを判定します。

構文

participantLengthIsLessThan(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐藤","佐々木"]

  console.log(scheduleDateItem.participantLengthIsLessThan(8)); //true
});

participantLengthIsLessThanOrEqual

指定したステータスの参加者数が指定した数以下かどうかを判定します。

構文

participantLengthIsLessThanOrEqual(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames); // ["佐藤","佐々木"]

  console.log(scheduleDateItem.participantLengthIsLessThanOrEqual(8)); //true
});

onParticipantAdded

指定したステータスの参加者が追加された後に呼び出されるeventHookを登録します。

構文

onParticipantAdded(callback, state, group);

引数

callback

参加者が追加されたタイミングで実行する関数です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const scheduleDateItem = screen.getSheetItemByLabel("参加者");

  const unlisten = scheduleDateItem.onParticipantAdded(function () {
    console.log("ParticipantAdded");
    unlisten(); // 解除
  });
});

onParticipantRemoved

指定したステータスの参加者が削除された後に呼び出されるeventHookを登録します。

構文

onParticipantRemoved(callback, state, group);

引数

callback

参加者が削除されたタイミングで実行する関数です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const scheduleDateItem = screen.getSheetItemByLabel("参加者");

  const unlisten = scheduleDateItem.onParticipantRemoved(function () {
    console.log("ParticipantRemoved");
    unlisten(); // 解除
  });
});

onParticipantsUpdated

参加者が更新された後に呼び出されるeventHookを登録します。

構文

onParticipantsUpdated(callback, state, group);

引数

callback

参加者が更新されたタイミングで実行する関数です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const scheduleDateItem = screen.getSheetItemByLabel("参加者");

  // entitiesが初期化されたタイミングで関数を実行
  const unlisten = scheduleDateItem.onParticipantsUpdated(function () {
    console.log("ParticipantsUpdated");
    unlisten(); // 解除
  });
});

setParticipantAdded

指定したステータスについて id を指定して参加者を追加します。

構文

setParticipantAdded(id, state);

引数

id

参加者の id を示す文字列です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、参加者に追加されます。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames.length); // 2

  scheduleDateItem.setParticipantAdded(1);

  console.log(scheduleDateItem.participantNames.length); // 3
});

setParticipantRemoved

指定したステータスについて id を指定して参加者を削除します。

構文

setParticipantRemoved(id, state);

引数

id

参加者の id を示す文字列です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、参加者にから削除されます。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames.length); // 2

  scheduleDateItem.setParticipantRemoved(1);

  console.log(scheduleDateItem.participantNames.length); // 1
});

setParticipantsEmpty

指定したステータスの参加者についてすべて削除します。

構文

setParticipantsEmpty(state);

引数

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全て削除されます。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.participantNames.length); // 2

  scheduleDateItem.setParticipantsEmpty();

  console.log(scheduleDateItem.participantNames.length); // 0
});

setDate

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

構文

setDate(date);

引数

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

返値

なし

例

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

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

  // 値を変更
  scheduleDateItem.setDate("2024/12/31");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.date); // 変更後: "2024/12/31"
});

setYear

数値を受け取り、year の値を変更します。

構文

setYear(year);

引数

year
年を示す数値です。

返値

なし

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.year); // 初期値: 2024

  // 値を変更
  scheduleDateItem.setYear(2025);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.year); // 変更後: 2025
});

setMonth

数値を受け取り、month の値を変更します。

構文

setMonth(month);

引数

month
月を示す数値です。

返値

なし

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.month); // 初期値: 12

  // 値を変更
  scheduleDateItem.setMonth(11);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.month); // 変更後: 11
});

setDay

数値を受け取り、day の値を変更します。

構文

setDay(day);

引数

day
日を表す数値です。

返値

なし

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.day); // 初期値: 18

  // 値を変更
  scheduleDateItem.setDay(20);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.day); // 変更後: 20
});

isFulfilled

正しい日付が入力されているかどうかの真偽値を返します。

構文

isFulfilled();

引数

なし

返値

真偽値

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.date); // 初期値: hoge

  const result = scheduleDateItem.isFulfilled();

  console.log("正しい日付か:", result); // 正しい日付かfalse
});

isEmpty

日付が入力されていないかどうかの真偽値を返します。

構文

isEmpty();

引数

なし

返値

真偽値

例

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

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.date); // 初期値: ''

  const result = scheduleDateItem.isEmpty();

  console.log("日付が空かどうか:", result); // 日付が空かどうか:true
});

isBefore

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

構文

isBefore(date);

引数

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

返値

真偽値

例

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

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

  const result = scheduleDateItem.isBefore("2024/12/20");

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

isAfter

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

構文

isAfter(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  s;

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

  const result = scheduleDateItem.isAfter("2024/12/20");

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

isBetween

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

構文

isBetween(beforeDate, afterDate);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.date); // 初期値: 2024/12/18

  const result = scheduleDateItem.isBetween("2024/12/15", "2024/12/20");

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

setAllDay

真偽値を受け取り、allDayの値を変更します。

構文

setAllDay(boolean);

引数

boolean
変更する allDay の真偽値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.allDay); // 初期値: false

  // 値を変更
  scheduleDateItem.setAllDay(true);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.allDay); // 変更後: true
});

isAllDay

終日の予定かどうかの真偽値を返します。

構文

isAllDay();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.allDay); // 初期値: false

  const result = scheduleDateItem.isAllDay();

  // 変更後の値を確認
  console.log("結果:", result); // 結果:: false
});

rangeSpanOverDays

beginDatetimeとendDatetime が日をまたいでいるかどうかを判定します。

構文

rangeSpanOverDays();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18"
  console.log("endDate:", scheduleDateItem.beginDatetime); // endDate: "2024/12/19"

  const result = scheduleDateItem.rangeSpanOverDays();

  // 変更後の値を確認
  console.log("日をまたいでいるかどうか:", result); // 日をまたいでいるかどうか: true
});

rangeIncludes

beginDatetimeとendDatetime の間に指定した日時が含まれているかを判定します。

構文

rangeIncludes(datetime);

引数

datetime
対象の日時 (YYYY/MM/DD HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18 12:00"
  console.log("endDate:", scheduleDateItem.endDatetime); // endDate: "2024/12/20 12:00"

  const result = scheduleDateItem.rangeIncludes("2024/12/19 12:00");

  console.log("対象日時が含まれているかどうか:", result); // 対象日時が含まれているかどうか: true
});

rangeLengthEqualsTo

beginDatetimeとendDatetime の差分が指定された数値と同じかどうかを判定します。
差分は切り捨てられます。例えばtypeにDAYを指定していて、beginDatetimeが2025/1/1 9:00でendDatetimeが2025/1/3 8:59の場合、差分は 1 となりrangeLengthEqualsTo(1, "DAY")はtrueとなります。

構文

rangeLengthEqualsTo(number);
rangeLengthEqualsTo(number, type);

引数

number
比較対象の数値です。

type
判定する時間の単位を指定します。以下のいずれかを選択してください:

• DAY (日)
• HOUR (時間)
• MINUTE (分)

デフォルトはDAYです。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18 12:00"
  console.log("endDate:", scheduleDateItem.endDatetime); // endDate: "2024/12/18 13:00"

  const result = scheduleDateItem.rangeLengthEqualsTo(60, "MINUTE");

  console.log("60分かどうか:", result); // 60分かどうか: true
});

rangeLengthIsGreaterThan

beginDatetimeとendDatetime の差分が指定した数値より大きいかどうかを判定します。
差分は切り捨てられます。例えばtypeにDAYを指定していて、beginDatetimeが2025/1/1 9:00でendDatetimeが2025/1/3 8:59の場合、差分は 1 となりrangeLengthIsGreaterThan(1, "DAY")はfalseとなります。

構文

rangeLengthIsGreaterThan(number);
rangeLengthIsGreaterThan(number, type);

引数

number
比較対象の数値です。

type
判定する時間の単位を指定します。以下のいずれかを選択してください:

• DAY (日)
• HOUR (時間)
• MINUTE (分)

デフォルトはDAYです。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18 12:00"
  console.log("endDate:", scheduleDateItem.endDatetime); // endDate: "2024/12/20 13:00"

  const result = scheduleDateItem.rangeLengthIsGreaterThan(30, "HOUR");

  console.log("30時間より大きいか:", result); // 30時間より大きいか: true
});

rangeLengthIsGreaterThanOrEqual

beginDatetimeとendDatetime の差分が指定した数値以上かどうかを判定します。
差分は切り捨てられます。例えばtypeにDAYを指定していて、beginDatetimeが2025/1/1 9:00でendDatetimeが2025/1/3 8:59の場合、差分は 1 となりrangeLengthIsGreaterThanOrEqual(2, "DAY")はfalseとなります。

構文

rangeLengthIsGreaterThanOrEqual(number);
rangeLengthIsGreaterThanOrEqual(number, type);

引数

number
比較対象の数値です。

type
判定する時間の単位を指定します。以下のいずれかを選択してください:

• DAY (日)
• HOUR (時間)
• MINUTE (分)

デフォルトはDAYです。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18 12:00"
  console.log("endDate:", scheduleDateItem.endDatetime); // endDate: "2024/12/20 13:00"

  const result = scheduleDateItem.rangeLengthIsGreaterThanOrEqual(30, "HOUR");

  console.log("30時間以上か:", result); // 30時間以上か: true
});

rangeLengthIsLessThan

beginDatetimeとendDatetime の差分が指定した数値より小さいかどうかを判定します。
差分は切り捨てられます。例えばtypeにDAYを指定していて、beginDatetimeが2025/1/1 9:00でendDatetimeが2025/1/3 8:59の場合、差分は 1 となりrangeLengthIsLessThan(1, "DAY")はfalseとなります。

構文

rangeLengthIsLessThan(number);
rangeLengthIsLessThan(number, type);

引数

number
比較対象の数値です。

type
判定する時間の単位を指定します。以下のいずれかを選択してください:

• DAY (日)
• HOUR (時間)
• MINUTE (分)

デフォルトはDAYです。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18 12:00"
  console.log("endDate:", scheduleDateItem.endDatetime); // endDate: "2024/12/20 12:00"

  const result = scheduleDateItem.rangeLengthIsLessThan(7);

  console.log("7日未満か:", result); // 7日未満か: true
});

rangeLengthIsLessThanOrEqual

beginDatetimeとendDatetime の差分が指定した数値以下かどうかを判定します。
差分は切り捨てられます。例えばtypeにDAYを指定していて、beginDatetimeが2025/1/1 9:00でendDatetimeが2025/1/3 8:59の場合、差分は 1 となりrangeLengthIsLessThanOrEqual(0, "DAY")はfalseとなります。

構文

rangeLengthIsLessThanOrEqual(number);
rangeLengthIsLessThanOrEqual(number, type);

引数

number
比較対象の数値です。

type
判定する時間の単位を指定します。以下のいずれかを選択してください:

• DAY (日)
• HOUR (時間)
• MINUTE (分)

デフォルトはDAYです。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("beginDate:", scheduleDateItem.beginDatetime); // beginDate: "2024/12/18 12:00"
  console.log("endDate:", scheduleDateItem.endDatetime); // endDate: "2024/12/20 12:00"

  const result = scheduleDateItem.rangeLengthIsLessThanOrEqual(7);

  console.log("7日以下か:", result); // 7日以下か: true
});

setBeginDatetime

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

構文

setBeginDatetime(dateTime);

引数

dateTime
YYYY/MM/DD HH:MM の形式の文字列です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: "2024/12/18 11:30"

  // 値を変更
  scheduleDateItem.setBeginDatetime("2024/12/31 11:40");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginDatetime); // 変更後: "2024/12/31 11:40"
});

beginDatetimeIsFulfilled

正しい日時が入力されているかどうかの真偽値を返します。

構文

beginDatetimeIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: hoge

  const result = scheduleDateItem.beginDatetimeIsFulfilled();

  console.log("正しい日時か:", result); // 正しい日時かfalse
});

beginDatetimeIsEmpty

日時が入力されていないかどうかの真偽値を返します。

構文

beginDatetimeIsEmpty();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: ''

  const result = scheduleDateItem.beginDatetimeIsEmpty();

  console.log("日時が空かどうか:", result); // 日時が空かどうか:true
});

beginDatetimeIsBefore

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

構文

beginDatetimeIsBefore(dateTime);

引数

dateTime
比較対象の日時 (YYYY/MM/DD HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: 2024/12/18  12:40

  const result = scheduleDateItem.beginDatetimeIsBefore("2024/12/20 12:40");

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

beginDatetimeIsAfter

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

構文

beginDatetimeIsAfter(dateTime);

引数

dateTime
比較対象の日時 (YYYY/MM/DD HH:MM の形式)。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: 2024/12/18  12:40

  const result = scheduleDateItem.beginDatetimeIsAfter("2024/12/20  12:40");

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

beginDatetimeIsBetween

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

構文

beginDatetimeIsBetween(beforeDatedTime, afterDateTime);

引数

beforeDateTime
範囲の開始日 (YYYY/MM/DD HH:MM の形式)
afterDateTime
範囲の終了日 (YYYY/MM/DD HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDatetime); // 初期値: 2024/12/18  12:40

  const result = scheduleDateItem.beginDatetimeIsBetween(
    "2024/12/15 12:40",
    "2024/12/20 12:50"
  );

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

setBeginDate

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

構文

setBeginDate(date);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  // 値を変更
  scheduleDateItem.setBeginDate("2024/12/31");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginDate); // 変更後: "2024/12/31"
});

setBeginYear

数値を受け取り、beginYear の値を変更します。

構文

setBeginYear(year);

引数

year
年を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginYear); // 初期値: 2024

  // 値を変更
  scheduleDateItem.setBeginYear(2025);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginYear); // 変更後: 2025
});

setBeginMonth

数値を受け取り、beginMonth の値を変更します。

構文

setBeginMonth(month);

引数

month
月を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginMonth); // 初期値: 12

  // 値を変更
  scheduleDateItem.setBeginMonth(11);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginMonth); // 変更後: 11
});

setBeginDay

数値を受け取り、beginDay の値を変更します。

構文

setBeginDay(day);

引数

day
日を表す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDay); // 初期値: 18

  // 値を変更
  scheduleDateItem.setBeginDay(20);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginDay); // 変更後: 20
});

beginDateIsEmpty

正しい日付が入力されているかどうかの真偽値を返します。

構文

beginDateIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDate); // 初期値: hoge

  const result = scheduleDateItem.beginDateIsFulfilled();

  console.log("正しい日付か:", result); // 正しい日付かfalse
});

beginDateIsFulfilled

日付が入力されていないかどうかの真偽値を返します。

構文

beginDateIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDate); // 初期値: ''

  const result = scheduleDateItem.beginDateIsFulfilled();

  console.log("日付が空かどうか:", result); // 日付が空かどうか:true
});

beginDateIsBefore

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

構文

beginDateIsBefore(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  const result = scheduleDateItem.beginDateIsBefore("2024/12/20");

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

beginDateIsAfter

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

構文

beginDateIsAfter(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  const result = scheduleDateItem.beginDateIsAfter("2024/12/20");

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

beginDateIsBetween

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

構文

beginDateIsBetween(beforeDate, afterDate);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginDate); // 初期値: 2024/12/18

  const result = scheduleDateItem.beginDateIsBetween(
    "2024/12/15",
    "2024/12/20"
  );

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

setBeginTime

HH:MM の形式の文字列を受け取り、beginTimeの値を変更します。

構文

setBeginTime(time);

引数

time
HH:MM の形式の文字列です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: "11:30"

  // 値を変更
  scheduleDateItem.setBeginTime("12:30");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginTime); // 変更後: "12:30"
});

setBeginHour

数値を受け取り、beginHourの値を変更します。

構文

setBeginHour(hour);

引数

hour
時を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginHour); // 初期値: 11

  // 値を変更
  scheduleDateItem.setBeginHour(12);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginHour); // 変更後: 12
});

setBeginMinute

数値を受け取り、beginMinuteの値を変更します。

構文

setBeginMinute(minute);

引数

minute
分を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginMinute); // 初期値: 30

  // 値を変更
  scheduleDateItem.setBeginMinute(40);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.beginMinute); // 変更後: 40
});

beginTimeIsFulfilled

正しい時間が入力されているかどうかの真偽値を返します。

構文

beginTimeIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: hoge

  const result = scheduleDateItem.beginTimeIsFulfilled();

  console.log("正しい時間か:", result); // 正しい時間かfalse
});

beginTimeIsEmpty

時間が入力されていないかどうかの真偽値を返します。

構文

beginTimeIsEmpty();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: ''

  const result = scheduleDateItem.beginTimeIsEmpty();

  console.log("時間が空かどうか:", result); // 時間が空かどうか:true
});

beginTimeIsBefore

beginTime が指定した時間より前の時間かどうかの真偽値を返します。

構文

beginTimeIsBefore(time);

引数

time
比較対象の時間 (HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: 12:30

  const result = scheduleDateItem.beginTimeIsBefore("12:40");

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

beginTimeIsAfter

beginTime が指定した時間より後の時間かどうかの真偽値を返します。

構文

beginTimeIsAfter(time);

引数

time
比較対象の時間 (HH:MM の形式)。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: 12:30

  const result = scheduleDateItem.beginTimeIsAfter("12:40");

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

beginTimeIsBetween

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

構文

beginTimeIsBetween(beforeTime, afterTime);

引数

beforeTime
範囲の開始時間 (HH:MM の形式)
afterTime
範囲の終了時間 (HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.beginTime); // 初期値: 12:30

  const result = scheduleDateItem.beginTimeIsBetween("12:35", "12:40");

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

setEndDatetime

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

構文

setEndDatetime(dateTime);

引数

dateTime
YYYY/MM/DD HH:MM の形式の文字列です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: "2024/12/18 11:30"

  // 値を変更
  scheduleDateItem.setEndDatetime("2024/12/31 11:40");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endDatetime); // 変更後: "2024/12/31 11:40"
});

endDatetimeIsFulfilled

正しい日時が入力されているかどうかの真偽値を返します。

構文

endDatetimeIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: hoge

  const result = scheduleDateItem.endDatetimeIsFulfilled();

  console.log("正しい日時か:", result); // 正しい日時かfalse
});

endDatetimeIsEmpty

日時が入力されていないかどうかの真偽値を返します。

構文

endDatetimeIsEmpty();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: ''

  const result = scheduleDateItem.endDatetimeIsEmpty();

  console.log("日時が空かどうか:", result); // 日時が空かどうか:true
});

endDatetimeIsBefore

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

構文

endDatetimeIsBefore(dateTime);

引数

dateTime
比較対象の日時 (YYYY/MM/DD HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: 2024/12/18  12:40

  const result = scheduleDateItem.endDatetimeIsBefore("2024/12/20 12:40");

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

endDatetimeIsAfter

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

構文

endDatetimeIsAfter(dateTime);

引数

dateTime
比較対象の日時 (YYYY/MM/DD HH:MM の形式)。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: 2024/12/18  12:40

  const result = scheduleDateItem.endDatetimeIsAfter("2024/12/20  12:40");

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

endDatetimeIsBetween

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

構文

endDatetimeIsBetween(beforeDatedTime, afterDateTime);

引数

beforeDateTime
範囲の開始日 (YYYY/MM/DD HH:MM の形式)
afterDateTime
範囲の終了日 (YYYY/MM/DD HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDatetime); // 初期値: 2024/12/18  12:40

  const result = scheduleDateItem.endDatetimeIsBetween(
    "2024/12/15 12:40",
    "2024/12/20 12:50"
  );

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

setEndDate

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

構文

setEndDate(date);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  // 値を変更
  scheduleDateItem.setEndDate("2024/12/31");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endDate); // 変更後: "2024/12/31"
});

setEndYear

数値を受け取り、endYear の値を変更します。

構文

setEndYear(endYear);

引数

endYear
年を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endYear); // 初期値: 2024

  // 値を変更
  scheduleDateItem.setEndYear(2025);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endYear); // 変更後: 2025
});

setEndMonth

数値を受け取り、endMonth の値を変更します。

構文

setEndMonth(endMonth);

引数

endMonth
月を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endMonth); // 初期値: 12

  // 値を変更
  scheduleDateItem.setEndMonth(11);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endMonth); // 変更後: 11
});

setEndDay

数値を受け取り、endDay の値を変更します。

構文

setEndDay(endDay);

引数

endDay
日を表す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDay); // 初期値: 18

  // 値を変更
  scheduleDateItem.setEndDay(20);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endDay); // 変更後: 20
});

endDateIsFulfilled

正しい日付が入力されているかどうかの真偽値を返します。

構文

endDateIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDate); // 初期値: hoge

  const result = scheduleDateItem.endDateIsFulfilled();

  console.log("正しい日付か:", result); // 正しい日付かfalse
});

endDateIsEmpty

日付が入力されていないかどうかの真偽値を返します。

構文

endDateIsEmpty();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDate); // 初期値: ''

  const result = scheduleDateItem.endDateIsEmpty();

  console.log("日付が空かどうか:", result); // 日付が空かどうか:true
});

endDateIsBefore

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

構文

endDateIsBefore(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  const result = scheduleDateItem.endDateIsBefore("2024/12/20");

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

endDateIsAfter

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

構文

endDateIsAfter(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

  const result = scheduleDateItem.endDateIsAfter("2024/12/20");

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

endDateIsBetween

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

構文

endDateIsBetween(beforeDate, afterDate);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endDate); // 初期値: 2024/12/18

  const result = scheduleDateItem.endDateIsBetween("2024/12/15", "2024/12/20");

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

setEndTime

HH:MM の形式の文字列を受け取り、endTimeの値を変更します。

構文

setEndTime(time);

引数

time
HH:MM の形式の文字列です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: "11:30"

  // 値を変更
  scheduleDateItem.setEndTime("12:30");

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endTime); // 変更後: "12:30"
});

setEndHour

数値を受け取り、endHourの値を変更します。

構文

setEndHour(hour);

引数

hour
時を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endHour); // 初期値: 11

  // 値を変更
  scheduleDateItem.setEndHour(12);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endHour); // 変更後: 12
});

setEndMinute

数値を受け取り、endMinuteの値を変更します。

構文

setEndMinute(minute);

引数

minute
分を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endMinute); // 初期値: 30

  // 値を変更
  scheduleDateItem.setEndMinute(40);

  // 変更後の値を確認
  console.log("変更後:", scheduleDateItem.endMinute); // 変更後: 40
});

endTimeIsFulfilled

正しい時間が入力されているかどうかの真偽値を返します。

構文

endTimeIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: hoge

  const result = scheduleDateItem.endTimeIsFulfilled();

  console.log("正しい時間か:", result); // 正しい時間かfalse
});

endTimeIsEmpty

時間が入力されていないかどうかの真偽値を返します。

構文

endTimeIsEmpty();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: ''

  const result = scheduleDateItem.endTimeIsEmpty();

  console.log("時間が空かどうか:", result); // 時間が空かどうか:true
});

endTimeIsBefore

endTime が指定した時間より前の時間かどうかの真偽値を返します。

構文

endTimeIsBefore(time);

引数

time
比較対象の時間 (HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: 12:30

  const result = scheduleDateItem.endTimeIsBefore("12:40");

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

endTimeIsAfter

endTime が指定した時間より後の時間かどうかの真偽値を返します。

構文

endTimeIsAfter(time);

引数

time
比較対象の時間 (HH:MM の形式)。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: 12:30

  const result = scheduleDateItem.endTimeIsAfter("12:40");

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

endTimeIsBetween

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

構文

endTimeIsBetween(beforeTime, afterTime);

引数

beforeTime
範囲の開始時間 (HH:MM の形式)
afterTime
範囲の終了時間 (HH:MM の形式)

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", scheduleDateItem.endTime); // 初期値: 12:30

  const result = scheduleDateItem.endTimeIsBetween("12:35", "12:40");

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

isReferable

スケジュールの参照権限があるかないかを判定します。

構文

isReferable();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.isReferable()); // true
});

hasNoRegistration

スケジュールを登録するかどうかを判定します。

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scheduleDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(scheduleDateItem.hasNoRegistration()); // true
});

setNoRegistration

真偽値を受け取り、noRegistrationを変更します。

構文

setNoRegistration(v);

引数

v

スケジュールを登録するかどうかの真偽値です。

返値

真偽値

例

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

  scheduleDateItem.setNoRegistration(true);

  console.log(scheduleDateItem.hasNoRegistration()); // true
});

関連情報

• SheetItem
• SheetSaveScreen