ggplot-rs 0.30.0

A Rust implementation of ggplot2's Grammar of Graphics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

//! Per-layer SVG attributes (#221): [`GGPlot::layer_svg_attr`]
//! (crate::plot::GGPlot::layer_svg_attr) wraps a layer's geom at build time
//! in [`LayerSvgAttrs`], which hands the layer's validated attributes to the
//! backend ([`DrawBackend::set_layer_attrs`]) around the wrapped geom's own
//! `draw` and delegates every other [`Geom`] method unchanged — the same
//! wrapper approach as [`super::decorative`], for the same reason (no new
//! field on the public `Layer`/`BuiltLayer` structs).

use crate::coord::Coord;
use crate::data::DataFrame;
use crate::position::Position;
use crate::render::backend::DrawBackend;
use crate::render::RenderError;
use crate::scale::ScaleSet;
use crate::stat::Stat;
use crate::theme::Theme;

use super::{Aesthetic, Geom, GeomParams};

/// A geom plus its layer's validated `layer_svg_attr`s.
pub(crate) struct LayerSvgAttrs(pub(crate) Box<dyn Geom>, pub(crate) Vec<(String, String)>);

impl Geom for LayerSvgAttrs {
    fn draw(
        &self,
        data: &DataFrame,
        coord: &dyn Coord,
        scales: &ScaleSet,
        theme: &Theme,
        backend: &mut dyn DrawBackend,
    ) -> Result<(), RenderError> {
        backend.set_layer_attrs(self.1.clone());
        let result = self.0.draw(data, coord, scales, theme, backend);
        backend.set_layer_attrs(Vec::new());
        result
    }

    fn required_aes(&self) -> Vec<Aesthetic> {
        self.0.required_aes()
    }

    fn default_stat(&self) -> Box<dyn Stat> {
        self.0.default_stat()
    }

    fn default_position(&self) -> Box<dyn Position> {
        self.0.default_position()
    }

    fn default_params(&self) -> GeomParams {
        self.0.default_params()
    }

    fn name(&self) -> &str {
        self.0.name()
    }

    fn set_series_color(&mut self, color: (u8, u8, u8)) {
        self.0.set_series_color(color);
    }

    fn apply_element_geom(&mut self, el: &crate::theme::elements::ElementGeom) {
        self.0.apply_element_geom(el);
    }

    fn include_zero_baseline(&self) -> bool {
        self.0.include_zero_baseline()
    }

    fn allows_infinite(&self) -> bool {
        self.0.allows_infinite()
    }

    fn keeps_na_as_break(&self) -> bool {
        self.0.keeps_na_as_break()
    }

    fn consumes_tooltips(&self) -> bool {
        self.0.consumes_tooltips()
    }

    fn setup_data(&self, data: &mut DataFrame, warnings: &mut Vec<String>) {
        self.0.setup_data(data, warnings);
    }

    fn inherit_aes(&self) -> bool {
        self.0.inherit_aes()
    }

    fn mapped_only_columns(&self) -> &'static [&'static str] {
        self.0.mapped_only_columns()
    }

    fn validate_layer(&self, pre_stat_columns: &[String], stat_name: &str) -> Result<(), String> {
        self.0.validate_layer(pre_stat_columns, stat_name)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::geom::bar::GeomBar;
    use crate::geom::boxplot::GeomBoxplot;
    use crate::geom::line::GeomLine;
    use crate::geom::point::GeomPoint;
    use crate::geom::rect::GeomRect;
    use crate::geom::refline::GeomHline;

    fn wrap(g: impl Geom + 'static) -> LayerSvgAttrs {
        LayerSvgAttrs(Box::new(g), vec![("class".into(), "x".into())])
    }

    #[test]
    fn delegates_every_geom_method() {
        let p = GeomPoint::default();
        let w = wrap(GeomPoint::default());
        assert_eq!(w.name(), p.name());
        assert_eq!(w.required_aes(), p.required_aes());
        assert_eq!(w.default_stat().name(), p.default_stat().name());
        assert_eq!(w.default_position().name(), p.default_position().name());
        assert_eq!(
            format!("{:?}", w.default_params()),
            format!("{:?}", p.default_params())
        );
        assert!(w.consumes_tooltips());
        assert!(w.inherit_aes());
        assert!(!wrap(GeomHline::new(1.0)).inherit_aes());
        assert!(wrap(GeomBar::default()).include_zero_baseline());
        assert!(wrap(GeomRect::default()).allows_infinite());
        assert!(wrap(GeomLine::default()).keeps_na_as_break());
        let b = wrap(GeomBoxplot::default());
        assert_eq!(
            b.mapped_only_columns(),
            GeomBoxplot::default().mapped_only_columns()
        );
        assert!(b.validate_layer(&[], "identity").is_err());
        let mut d = DataFrame::new();
        d.add_column(
            "outliers".to_string(),
            vec![crate::data::Value::Str("1".into())],
        );
        d.add_column("ymin".to_string(), vec![crate::data::Value::Float(0.0)]);
        d.add_column("ymax".to_string(), vec![crate::data::Value::Float(1.0)]);
        let n = d.column_names().len();
        b.setup_data(&mut d, &mut Vec::new());
        assert!(d.column_names().len() >= n);
        let mut m = wrap(GeomLine::default());
        m.set_series_color((1, 2, 3));
        m.apply_element_geom(&crate::theme::elements::ElementGeom::default());
    }
}