charton 0.5.0

A high-performance, layered charting system for Rust, featuring a flexible data core and multi-backend rendering.
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

use crate::mark::Mark;
use crate::visual::color::SingleColor;

/// Mark type for box whisker charts.
///
/// The `MarkBoxplot` struct defines the visual properties of box-and-whisker plot elements.
/// It supports a fluent interface for configuring the box appearance, outlier styling,
/// and statistical layout parameters like spacing and span.
#[derive(Debug, Clone)]
pub struct MarkBoxplot {
    pub(crate) color: SingleColor,
    pub(crate) opacity: f64,
    pub(crate) stroke: SingleColor,
    pub(crate) stroke_width: f64,
    pub(crate) outlier_color: SingleColor,
    pub(crate) outlier_size: f64,
    pub(crate) width: f64,
    pub(crate) spacing: f64,
    pub(crate) span: f64,
}

impl MarkBoxplot {
    pub(crate) fn new() -> Self {
        Self {
            // (0.125, 0.996, 0.902, 0.808), // #fee6ce
            color: SingleColor::new("none"),
            opacity: 1.0,
            stroke: SingleColor::new("black"),
            stroke_width: 1.0,
            outlier_color: SingleColor::new("black"),
            outlier_size: 3.0,
            // span = width + spacing
            width: 0.5,   // This means the width of all boxes in a position is 0.5
            spacing: 0.2, // Gap(spacing*width) between dodged box elements in a group. 0.0-0.5 usually gives a beautiful layout.
            span: 0.7, // The total width of boxes and gaps in a position. 0.5-1.0 usually gives a beautiful layout.
        }
    }

    // --- Fluent Configuration Methods (Builder Pattern) ---

    /// Sets the fill color of the boxes. Accepts "red", "#hex", etc.
    pub fn with_color(mut self, color: impl Into<SingleColor>) -> Self {
        self.color = color.into();
        self
    }

    /// Sets the opacity of the boxplot mark.
    ///
    /// Value should be between 0.0 (transparent) and 1.0 (opaque).
    pub fn with_opacity(mut self, opacity: f64) -> Self {
        self.opacity = opacity.clamp(0.0, 1.0);
        self
    }

    /// Sets the stroke color of the boxes and whiskers. Use "none" to disable.
    pub fn with_stroke(mut self, stroke: impl Into<SingleColor>) -> Self {
        self.stroke = stroke.into();
        self
    }

    /// Sets the thickness of the boxplot's lines.
    pub fn with_stroke_width(mut self, width: f64) -> Self {
        self.stroke_width = width;
        self
    }

    /// Sets the color of the outlier points.
    pub fn with_outlier_color(mut self, color: impl Into<SingleColor>) -> Self {
        self.outlier_color = color.into();
        self
    }

    /// Sets the size of the outlier points.
    pub fn with_outlier_size(mut self, size: f64) -> Self {
        self.outlier_size = size;
        self
    }

    /// Sets the maximal width of the boxes.
    pub fn with_width(mut self, width: f64) -> Self {
        self.width = width;
        self
    }

    /// Sets the relative spacing between boxes in a group.
    ///
    /// Value is clamped between 0.0 and 1.0.
    pub fn with_spacing(mut self, spacing: f64) -> Self {
        self.spacing = spacing.clamp(0.0, 1.0);
        self
    }

    /// Sets the total span allocated for a box group.
    ///
    /// Value is clamped between 0.0 and 1.0.
    pub fn with_span(mut self, span: f64) -> Self {
        self.span = span.clamp(0.0, 1.0);
        self
    }
}

impl Default for MarkBoxplot {
    fn default() -> Self {
        Self::new()
    }
}

impl Mark for MarkBoxplot {
    fn mark_type(&self) -> &'static str {
        "boxplot"
    }
}