TaskItem

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

継承

SheetItem

インスタンスプロパティ

taskName

入力されているタスクの名前です。

例

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

  // 初期値を確認
  console.log("初期値:", taskDateItem.taskName); // 初期値: タスク１

  // 値を変更
  taskDateItem.taskName = "タスク２";

  // 変更後の値を確認
  console.log("変更後:", taskDateItem.taskName); // 変更後: タスク２
});

taskNameLength

入力されているタスクの名前の文字数です。

例

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

  console.log("初期値:", taskDateItem.taskName); // 初期値: タスク１

  console.log("変更後:", taskDateItem.taskNameLength); // 変更後: 4
});

priority

優先度の ID を示す数値です。

例

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

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

  // 値を変更
  taskDateItem.status = 2;

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

priorityChoices

タスクの優先度の選択肢です。

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screeSheetSaveScreenn) => {
    const taskDateItem = SheetSaveScreen.getSheetItem(
      "customers.customer.type_date1"
    );
    //選択肢を確認
    console.log(taskDateItem.priorityChoices); // [{ selectName:"高",value:1 },{ label:"低",value:2 }]
  });

priorityLabel読み取り専用

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(taskDateItem.priorityChoices); // [{ selectName:"高",selectValue:1 },{ selectName:"低",selectValue:2 }]

  // IDを確認
  console.log("ID:", taskDateItem.priority); // ID: 1

  // 表示名を確認
  console.log("表示名:", taskDateItem.priorityLabel); // 表示名: 高
});

priorityLabelLength読み取り専用

priorityLabel の文字数を表します。

例

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

  // 表示名を確認
  console.log("表示名:", taskDateItem.priorityLabel); // 表示名: 高

  console.log("長さ:", taskDateItem.priorityLabelLength); // 長さ: 1
});

assigneeNames

紐づいている各シートの名前の配列です。

例

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

  console.log("紐づいているシートの名前の配列", taskDateItem.assigneeNames); // 紐づいているシートの名前の配列: "[高橋, 佐藤, 近藤, 斎藤]"
});

assigneeLength

紐づいていシート数の数値です。

例

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

  console.log("紐づいているシートの名前の配列", taskDateItem.assigneeNames); // 紐づいているシートの名前の配列: "[高橋, 佐藤, 近藤, 斎藤]"

  console.log("紐づいているシートの数：", taskDateItem.assigneeLength); // 紐づいているシートの数：４
});

noRegistration

タスクを登録するかどうかの真偽値です。

例

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

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

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

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

date

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

例

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

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

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

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

year

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

例

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

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

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

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

month

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

例

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

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

  // 値を変更
  taskDateItem.setMonth(12);

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

day

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

例

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

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

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

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

referable

タスクの参照権限が歩かないかを示す真偽値です。

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

インスタンスメソッド

setPriority

priorityの値を変更します。

構文

setPriority(id);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(taskDateItem.choices); // [{ selectName:"高",value:1 },{ label:"低",value:2 }]

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

  // 値を変更
  taskDateItem.setPriority(2);

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

setPriorityByLabel

構文

setPriorityByLabel(label);

引数

'label'選択する値の label です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  //選択肢を確認
  console.log(taskDateItem.choices); // [{ selectName:"高",value:1 },{ label:"低",value:2 }]

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

  // 値を変更
  taskDateItem.setPriorityByLabel("低");

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

priorityEqualsTo

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

構文

priorityEqualsTo(id);

引数

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

返値

真偽値

例

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

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

  const result = priorityEqualsTo(1);

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

priorityLabelEqualsTo

構文

priorityLabelEqualsTo(label);

引数

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

返値

真偽値

例

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

  // 初期値を確認
  console.log("初期値:", taskDateItem.priorityLabel); // 初期値: 高

  const result = priorityLabelEqualsTo("高");

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

priorityLabelLengthEqualsTo

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

構文

priorityLabelLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const result = taskDateItem.priorityLabelLengthEqualsTo(7);

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

priorityLabelLengthIsGreaterThan

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

構文

priorityLabelLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const result = taskDateItem.priorityLabelLengthIsGreaterThan(6);

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

priorityLabelLengthIsGreaterThanOrEqual

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

構文

priorityLabelLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const result = taskDateItem.priorityLabelLengthIsGreaterThanOrEqual(6);

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

priorityLabelLengthIsLessThan

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

構文

priorityLabelLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const result = taskDateItem.priorityLabelLengthIsLessThan(10);

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

priorityLabelLengthIsLessThanOrEqual

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

構文

priorityLabelLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  const result = taskDateItem.priorityLabelLengthIsLessThanOrEqual(8);

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

priorityLabelContains

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

構文

priorityLabelContains(substring);

引数

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

返値

真偽値

例

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

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

setTaskName

taskNameの値を変更します。

構文

setTaskName(taskName);

引数

taskName

タスク名を示す文字列です。

返値

なし

例

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

  // 初期値を確認
  console.log("初期値:", taskDateItem.taskName); // 初期値: "トラブルシューティング"

  // 値を変更
  taskDateItem.setTaskName("既存顧客フォローアップ");

  // 変更後の値を確認
  console.log("変更後:", taskDateItem.taskName); // 変更後: "既存顧客フォローアップ"
});

taskNameLengthEqualsTo

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

構文

taskNameLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.taskNameLengthEqualsTo(7);

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

taskNameLengthIsGreaterThan

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

構文

taskNameLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.taskNameLengthIsGreaterThan(6);

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

taskNameLengthIsGreaterThanOrEqual

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

構文

taskNameLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.taskNameLengthIsGreaterThanOrEqual(8);

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

taskNameLengthIsLessThan

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

構文

taskNameLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.taskNameLengthIsLessThan(10);

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

taskNameLengthIsLessThanOrEqual

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

構文

taskNameLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

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

  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.taskNameLengthIsLessThanOrEqual(8);

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

taskNameContains

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

構文

taskNameContains(substring);

引数

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

返値

真偽値

例

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

  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.memoContains("対応");
  console.log(result); // true
});

taskNameEqualsTo

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

構文

taskNameEqualsTo(string);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  console.log(taskDateItem.taskName); // "問い合わせ対応"

  const result = taskDateItem.taskNameEqualsTo("問い合わせ対応");
  console.log(result); // true
});

setDate

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

構文

setDate(date);

引数

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

返値

なし

例

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

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

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

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

setYear

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

構文

setYear(year);

引数

year
年を示す数値です。

返値

なし

例

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

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

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

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

setMonth

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

構文

setMonth(month);

引数

month
月を示す数値です。

返値

なし

例

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

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

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

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

setDay

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

構文

setDay(day);

引数

day
日を表す数値です。

返値

なし

例

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

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

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

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

isFulfilled

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

構文

isFulfilled();

引数

なし

返値

真偽値

例

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

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

  const result = taskDateItem.isFulfilled();

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

isEmpty

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

構文

isEmpty();

引数

なし

返値

真偽値

例

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

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

  const result = taskDateItem.isEmpty();

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

isBefore

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

構文

isBefore(date);

引数

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

返値

真偽値

例

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

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

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

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

isAfter

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

構文

isAfter(date);

引数

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

返値

真偽値

例

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

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

  const result = taskDateItem.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 taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );
  // 初期値を確認
  console.log("初期値:", taskDateItem.date); // 初期値: 2024/12/18

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

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

assigneesInclude

id を示す数値を受け取り、紐づいているシートに指定した id が含まれているかどうかの真偽値を返します。

構文

assigneesInclude(id);

引数

id
シートの ID を示す数値です。

返値

真偽値

例

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

  console.log(
    "assignees:",
    taskDateItem.assignees
      .getRows()
      .entries.map((assignee) => assignee.assigneeId)
  ); // assignees: [1,2,3,4,5]

  const result = taskDateItem.assigneesInclude(1);

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

assigneeNamesInclude

文字列を受け取り、紐づいているシートの名前項目の値に指定した文字列が含まれているかどうかの真偽値を返します。

構文

assigneeNamesInclude(taskName);

引数

taskName
シートの名前を示す文字列です。

返値

真偽値

例

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

  console.log(taskDateItem.assigneeNames); // assignees: ["佐藤","鈴木"]

  const result = taskDateItem.assigneeNamesInclude("佐藤");

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

includesNonReferableAssignee

紐づいているシートに閲覧権限のないシートが含まれているかどうかを判定します。

構文

includesNonReferableAssignee();

引数

なし

返値

真偽値

例

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

  console.log(
    "assignees:",
    taskDateItem.assignees
      .getRows()
      .entries.map((assignee) => assignee.assigneeId)
  ); // assignees: [1,2,NaN,4,5]

  const result = taskDateItem.includesNonReferableAssignee();

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

onAssigneeAdded

紐づいているシートが追加された後に呼び出されるeventHookを登録します。

構文

onAssigneeAdded(callback);
onAssigneeAdded(callback, group);

引数

callback

紐づいているシートが追加されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  const unlisten = taskDateItem.onAssigneeAdded(function () {
    console.log("AssigneeAdded");
    unlisten(); // 解除
  });
});

onAssigneeRemoved

紐づいているシートが削除された後に呼び出されるeventHookを登録します。

構文

onAssigneeRemoved(callback);
onAssigneeRemoved(callback, group);

引数

callback

紐づいているシートが削除されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  const unlisten = taskDateItem.onAssigneeRemoved(function () {
    console.log("AssigneeRemoved");
    unlisten(); // 解除
  });
});

onAssigneesUpdated

紐づいているシートが更新された後に呼び出されるeventHookを登録します。

構文

onAssigneesUpdated(callback);
onAssigneesUpdated(callback, group);

引数

callback

紐づいているシートが更新されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

onAssigneesResolved

紐づいているシートのデータが解決された後に呼び出されるeventHookを登録します。

構文

onAssigneesResolved(callback);
onAssigneesResolved(callback, group);

引数

callback

紐づいているシートが解決されたタイミングで実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

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

getAssignees

Selectionsクラスのインスタンスを返します。

構文

getAssignees();

引数

なし

返値

Selectionsクラスのインスタンス

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

  console.log(taskDateItem.getAssignees());
  
});

getAssigneeBy

指定した ID のSelectionクラスのインスタンスを返します。

構文

getAssignees(ID);

引数

ID

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

返値

Selectionクラスのインスタンス

例

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

  const Assignee = taskDateItem.getAssigneeBy(1);

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

getAssigneeByIndex

指定した行のSelectionクラスのインスタンスを返します。

構文

getAssigneeByIndex(index);

引数

index

紐づいているシートが何行目かを示す数値です。

返値

Selectionクラスのインスタンス

例

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

  const Assignee = taskDateItem.getAssigneeByIndex(1);

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

setAssigneesEmpty

紐づいているシートを全て削除します。

構文

setAssigneesEmpty();

引数

なし

返値

なし

例

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

  console.log(taskDateItem.assigneeLength);
  // 3

  taskDateItem.setAssigneesEmpty();

  console.log(taskDateItem.assigneeLength);
  // ０
});

setAssigneeAdded

entityId を指定して、紐づいているシートを追加します。

構文

setAssigneeAdded(entityId);

引数

entityId

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

返値

なし

例

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

  console.log(taskDateItem.assigneeLength);
  // 3

  taskDateItem.setAssigneeAdded(1);

  console.log(taskDateItem.assigneeLength);
  // 4
});

setAssigneeRemoved

指定した entityId の紐づいているシートを削除します。

構文

setAssigneeRemoved(entityId);

引数

entityId

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

返値

なし

例

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

  console.log(taskDateItem.assigneeLength);
  // 3

  taskDateItem.setAssigneeRemoved(1);

  console.log(taskDateItem.assigneeLength);
  // 2
});

setAssigneeRemovedByIndex

指定した index の紐づいているシートを削除します。

構文

setAssigneeRemovedByIndex(index);

引数

index

何行目かの紐づいているシートを示す数値です。

返値

なし

例

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

  console.log(taskDateItem.assigneeLength);
  // 3

  taskDateItem.setAssigneeRemovedByIndex(1);

  console.log(taskDateItem.assigneeLength);
  // 2
});

assigneeLengthEqualsTo

assigneeLengthが指定した数値と等しいかどうかを判定します。

構文

assigneeLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  taskDateItem.onUpdated(function () {
    // 値を確認
    console.log("値:", taskDateItem.assigneeLength); // 値: 7

    const result = taskDateItem.assigneeLengthEqualsTo(7);

    console.log("7と等しいかどうか:", result); // 7と等しいかどうか: true
  });
});

assigneeLengthIsGreaterThan

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

構文

assigneeLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  taskDateItem.onUpdated(function () {
    // 値を確認
    console.log("値:", taskDateItem.assigneeLength); // 値: 7

    const result = taskDateItem.assigneeLengthIsGreaterThan(6);

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

assigneeLengthIsGreaterThanOrEqual

assigneeLengthが指定した数値以上かどうかを判定します。

構文

assigneeLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  taskDateItem.onUpdated(function () {
    // 値を確認
    console.log("値:", taskDateItem.assigneeLength); // 値: 7

    const result = taskDateItem.assigneeLengthIsGreaterThanOrEqual(6);

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

assigneeLengthIsLessThan

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

構文

assigneeLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  taskDateItem.onUpdated(function () {
    // 値を確認
    console.log("値:", taskDateItem.assigneeLength); // 値: 7

    const result = taskDateItem.assigneeLengthIsLessThan(10);

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

assigneeLengthIsLessThanOrEqual

assigneeLengthが指定した数値以下かどうかを判定します。

構文

assigneeLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const taskDateItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_date1"
  );

  taskDateItem.onUpdated(function () {
    // 値を確認
    console.log("値:", taskDateItem.assigneeLength); // 値: 7

    const result = taskDateItem.assigneeLengthIsLessThanOrEqual(8);

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

isReferable

タスクの参照権限があるかないかを判定します。

構文

isReferable();

引数

なし

返値

真偽値

例

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

hasNoRegistration

タスクを登録するかどうかを判定します。

引数

なし

返値

真偽値

例

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

setNoRegistration

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

構文

setNoRegistration(v);

引数

v

タスクを登録するかどうかの真偽値です。

返値

真偽値

例

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

  console.log(taskDateItem.hasNoRegistration()); // false

  taskDateItem.setNoRegistration(true);

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

関連情報

• SheetItem