Magidoc

BurndownConfig
Object

Burndown chart settings. Consumption mode draws independent planned and actual trajectories against a shared starting balance; completion mode draws the remaining action scope.

Fields

#

mode

Non-null

Which engine draws the burndown; the other mode's settings are kept but not used.

completionValue

Non-null

Completion mode only: total each action's estimate or story points.

baselineSource

Non-null

Where the starting balance comes from. projectBudget requires unit money and is the projects' budget less all their other costs, whatever their date; plannedTotal requires at least one estimate line (task estimates or resourcing) and is the first estimate line's total inside the burndown period.

baselineAmount

Starting balance, required only when baselineSource is fixedAmount. Zero or more, in seconds for unit time or in the projects' currency for unit money.

baselineLabel

Non-null

Starting balance legend label, 1–80 characters and unique among all burndown labels.

unit

Non-null

Unit shared by the starting balance and every line.

showBaseline

Non-null

Whether to draw the starting balance as a flat line.

showIdeal

Non-null

Whether to add an ideal line to zero. In consumption mode it starts at the starting balance, requires at least one remaining line, and no other label may be 'Ideal remaining'; in completion mode it starts at the window's total scope.

lines

Non-null

Between one and six lines.

Usages

#

References

#