Expand description
Methods to turn TimeLog into SVG and HTML charts.
ModulesΒ§
- burndown
- Calculates the necessary data for burndown chart creation.
- charming_
extensions π - Contains traits and helper functions for creating charts with [
charming]. - chart_
options π - Data structures for creating charts
- estimates π
- Calculates the estimates from
crate::model::TrackableItemand prepares the data for chart creation.
StructsΒ§
- Burndown
Options - Contains all information needed for creating a burndown chart.
Create a new instance with
BurndownOptions::new(). - Render
Options - Contains all information needed for rendering a chart.
Create a new instance with
RenderOptions::new().
EnumsΒ§
- Burndown
Type - The type of burndown chart to create.
- Chart
Setting Error - Possible errors when creating a chart.
ConstantsΒ§
- ROUNDING_
PRECISION π - Number of digits after the decimal point when displaying values in charts.
FunctionsΒ§
- create_
bar_ chart - Create a bar chart.
- create_
burndown_ chart - Create a burndown line chart.
- create_
estimate_ chart - Creates a chart with estimates and actual time from grouped time logs (i.e., Estimates vs. actual time on all labels)
- create_
grouped_ bar_ chart - Create a grouped bar chart, i.e., Hours per Label per User.
- create_
grouped_ πseries - Create a
Seriesfor all data points of a key to display in a chart. The key of theBTreeMapisInto<Option<T>to allow forOption<T>and non-Option<T>keys. If it isNone, the key is βNoneβ. Returns theSeriesand the axis labels for the grouped bar chart. - create_
multi_ πseries - Calculate the total hours per key (i.e., User or Milestone) and create a
Seriesfor each data point to display in a chart. The key of theBTreeMapisInto<Option<T>to allow forOption<T>and non-Option<T>keys. If it isNone, the key is βNoneβ - create_
pie_ chart - Create a pie chart.
- create_
single_ πseries - Calculate the total hours per key (i.e., User or Milestone) and create a singular
Seriesfor all data points display in a chart. The key of theBTreeMapisInto<Option<T>to allow forOption<T>and non-Option<T>keys. If it isNone, the key is βNoneβ - render_
chart_ πwith_ settings - Renders a chart as an SVG and an HTML file.
- round_
to_ πstring - Rounds the value to
precisionnumber of decimal places and returns a string to avoid floating point inaccuracies
Type AliasesΒ§
- Series
Data - Data to be converted into types from [
charming::series].