Skip to main content

onBeforeTaskMove

Description​

Fires before a task is moved to a new vertical position

onBeforeTaskMove: (id: string | number, parent: string | number, tindex: number) => boolean;

Parameters​

  • id - (required) string | number - the id of the task to move
  • parent - (required) string | number - the parent id
  • tindex - (required) number - the index of the position in the parent branch that the task will be moved to

Returns​

  • result - (boolean) - defines whether the default action of the event will be triggered (true) or canceled (false)

Example​

//prevent moving to another sub-branch:
gantt.attachEvent("onBeforeTaskMove", function(id, parent, tindex){
    const task = gantt.getTask(id);
    if(task.parent != parent)
        return false;
    return true;
});

Details​

The event is blockable. Return false to cancel moving of the task.

Note, the event fires in 2 cases:

  1. While calling the method moveTask
  2. While the option order_branch is enabled in the default mode (gantt.config.order_branch = true;) and a user drags tasks