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

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

/// Mark type for horizontal or vertical reference lines.
///
/// The `MarkRule` struct defines the visual properties of rule elements.
/// It supports a fluent interface for configuring the line color, opacity,
/// and thickness for drawing thresholds, grid lines, or connecting ranges.
#[derive(Debug, Clone)]
pub struct MarkRule {
    pub(crate) color: SingleColor,
    pub(crate) opacity: f64,
    pub(crate) stroke_width: f64,
}

impl MarkRule {
    /// Create a new MarkRule with default values.
    pub(crate) fn new() -> Self {
        Self {
            // (0.875, 0.651, 0.212, 0.012), // #a63603
            color: SingleColor::new("black"),
            opacity: 1.0,
            stroke_width: 1.0,
        }
    }

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

    /// Sets the color of the rule line. 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 rule line.
    ///
    /// 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 thickness of the rule line.
    pub fn with_stroke_width(mut self, width: f64) -> Self {
        self.stroke_width = width;
        self
    }
}

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

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