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

pub(crate) mod area;
pub(crate) mod bar;
pub(crate) mod boxplot;
pub(crate) mod errorbar;
pub(crate) mod histogram;
pub(crate) mod line;
pub(crate) mod no_mark;
pub(crate) mod point;
pub(crate) mod rect;
pub(crate) mod rule;
pub(crate) mod text;
pub(crate) mod tick;

use crate::prelude::SingleColor;
/// A trait representing a visual mark in a plot.
///
/// This trait defines the common interface for all visual marks that can be used
/// in plots, such as points, lines, bars, etc. Each mark type must implement
/// this trait to provide information about its visual properties.
///
/// The trait requires implementing types to also implement `Clone` to allow
/// for easy duplication of mark configurations.
///
/// # Required Methods
///
/// Implementors must provide:
/// - `mark_type`: Returns a string identifier for the mark type
///
/// # Provided Methods
///
/// Default implementations are provided for:
/// - `stroke`: Returns the stroke color (defaults to None)
/// - `shape`: Returns the point shape (defaults to Circle)
/// - `opacity`: Returns the opacity value (defaults to 1.0)
pub trait Mark: Clone + 'static {
    /// Used to identify mark type
    fn mark_type(&self) -> &'static str;

    /// Returns the stroke color of the mark
    ///
    /// This method provides access to the stroke color setting of the mark.
    /// If no stroke color is set, it returns None.
    ///
    /// # Returns
    /// * `crate::visual::color::SingleColor`
    fn stroke(&self) -> crate::visual::color::SingleColor {
        SingleColor::new("none")
    }

    /// Returns the shape of the point
    ///
    /// # Arguments
    /// * `self` - Reference to the instance
    ///
    /// # Returns
    /// Returns a PointShape enum value representing the visual shape of the point
    ///
    /// # Description
    /// This function returns a circular shape by default for point visualization
    fn shape(&self) -> crate::visual::shape::PointShape {
        crate::visual::shape::PointShape::Circle
    }

    /// Returns the opacity of the mark
    fn opacity(&self) -> f64 {
        1.0 // Default fully opaque
    }
}