getTaskPosition

calculates the position and size of the task's DOM element in the timeline area

object getTaskPosition(object task,Date from,Date to);

Parameters

taskobjectthe task object
fromDatethe start date of the item
toDatethe end date of the item

Returns

objectthe size object

Example

// adding baseline display
gantt.addTaskLayer(function draw_planned(task) {
    if (task.planned_start && task.planned_end) {
        var sizes = gantt.getTaskPosition(task, task.planned_start, task.planned_end);         var el = document.createElement('div');
        el.className = 'baseline';
        el.style.left = sizes.left + 'px';
        el.style.top = sizes.top + 'px';
        el.style.width = sizes.width + 'px';
        el.style.height= sizes.height + 'px';
        return el;
    }
    return false;
});

Related samples

Details

The method returns an object with the following properties:

  • left - the CSS left position in pixels
  • top - the CSS top position in pixels
  • height - the CSS height in pixels (defined by the gantt.config.task_height configuration)
  • width - the CSS width in pixels (defined by the period between start and end dates of the task or from 'from', 'to' dates if provided)

If only one argument is provided, the method will use task.start_date/task.end_date in order to calculate width and left values. Otherwise, the date values from the second and the third arguments will be used.

Note, that the method always uses both date and time parts of the provided dates, regardless of the time scale settings. It means that two calls of the function given below:

gantt.getTaskPosition(task, new Date(2019, 3, 19, 1, 0), new Date(2019, 3, 19, 1, 0)); 
// and
gantt.getTaskPosition(task, new Date(2019, 3, 19, 1, 0), new Date(2019, 3, 19, 5, 0));

will return boxes of different sizes, not only in the hour scale, but in the day/month/year scales as well.

Back to top