Milestone

Milestone クラスはシナリオ項目内の各マイルストーン対して操作を行うためのメンバーを持っています。

継承

Target

インスタンスプロパティ

name

マイルストーン名を示す文字列です。

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.name = "既存顧客フォローアップ";

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

nameLength

マイルストーン名の文字数を示す数値です。

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "トラブルシューティング"

  console.log(milestone.nameLength); // 11
});

memo

メモを示す文字列です。

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  // 初期値を確認
  console.log("初期値:", milestone.memo); // 初期値: ""

  // 値を変更
  milestone.memo = "次回の日程を登録";

  // 変更後の値を確認
  console.log("変更後:", milestone.memo); // 変更後: "次回の日程を登録"
});

memoLength

マイルストーン名の文字数を示す数値です。

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); //"次回の日程を登録"

  console.log(milestone.nameLength); // 8
});

statusChoices

マイルストーンとシナリオの優先度の選択肢です。

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  console.log(scenarioItem.statusChoices); //
});

status

ステータスの ID を示す数値です。

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

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

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

statusLabel読み取り専用

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

例

esmJSPlugin.sheetSave("customer").onMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  //選択肢を確認
  console.log(milestone.statusChoices); // [{ selectName:"完了",selectValue:1 },{ selectName:"未完了",selectValue:2 }]

  // IDを確認
  console.log("ID:", milestone.status); // ID: 1

  // 表示名を確認
  console.log("表示名:", milestone.statusLabel); // 表示名: 完了
});

statusLabelLength読み取り専用

statusLabel の文字数を表します。

例

esmJSPlugin.sheetSave("customer").onMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  // 表示名を確認
  console.log("表示名:", milestone.statusLabel); // 表示名: 完了

  console.log("長さ:", milestone.statusLabel); // 長さ: 2
});

completionDate

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

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.completionDate = "2024/12/31";

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

completionYear

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

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestoneItem = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.completionYear = 2025;

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

completionMonth

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

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.completionMonth = 12;

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

completionDay

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

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.completionDay = 31;

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

assigneeNames

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

assigneeLength

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

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

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

インスタンスメソッド

setName

nameの値を変更します。

構文

setName(name);

引数

name

マイルストーン名を示す文字列です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

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

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

nameLengthEqualsTo

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

構文

nameLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "問い合わせ対応"

  const result = milestone.nameLengthEqualsTo(7);

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

nameLengthIsGreaterThan

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

構文

nameLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "問い合わせ対応"

  const result = milestone.nameLengthIsGreaterThan(6);

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

nameLengthIsGreaterThanOrEqual

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

構文

nameLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "問い合わせ対応"

  const result = milestone.nameLengthIsGreaterThanOrEqual(6);

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

nameLengthIsLessThan

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

構文

nameLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "問い合わせ対応"

  const result = milestone.nameLengthIsLessThan(10);

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

nameLengthIsLessThanOrEqual

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

構文

nameLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "問い合わせ対応"

  const result = milestone.nameLengthIsLessThanOrEqual(8);

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

nameContains

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

構文

nameContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.name); // "問い合わせ対応"

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

nameEqualsTo

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

構文

nameEqualsTo(string);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = SheetSaveScreen.getSheetItem((
    "customers.customer.customer_name"
  );
  const milestone = scenarioItem.getMilestones().entities[0];
  console.log(milestone.name); // "問い合わせ対応"

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

setMemo

memoの値を変更します。

構文

setMemo(memo);

引数

memo

マイルストーン名を示す文字列です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

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

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

memoLengthEqualsTo

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

構文

memoLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); // "問い合わせ対応"

  const result = milestone.memoLengthEqualsTo(7);

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

memoLengthIsGreaterThan

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

構文

memoLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); // "問い合わせ対応"

  const result = milestone.memoLengthIsGreaterThan(6);

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

memoLengthIsGreaterThanOrEqual

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

構文

memoLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); // "問い合わせ対応"

  const result = milestone.memoLengthIsGreaterThanOrEqual(6);

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

memoLengthIsLessThan

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

構文

memoLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); // "問い合わせ対応"

  const result = milestone.memoLengthIsLessThan(10);

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

memoLengthIsLessThanOrEqual

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

構文

memoLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); // "問い合わせ対応"

  const result = milestone.memoLengthIsLessThanOrEqual(8);

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

memoContains

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

構文

memoContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  console.log(milestone.memo); // "問い合わせ対応"

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

memoEqualsTo

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

構文

memoEqualsTo(string);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = SheetSaveScreen.getSheetItem((
    "customers.customer.customer_memo"
  );
  const milestone = scenarioItem.getMilestones().entities[0];
  console.log(milestone.name); // "問い合わせ対応"

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

setCompletionDate

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

構文

setCompletionDate(date);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.setCompletionDate("2024/12/31");

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

setCompletionYear

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

構文

setCompletionYear(year);

引数

year
年を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.setCompletionYear(2025);

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

setCompletionMonth

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

構文

setCompletionMonth(month);

引数

month
月を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.setCompletionMonth(11);

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

setCompletionDay

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

構文

setCompletionDay(day);

引数

day
日を表す数値です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  // 値を変更
  milestone.setCompletionDay(20);

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

completionDateIsFulfilled

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

構文

completionDateIsFulfilled();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  const result = milestone.completionDateIsFulfilled();

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

completionDateIsEmpty

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

構文

completionDateIsEmpty();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  const result = milestone.completionDateIsEmpty();

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

completionDateIsBefore

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

構文

completionDateIsBefore(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  const result = milestone.completionDateIsBefore("2024/12/20");

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

completionDateIsAfter

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

構文

completionDateIsAfter(date);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  const result = milestone.completionDateIsAfter("2024/12/20");

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

completionDateIsBetween

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

構文

completionDateIsBetween(beforeDate, afterDate);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.completionDate); // 初期値: 2024/12/18

  const result = milestone.completionDateIsBetween("2024/12/15", "2024/12/20");

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

setStatus

statusの値を変更します。

構文

setStatus(id);

引数

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

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  //選択肢を確認
  console.log(milestone.choices); // [{ selectName:"完了",selectValue:1 },{ selectName:"未完了",selectValue:2 }]

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

  // 値を変更
  milestone.setStatus(2);

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

setStatusByLabel

構文

setStatusByLabel(label);

引数

label
選択する値の label です。

返値

なし

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  //選択肢を確認
  console.log(milestone.choices); // [{ selectName:"完了",selectValue:1 },{ selectName:"未完了",selectValue:2 }]

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

  // 値を変更
  milestone.setStatusByLabel("未完了");

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

statusEqualsTo

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

構文

statusEqualsTo(id);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  const result = statusEqualsTo(1);

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

statusLabelEqualsTo

構文

statusLabelEqualsTo(label);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: 完了

  const result = statusLabelEqualsTo("完了");

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

statusLabelLengthEqualsTo

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

構文

statusLabelLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: "完了"

  const result = milestone.statusLabelLengthEqualsTo(7);

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

statusLabelLengthIsGreaterThan

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

構文

statusLabelLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: "完了"

  const result = milestone.statusLabelLengthIsGreaterThan(6);

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

statusLabelLengthIsGreaterThanOrEqual

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

構文

statusLabelLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: "完了"

  const result = milestone.statusLabelLengthIsGreaterThanOrEqual(6);

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

statusLabelLengthIsLessThan

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

構文

statusLabelLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: "完了"

  const result = milestone.statusLabelLengthIsLessThan(10);

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

statusLabelLengthIsLessThanOrEqual

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

構文

statusLabelLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: "完了"

  const result = milestone.statusLabelLengthIsLessThanOrEqual(8);

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

statusLabelContains

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

構文

statusLabelContains(substring);

引数

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

返値

真偽値

例

esmJSPlugin.sheetSave("customer").onSheetItemsMounted((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];
  // 初期値を確認
  console.log("初期値:", milestone.statusLabel); // 初期値: "完了"

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

assigneesInclude

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

構文

assigneesInclude(id);

引数

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

返値

真偽値

例

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

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

  const result = milestone.assigneesInclude(1);

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

assigneeNamesInclude

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

構文

assigneesInclude(name);

引数

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

返値

真偽値

例

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

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

  const result = milestone.assigneesInclude("佐藤");

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

includesNonReferableAssignee

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

構文

includesNonReferableAssignee();

引数

なし

返値

真偽値

例

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

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

  const result = milestone.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 scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  const unlisten = milestone.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 scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  const unlisten = milestone.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 scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  // entitiesが初期化されたタイミングで関数を実行
  const unlisten = milestone.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 scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

getAssignees

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

構文

getAssignees();

引数

なし

返値

Selectionsクラスのインスタンス

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

getAssigneeBy

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

構文

getAssigneeBy(ID);

引数

ID

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

返値

Selectionクラスのインスタンス

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  const Assignee = milestone.getAssigneeBy(1);

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

getAssigneeByIndex

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

構文

getAssigneeByIndex(index);

引数

index

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

返値

Selectionクラスのインスタンス

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

  const Assignee = milestone.getAssigneeByIndex(1);

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

setAssigneesEmpty

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

構文

setAssigneesEmpty();

引数

なし

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  milestone.setAssigneesEmpty();

  console.log(milestone.assigneeLength);
  // 0
});

setAssigneeAdded

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

構文

setAssigneeAdded(entityId);

引数

entityId

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

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  milestone.setAssigneeAdded(1);

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

setAssigneeRemoved

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

構文

setAssigneeRemoved(entityId);

引数

entityId

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

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  milestone.setAssigneeRemoved(1);

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

setAssigneeRemovedByIndex

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

構文

setAssigneeRemovedByIndex(index);

引数

index

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

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

  milestone.setAssigneeRemovedByIndex(1);

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

assigneeLengthEqualsTo

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

構文

assigneeLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

    const result = milestone.assigneeLengthEqulasTo(7);

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

assigneeLengthIsGreaterThan

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

構文

assigneeLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

    const result = milestone.assigneeLengthIsGreaterThan(6);

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

assigneeLengthIsGreaterThanOrEqual

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

構文

assigneeLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

    const result = milestone.assigneeLengthIsGreaterThanOrEqual(6);

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

assigneeLengthIsLessThan

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

構文

assigneeLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

    const result = milestone.assigneeLengthIsLessThan(10);

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

assigneeLengthIsLessThanOrEqual

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

構文

assigneeLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const scenarioItem = screen.getSheetItemByLabel("顧客シナリオ");

  const milestone = scenarioItem.getMilestones().entities[0];

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

    const result = milestone.assigneeLengthIsLessThanOrEqual(8);

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

関連情報

• SheetItem