Struct Page

pub struct Page<'a> { /* private fields */ }

A single page page laying out the views in a grid

Implementations

impl<'a> Page<'a>

pub fn empty() -> Self

Creates an empty page container for plots to be added to

pub fn single(view: &'a dyn View) -> Self

Creates a plot containing a single view

Examples found in repository

examples/histogram_text.rs (line 11)

fn main() {
    let data = [0.3, 0.5, 6.4, 5.3, 3.6, 3.6, 3.5, 7.5, 4.0];
    let h = Histogram::from_slice(&data, HistogramBins::Count(10));

    let v = ContinuousView::new().add(h);

    println!("{}", Page::single(&v).dimensions(60, 15).to_text().unwrap());
}

examples/histogram_svg.rs (line 13)

fn main() {
    let data = [0.3, 0.5, 6.4, 5.3, 3.6, 3.6, 3.5, 7.5, 4.0];
    let h = Histogram::from_slice(&data, HistogramBins::Count(10))
        .style(&BoxStyle::new().fill("burlywood"));

    let v = ContinuousView::new().add(h);

    Page::single(&v).save("histogram.svg").expect("saving svg");
}

examples/line_svg.rs (line 13)

fn main() {
    let l1 = Plot::new(vec![(0., 1.), (2., 1.5), (3., 1.2), (4., 1.1)]).line_style(
        LineStyle::new()
            .colour("burlywood")
            .linejoin(LineJoin::Round),
    );
    let v = ContinuousView::new().add(l1);
    Page::single(&v).save("line.svg").expect("saving svg");
}

examples/barchart_svg.rs (line 14)

fn main() {
    let b1 = BarChart::new(5.3).label("1");
    let b2 = BarChart::new(2.6)
        .label("2")
        .style(&BoxStyle::new().fill("darkolivegreen"));

    let v = CategoricalView::new().add(b1).add(b2).x_label("Experiment");

    Page::single(&v).save("barchart.svg").expect("saving svg");
}

examples/with_grid.rs (line 20)

fn render_line_chart<S>(filename: S)
where
    S: AsRef<str>,
{
    let l1 = Plot::new(vec![(0., 1.), (2., 1.5), (3., 1.2), (4., 1.1)])
        .line_style(LineStyle::new().colour("burlywood"));
    let mut v = ContinuousView::new().add(l1);
    v.add_grid(Grid::new(3, 8));
    Page::single(&v)
        .save(filename.as_ref())
        .expect("saving svg");
}

fn render_barchart<S>(filename: S)
where
    S: AsRef<str>,
{
    let b1 = BarChart::new(5.3).label("1");
    let b2 = BarChart::new(2.6)
        .label("2")
        .style(&BoxStyle::new().fill("darkolivegreen"));
    let mut v = CategoricalView::new().add(b1).add(b2).x_label("Experiment");
    v.add_grid(Grid::new(3, 8));
    Page::single(&v)
        .save(filename.as_ref())
        .expect("saving svg");
}

examples/line_and_point_svg.rs (line 16)

fn main() {
    let l1 = Plot::new(vec![(0., 1.), (2., 1.5), (3., 1.2), (4., 1.1)])
        .line_style(
            LineStyle::new()
                .colour("burlywood")
                .linejoin(LineJoin::Round),
        )
        .point_style(PointStyle::new());

    let v = ContinuousView::new().add(l1);
    Page::single(&v)
        .save("line_and_point.svg")
        .expect("saving svg");
}

Additional examples can be found in:

• examples/boxplot_svg.rs
• examples/function_svg.rs
• examples/scatter_text.rs
• examples/letter_counter.rs
• examples/scatter_svg.rs

pub fn dimensions(self, x: u32, y: u32) -> Self

Set the dimensions of the plot.

Examples found in repository

examples/histogram_text.rs (line 11)

fn main() {
    let data = [0.3, 0.5, 6.4, 5.3, 3.6, 3.6, 3.5, 7.5, 4.0];
    let h = Histogram::from_slice(&data, HistogramBins::Count(10));

    let v = ContinuousView::new().add(h);

    println!("{}", Page::single(&v).dimensions(60, 15).to_text().unwrap());
}

examples/boxplot_svg.rs (line 19)

fn main() {
    let b1 = BoxPlot::from_slice(&[1.0, 4.0, 2.0, 3.5, 6.4, 2.5, 7.5, 1.8, 9.6]).label("1");
    let b2 = BoxPlot::from_slice(&[3.0, 4.3, 2.0, 3.5, 6.9, 4.5, 7.5, 1.8, 10.6])
        .label("2")
        .style(&BoxStyle::new().fill("darkolivegreen"));

    let v = CategoricalView::new()
        .add(b1)
        .add(b2)
        .x_label("Experiment")
        .y_label("y");

    Page::single(&v)
        .dimensions(400, 300)
        .save("boxplot.svg")
        .expect("saving svg");
}

examples/scatter_text.rs (line 27)

fn main() {
    let data = vec![
        (-3.0, 2.3),
        (-1.6, 5.3),
        (0.3, 0.7),
        (4.3, -1.4),
        (6.4, 4.3),
        (8.5, 3.7),
    ];
    let s1 = Plot::new(data).point_style(PointStyle::new().marker(PointMarker::Circle));
    let s2 = Plot::new(vec![(-1.4, 2.5), (7.2, -0.3)])
        .point_style(PointStyle::new().marker(PointMarker::Square));

    let v = ContinuousView::new()
        .add(s1)
        .add(s2)
        .x_range(-5., 10.)
        .y_range(-2., 6.)
        .x_label("Some varying variable")
        .y_label("The response of something");

    println!("{}", Page::single(&v).dimensions(80, 30).to_text().unwrap());
}

pub fn add_plot(self, view: &'a dyn View) -> Self

Add a view to the plot

pub fn to_svg(&self) -> Result<Document, Error>

Render the plot to an svg document

pub fn to_text(&self) -> Result<String, Error>

Render the plot to an String

Examples found in repository

examples/histogram_text.rs (line 11)

fn main() {
    let data = [0.3, 0.5, 6.4, 5.3, 3.6, 3.6, 3.5, 7.5, 4.0];
    let h = Histogram::from_slice(&data, HistogramBins::Count(10));

    let v = ContinuousView::new().add(h);

    println!("{}", Page::single(&v).dimensions(60, 15).to_text().unwrap());
}

examples/scatter_text.rs (line 27)

fn main() {
    let data = vec![
        (-3.0, 2.3),
        (-1.6, 5.3),
        (0.3, 0.7),
        (4.3, -1.4),
        (6.4, 4.3),
        (8.5, 3.7),
    ];
    let s1 = Plot::new(data).point_style(PointStyle::new().marker(PointMarker::Circle));
    let s2 = Plot::new(vec![(-1.4, 2.5), (7.2, -0.3)])
        .point_style(PointStyle::new().marker(PointMarker::Square));

    let v = ContinuousView::new()
        .add(s1)
        .add(s2)
        .x_range(-5., 10.)
        .y_range(-2., 6.)
        .x_label("Some varying variable")
        .y_label("The response of something");

    println!("{}", Page::single(&v).dimensions(80, 30).to_text().unwrap());
}

pub fn save<P>(&self, path: P) -> Result<(), Error>

where P: AsRef<Path>,

Save the plot to a file.

The type of file will be based on the file extension.

Examples found in repository

examples/histogram_svg.rs (line 13)

fn main() {
    let data = [0.3, 0.5, 6.4, 5.3, 3.6, 3.6, 3.5, 7.5, 4.0];
    let h = Histogram::from_slice(&data, HistogramBins::Count(10))
        .style(&BoxStyle::new().fill("burlywood"));

    let v = ContinuousView::new().add(h);

    Page::single(&v).save("histogram.svg").expect("saving svg");
}

examples/line_svg.rs (line 13)

fn main() {
    let l1 = Plot::new(vec![(0., 1.), (2., 1.5), (3., 1.2), (4., 1.1)]).line_style(
        LineStyle::new()
            .colour("burlywood")
            .linejoin(LineJoin::Round),
    );
    let v = ContinuousView::new().add(l1);
    Page::single(&v).save("line.svg").expect("saving svg");
}

examples/barchart_svg.rs (line 14)

fn main() {
    let b1 = BarChart::new(5.3).label("1");
    let b2 = BarChart::new(2.6)
        .label("2")
        .style(&BoxStyle::new().fill("darkolivegreen"));

    let v = CategoricalView::new().add(b1).add(b2).x_label("Experiment");

    Page::single(&v).save("barchart.svg").expect("saving svg");
}

examples/with_grid.rs (line 21)

fn render_line_chart<S>(filename: S)
where
    S: AsRef<str>,
{
    let l1 = Plot::new(vec![(0., 1.), (2., 1.5), (3., 1.2), (4., 1.1)])
        .line_style(LineStyle::new().colour("burlywood"));
    let mut v = ContinuousView::new().add(l1);
    v.add_grid(Grid::new(3, 8));
    Page::single(&v)
        .save(filename.as_ref())
        .expect("saving svg");
}

fn render_barchart<S>(filename: S)
where
    S: AsRef<str>,
{
    let b1 = BarChart::new(5.3).label("1");
    let b2 = BarChart::new(2.6)
        .label("2")
        .style(&BoxStyle::new().fill("darkolivegreen"));
    let mut v = CategoricalView::new().add(b1).add(b2).x_label("Experiment");
    v.add_grid(Grid::new(3, 8));
    Page::single(&v)
        .save(filename.as_ref())
        .expect("saving svg");
}

examples/line_and_point_svg.rs (line 17)

fn main() {
    let l1 = Plot::new(vec![(0., 1.), (2., 1.5), (3., 1.2), (4., 1.1)])
        .line_style(
            LineStyle::new()
                .colour("burlywood")
                .linejoin(LineJoin::Round),
        )
        .point_style(PointStyle::new());

    let v = ContinuousView::new().add(l1);
    Page::single(&v)
        .save("line_and_point.svg")
        .expect("saving svg");
}

examples/boxplot_svg.rs (line 20)

fn main() {
    let b1 = BoxPlot::from_slice(&[1.0, 4.0, 2.0, 3.5, 6.4, 2.5, 7.5, 1.8, 9.6]).label("1");
    let b2 = BoxPlot::from_slice(&[3.0, 4.3, 2.0, 3.5, 6.9, 4.5, 7.5, 1.8, 10.6])
        .label("2")
        .style(&BoxStyle::new().fill("darkolivegreen"));

    let v = CategoricalView::new()
        .add(b1)
        .add(b2)
        .x_label("Experiment")
        .y_label("y");

    Page::single(&v)
        .dimensions(400, 300)
        .save("boxplot.svg")
        .expect("saving svg");
}

Additional examples can be found in:

• examples/function_svg.rs
• examples/letter_counter.rs
• examples/scatter_svg.rs