charton 0.5.0

A high-performance, layered charting system for Rust, featuring a flexible data core and multi-backend rendering.
Documentation
use crate::mark::Mark;
use crate::visual::color::SingleColor;

/// Mark type for area charts.
///
/// The `MarkArea` struct defines the visual properties of filled area elements.
/// It supports a fluent interface for configuring fill color, opacity, and
/// stroke properties of the area boundary.
#[derive(Clone, Debug)]
pub struct MarkArea {
    pub(crate) color: SingleColor,
    pub(crate) opacity: f64,
    pub(crate) stroke: SingleColor,
    pub(crate) stroke_width: f64,
    pub(crate) dash: Vec<f64>,
}

impl MarkArea {
    pub(crate) fn new() -> Self {
        Self {
            // (0.500, 0.992, 0.553, 0.235), // #fd8d3c
            color: SingleColor::new("gray"),
            opacity: 1.0,
            stroke: SingleColor::new("none"),
            stroke_width: 1.0,
            dash: vec![],
        }
    }

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

    /// Sets the fill color of the area. 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 area 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 for the area boundary. 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 area's boundary stroke.
    pub fn with_stroke_width(mut self, width: f64) -> Self {
        self.stroke_width = width;
        self
    }

    /// Sets the path dash pattern using the standard SVG `stroke-dasharray` rules.
    ///
    /// This property accepts a list of numbers that specify the lengths of
    /// alternating dashes and gaps.
    ///
    /// - `vec![]`: A solid line.
    /// - `vec![step]`: Equivalent to `vec![step, step]`.
    /// - `vec![dash, gap]`: Specifies the length of the dash and the gap.
    ///
    /// For more details, refer to the MDN documentation for `stroke-dasharray`.
    pub fn with_dash(mut self, dash: impl Into<Vec<f64>>) -> Self {
        self.dash = dash.into();
        self
    }
}

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

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