ScenarioItem

ScenarioItem クラスはマイルストーンに対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

priorityChoices

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

例

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

  console.log(scenarioItem.priorityChoices);
});

milestoneStatusChoices

マイルストーンの優先度の選択肢です。

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

  console.log(scenarioItem.milestoneStatusChoices);
});

taskStatusChoices

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

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

  console.log(scenarioItem.taskStatusChoices);
});

インスタンスメソッド

onMilestoneAdded

マイルストーンが追加された後に呼び出されるeventHookを登録します。

構文

onMilestoneAdded(callback);
onMilestoneAdded(callback, group);

引数

callback

マイルストーンが追加されたタイミングで実行する関数です。

group

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

返値

なし

例

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

  const unlisten = scenarioItem.onMilestoneAdded(function () {
    console.log("MilestoneAdded");
    unlisten(); // 解除
  });
});

onMilestoneRemoved

マイルストーンが削除された後に呼び出されるeventHookを登録します。

構文

onMilestoneRemoved(callback);
onMilestoneRemoved(callback, group);

引数

callback

マイルストーンが削除されたタイミングで実行する関数です。

group

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

返値

なし

例

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

  const unlisten = scenarioItem.onMilestoneRemoved(function () {
    console.log("MilestoneRemoved");
    unlisten(); // 解除
  });
});

onMilestonesUpdated

マイルストーンが更新された後に呼び出されるeventHookを登録します。

構文

onMilestonesUpdated(callback);
onMilestonesUpdated(callback, group);

引数

callback

マイルストーンが更新されたタイミングで実行する関数です。

group

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

返値

なし

例

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

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

getMilestones

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

構文

getMilestones();

引数

なし

返値

Milestonesクラスのインスタンス

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

  console.log(scenarioItem.getMilestones());

});

getMilestoneByIndex

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

構文

getMilestoneByIndex(index);

引数

index

マイルストーンが何行目かを示す数値です。

返値

Milestoneクラスのインスタンス

例

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

  const milestone = scenarioItem.getMilestoneByIndex(1);
});

setMilestoneAdded

ID を指定してマイルストーンを追加します。

構文

setMilestoneAdded(ID);

引数

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

返値

なし

例

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

  console.log(scenarioItem.getMilestones().length);
  // 3

  scenarioItem.setMilestoneAdded(1);

  console.log(scenarioItem.getMilestones().length);
  // 4
});

setMilestoneRemovedByIndex

指定した index のマイルストーンを削除します。

構文

setMilestoneRemovedByIndex(index);

引数

index

何行目かのマイルストーンを示す数値です。

返値

なし

例

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

  console.log(scenarioItem.getMilestones().length);
  // 3

  scenarioItem.setMilestoneRemoved(1);

  console.log(scenarioItem.getMilestones().length);
  // 2
});

onTaskAdded

タスクが追加された後に呼び出されるeventHookを登録します。

構文

onTaskAdded(callback);
onTaskAdded(callback, group);

引数

callback

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

group

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

返値

なし

例

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

  const unlisten = scenarioItem.onTaskAdded(function () {
    console.log("TaskAdded");
    unlisten(); // 解除
  });
});

onTaskRemoved

タスクが削除された後に呼び出されるeventHookを登録します。

構文

onTaskRemoved(callback);
onTaskRemoved(callback, group);

引数

callback

タスクが削除されたタイミングで実行する関数です。

group

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

返値

なし

例

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

  const unlisten = scenarioItem.onTaskRemoved(function () {
    console.log("TaskRemoved");
    unlisten(); // 解除
  });
});

onTasksUpdated

タスクが更新された後に呼び出されるeventHookを登録します。

構文

onTasksUpdated(callback);
onTasksUpdated(callback, group);

引数

callback

タスクが更新されたタイミングで実行する関数です。

group

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

返値

なし

例

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

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

getTasks

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

構文

getTasks();

引数

なし

返値

Tasksクラスのインスタンス

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

  const tasks = scenarioItem.getTasks();
});

関連情報

• SheetItem
• Milestones
• Milestone