update-task
Description
Fires when updating a taskUsage
"update-task": ({
id: string | number,
task: object,
diff?: number,
inProgress?: boolean
}) => boolean | void;
Parameters
The callback of the update-task action can take an object with the following parameters:
id
- (required) the task IDtask
- (required) the task object. The list of parameters you can see here: tasks. You can also specify the following parameters:level
- (required) the nesting level of a task in the tasks treedata
- (optional) an array of objects with child tasks objects if any (parameters are the same as for the task object)key
- (required) the name of the data field which should be unique for each control type (e.g., text, duration, progress, etc.)
diff
- (optional) the number of units for the start or/and end date values to be changed (in thetasks
object)inProgress
- (optional) if true, marks that the task update is in progress
Example
The example below shows how to clear the task text when opening the Editor dialog for it.
<script>
import { getData } from "./common/data";
import { Gantt } from "@wx/svelte-gantt";
const data = getData();
let api;
function clearTaskText() {
api.exec("update-task",
{ id: 3, task: { text: "" }
});
};
</script>
<Gantt
bind:api
tasks={data.tasks}
on:show-editor={clearTaskText} />
Related articles: