Module charts

Module charts 

Source
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::TrackableItem and prepares the data for chart creation.

StructsΒ§

BurndownOptions
Contains all information needed for creating a burndown chart. Create a new instance with BurndownOptions::new().
RenderOptions
Contains all information needed for rendering a chart. Create a new instance with RenderOptions::new().

EnumsΒ§

BurndownType
The type of burndown chart to create.
ChartSettingError
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 Series for all data points of a key to display in a chart. The key of the BTreeMap is Into<Option<T> to allow for Option<T> and non-Option<T> keys. If it is None, the key is β€œNone”. Returns the Series and 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 Series for each data point to display in a chart. The key of the BTreeMap is Into<Option<T> to allow for Option<T> and non-Option<T> keys. If it is None, 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 Series for all data points display in a chart. The key of the BTreeMap is Into<Option<T> to allow for Option<T> and non-Option<T> keys. If it is None, 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 precision number of decimal places and returns a string to avoid floating point inaccuracies

Type AliasesΒ§

SeriesData
Data to be converted into types from [charming::series].