malevich 0.4.0

Terminal plotting: a small grammar of marks, honest axes, millions of points
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

//! The area mark: a filled region between two edges.

use crate::data::{IntoSeries, Series};
use crate::render::Color;

/// A filled region: from the zero baseline up to a series, or between two series.
///
/// Fills are drawn as vertical subpixel runs, so they are solid in every charset
/// and their edges keep subpixel precision. Gaps (`NaN`) in any edge break the fill.
#[derive(Clone)]
pub struct Area<'a> {
    pub(crate) x: Option<Series<'a>>,
    pub(crate) low: Option<Series<'a>>,
    pub(crate) high: Series<'a>,
    pub(crate) color: Option<Color>,
    pub(crate) label: Option<String>,
}

impl<'a> Area<'a> {
    /// A fill from zero up to `values`, against their indices.
    pub fn y(values: impl IntoSeries<'a>) -> Area<'a> {
        Area {
            x: None,
            low: None,
            high: values.into_series(),
            color: None,
            label: None,
        }
    }

    /// A fill from zero up to `y` over `x`.
    ///
    /// # Panics
    ///
    /// Panics if the two series have different lengths.
    pub fn xy(x: impl IntoSeries<'a>, y: impl IntoSeries<'a>) -> Area<'a> {
        let x = x.into_series();
        let y = y.into_series();
        assert_eq!(x.len(), y.len(), "Area::xy requires series of equal length");
        Area {
            x: Some(x),
            low: None,
            high: y,
            color: None,
            label: None,
        }
    }

    /// A band between `low` and `high` over `x` — confidence intervals, stacked
    /// layers, min/max envelopes.
    ///
    /// # Panics
    ///
    /// Panics if the three series have different lengths.
    pub fn between(
        x: impl IntoSeries<'a>,
        low: impl IntoSeries<'a>,
        high: impl IntoSeries<'a>,
    ) -> Area<'a> {
        let x = x.into_series();
        let low = low.into_series();
        let high = high.into_series();
        assert!(
            x.len() == low.len() && low.len() == high.len(),
            "Area::between requires series of equal length"
        );
        Area {
            x: Some(x),
            low: Some(low),
            high,
            color: None,
            label: None,
        }
    }

    /// Sets an explicit color; without one, layers take colors from the palette.
    #[must_use]
    pub fn color(mut self, color: Color) -> Area<'a> {
        self.color = Some(color);
        self
    }

    /// Names this layer in the legend.
    #[must_use]
    pub fn label(mut self, label: impl Into<String>) -> Area<'a> {
        self.label = Some(label.into());
        self
    }

    /// Detaches from any borrowed storage, making the mark `'static`.
    pub fn into_owned(self) -> Area<'static> {
        Area {
            x: self.x.map(Series::into_owned),
            low: self.low.map(Series::into_owned),
            high: self.high.into_owned(),
            color: self.color,
            label: self.label,
        }
    }
}

impl std::fmt::Debug for Area<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Area")
            .field("points", &self.high.len())
            .field("banded", &self.low.is_some())
            .field("color", &self.color)
            .finish()
    }
}

#[cfg(test)]
#[path = "tests/area_tests.rs"]
mod tests;