view : Config -> Html msg
Show a burndown chart
See Config
.
( Basics.Int, Time.Month, Basics.Int )
(year, month, day)
{ name : String
, color : Maybe Color
, startDate : Date
, baseline : ( Date
, EstimationMethod )
, milestones : List ( String
, Basics.Int
, Maybe Date )
, pointsRemaining : List Basics.Int
}
name
: The name of the project. This will be used as the title of the chart.color
: The color used for the burndown line. If not given, this will use the default color from terezka/line-charts
.startDate
: The start date of the project.baseline
: A baseline estimate for the project. This is a tuple containing:EstimationMethod
to use to calculate the goal line.milestones
: (optional) A list of intermediate milestones to draw on the chart. Each milestone includes:Nothing
if it has not been accepted yet.pointsRemaining
: A list containing the number of points remaining at the start of each day of the project.A burndown chart shows a baseline (or goal line) starting from the baseline date with the number of points remaining on that date to the estimated end date (with the slope of the line beind the estimated velocity).
You can specify the target date (a time-based estimate) and have the estimated velocity be calculated; or you can specify the estimated velocity (a scope-based estimate) and have the target date be calculated.
estimatedVelocity : Basics.Float -> EstimationMethod
A scope-based estimate where the estimated velocity is specified and the target date will be calculated.
targetDate : Date -> EstimationMethod
A time-based estimate where the target date is specified and the estimated velocity will be calculated.
These are the basic colors available in terezka/line-charts
exposed here for convenience so you don't have to add line-charts
as a direct dependency.
If you want other colors, you can use colors from LineCharts.Colors
,
any color you can create with avh4/elm-color
,
or colors from any other package that produces a Color
.
red : Color
pink : Color
gold : Color
green : Color
teal : Color
cyan : Color
blue : Color
purple : Color