Struct Plot

pub struct Plot {
    pub data: Vec<(f64, f64)>,
    pub line_style: Option<LineStyle>,
    pub point_style: Option<PointStyle>,
    pub legend: Option<String>,
}

Representation of any plot with points in the XY plane, visualized as points and/or with lines in-between.

Fields

data: Vec<(f64, f64)>

line_style: Option<LineStyle>

None if no lines should be displayed

point_style: Option<PointStyle>

None if no points should be displayed

legend: Option<String>

Implementations

impl Plot

pub fn new(data: Vec<(f64, f64)>) -> Self

Examples found in repository

examples/line_svg.rs (line 7)

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/with_grid.rs (line 16)

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");
}

examples/line_and_point_svg.rs (line 7)

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/scatter_text.rs (line 15)

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());
}

examples/scatter_svg.rs (line 18)

fn main() {
    // Scatter plots expect a list of pairs
    let data1 = 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),
    ];

    // We create our scatter plot from the data
    let s1: Plot = Plot::new(data1).point_style(
        PointStyle::new()
            .marker(PointMarker::Square) // setting the marker to be a square
            .colour("#DD3355"),
    ); // and a custom colour

    // We can plot multiple data sets in the same view
    let data2 = vec![(-1.4, 2.5), (7.2, -0.3)];
    let s2: Plot = Plot::new(data2).point_style(
        PointStyle::new() // uses the default marker
            .colour("#35C788"),
    ); // and a different colour

    // The 'view' describes what set of data is drawn
    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");

    // A page with a single view is then saved to an SVG file
    Page::single(&v).save("scatter.svg").unwrap();
}

pub fn from_function<F: Fn(f64) -> f64>(f: F, lower: f64, upper: f64) -> Self

Examples found in repository

examples/function_svg.rs (line 8)

fn main() {
    let f1 =
        Plot::from_function(|x| x * 5., 0., 10.).line_style(LineStyle::new().colour("burlywood"));
    let f2 = Plot::from_function(|x| x.powi(2), 0., 10.)
        .line_style(LineStyle::new().colour("darkolivegreen").width(2.));
    let f3 = Plot::from_function(|x| x.sqrt() * 20., 0., 10.)
        .line_style(LineStyle::new().colour("brown").width(1.));

    let v = ContinuousView::new().add(f1).add(f2).add(f3);

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

pub fn line_style(self, other: LineStyle) -> Self

Examples found in repository

examples/line_svg.rs (lines 7-11)

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/with_grid.rs (line 17)

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");
}

examples/line_and_point_svg.rs (lines 8-12)

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/function_svg.rs (line 8)

fn main() {
    let f1 =
        Plot::from_function(|x| x * 5., 0., 10.).line_style(LineStyle::new().colour("burlywood"));
    let f2 = Plot::from_function(|x| x.powi(2), 0., 10.)
        .line_style(LineStyle::new().colour("darkolivegreen").width(2.));
    let f3 = Plot::from_function(|x| x.sqrt() * 20., 0., 10.)
        .line_style(LineStyle::new().colour("brown").width(1.));

    let v = ContinuousView::new().add(f1).add(f2).add(f3);

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

pub fn point_style(self, other: PointStyle) -> Self

Examples found in repository

examples/line_and_point_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),
        )
        .point_style(PointStyle::new());

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

examples/scatter_text.rs (line 15)

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());
}

examples/scatter_svg.rs (lines 18-22)

fn main() {
    // Scatter plots expect a list of pairs
    let data1 = 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),
    ];

    // We create our scatter plot from the data
    let s1: Plot = Plot::new(data1).point_style(
        PointStyle::new()
            .marker(PointMarker::Square) // setting the marker to be a square
            .colour("#DD3355"),
    ); // and a custom colour

    // We can plot multiple data sets in the same view
    let data2 = vec![(-1.4, 2.5), (7.2, -0.3)];
    let s2: Plot = Plot::new(data2).point_style(
        PointStyle::new() // uses the default marker
            .colour("#35C788"),
    ); // and a different colour

    // The 'view' describes what set of data is drawn
    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");

    // A page with a single view is then saved to an SVG file
    Page::single(&v).save("scatter.svg").unwrap();
}

pub fn legend(self, legend: String) -> Self

Trait Implementations

impl Clone for Plot

fn clone(&self) -> Plot

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ContinuousRepresentation for Plot

fn range(&self, dim: u32) -> (f64, f64)

The maximum range in each dimension. Used for auto-scaling axes.

fn to_svg( &self, x_axis: &ContinuousAxis, y_axis: &ContinuousAxis, face_width: f64, face_height: f64, ) -> Group

fn legend_svg(&self) -> Option<Group>

Returns None if no legend has been specified for this representation

fn to_text( &self, x_axis: &ContinuousAxis, y_axis: &ContinuousAxis, face_width: u32, face_height: u32, ) -> String

impl Debug for Plot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.