DHTMLX Planning Engine Documentation

Overallocation#

The overallocated windows of one resource: stretches of time where the resource's booked load exceeds its capacity. Results carry one entry per resource in ScheduleResult.overallocations, which is present when the project has assignments.

Declaration#

interface Overallocation {
  resource: Id;
  windows?: {
    from: DateValue;
    to: DateValue;
    capacity: number;
    peak: number;
    overload: number;
    tasks: Id[];
    reason?: string;
  }[];
}

Fields#

Field Type Default Description
resource Id - Id of the overallocated resource.
windows object[] absent The resource's overallocated windows, in the shape below.
Note

windows is absent, not an empty array, when a resource has no overallocated window.

Window fields#

Field Type Description
from DateValue Start of the window, clipped to the working time of the contending tasks. A string, or a local Date when the project was created with dates: "date".
to DateValue End of the window, clipped the same way as from.
capacity number Capacity of the resource, in assignment value units (1 = 100 %).
peak number Highest load of any bucket in the window.
overload number Sum of load − capacity over the window's buckets.
tasks Id[] Ids of the tasks that book load in the window, in input order.
reason string Why leveling left the window unresolved. Present only in results of Project#level. One of the values below.

reason values:

Value Description
"pinned-constraint" A contending task can't move because of a pinned constraint.
"fixed-task" A contending task is not auto-scheduled, or is a summary.
"completed" A contending task is complete.
"priority-1000" A contending task has priority 1000.
"slack-exhausted" Every task that could move was out of slack.
"out-of-scope" The resource, the window or its tasks are outside the leveling scope.

When several values apply, the window reports the first one in this table. For how leveling decides, see Leveling resources.

Used by#

Example#

const overallocation = {
  resource: 7,
  windows: [
    {
      from: "2026-03-09 08:00",
      to: "2026-03-10 17:00",
      capacity: 1,
      peak: 2,
      overload: 2,
      tasks: [3, 5],
    },
  ],
};