Crate poloto

Plot to SVG and style with CSS

You can find poloto on github and crates.io. Documentation at docs.rs

Check out the github examples. The latest graph outputs of the examples can be found in the assets folder.

Pipeline:

• Collect plots (data function)
• Compute min/max (call Data::build and generate a DataResult).
• Create tick distributions. (This step can be done automatically using DataResult::plot instead of DataResult::plot_with)
• Collect title/xname/yname (on creation of Plotter)
• Write everything to svg. Plotter::render for no svg tag/css. simple_theme::SimpleTheme for basic css/svg tag.

Poloto provides by default 3 impls of HasDefaultTicks for the following types:

• i128 - decimal/scientific notation ticks.
• f64 - decimal/scientific notation ticks.
• UnixTime - date/time

The above types have the advantage of automatically selecting reasonable tick intervals. The user can change the formatting of the ticks while still using the ticks that were selected via its automatic methods using TickFormat::with_tick_fmt.

However, sometimes you may want more control on the ticks, or want to use a type other than i128/f64/UnixTime. One way would be to write your own function that returns a TickInfo. Alternatively you can use the steps function that just takes an iterator of ticks and returns a TickInfo. This puts more responsibility on the user to pass a decent number of ticks. This should only really be used when the user knows up front the min and max values of that axis. This is typically the case for at least one of the axis, typically the x axis. See marathon example

Modules

bounded_iter

Create a PlotIter from a plot with min/max bounds known beforehand.

buffered_iter

Create a PlotIter from an iterator that does not implement Clone.

num

Some impls of PlotNum and TickFormat.

plotnum

Contains the PlotNum trait and their supporting structs.

plottable

Contains the Plottable trait and adapters that work on it.

prelude

The poloto prelude.

simple_theme

A simple dark and light css theme.

util

Misc functions.

Macros

formatm

Shorthand for disp_const(move |w|write!(w,...)) Similar to std::format_args!() except has a more flexible lifetime.

Structs

Bound

Created once the min and max bounds of all the plots has been computed. Contains in it all the information typically needed to make a TickInfo.

Data

Plot collector.

DataResult

Created by Data::build

Plotter

Created by DataResult::plot or DataResult::plot_with

SimplePlotFormatter

StepFmt

Functions

data

Start plotting.

disp

Leverage rust’s display format system using std::cell::RefCell under the hood.

disp_const

Convert a closure to a object that implements Display

disp_mut

Leverage rust’s display format system using std::cell::RefCell under the hood.

plot_fmt

Create a plot formatter that implements plotnum::PlotFmt

steps

Create a plotnum::TickInfo from a step iterator.

ticks_from_default

Create a tick distribution from the default tick generator for the plotnum type.

upgrade_write

Update a std::io::Write to be a std::fmt::Write