vizkit 0.1.1

A rendering-agnostic kit for data visualization
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use crate::chromatic::Color;

/// Shape attributes for stroke and fill values.
///
/// Please note:
///
/// | Function | `fill_color` | `stroke_color` |
/// | -------- | ------------ | -------------- |
/// | [`ShapeAttrs::default`] | None | None |
/// | [`ShapeAttrs::fill_default`] | white color | None |
/// | [`ShapeAttrs::stroke_default`] | None | white color |
pub struct ShapeAttrs {
    /// Fill color (default: None)
    pub fill_color: Option<Color>,
    /// Fill opacity (default: 1.0)
    pub fill_opacity: f32,
    /// Stroke color (default: None)
    pub stroke_color: Option<Color>,
    /// Stroke width (default: 1.0)
    pub stroke_width: f32,
    /// Stroke opacity (default: 1.0)
    pub stroke_opacity: f32,
}

impl Default for ShapeAttrs {
    fn default() -> Self {
        Self {
            fill_color: None,
            fill_opacity: 1.,
            stroke_color: None,
            stroke_width: 1.,
            stroke_opacity: 1.,
        }
    }
}

impl ShapeAttrs {
    /// All default values but `fill_color` is white color.
    pub fn fill_default() -> Self {
        Self {
            fill_color: Some(Color::default()),
            fill_opacity: 1.,
            stroke_color: None,
            stroke_width: 1.,
            stroke_opacity: 1.,
        }
    }

    /// All default values but `stroke_color` is white color.
    pub fn stroke_default() -> Self {
        Self {
            fill_color: None,
            fill_opacity: 1.,
            stroke_color: Some(Color::default()),
            stroke_width: 1.,
            stroke_opacity: 1.,
        }
    }
}

/// Line attributes for stroke values.
pub struct LineAttrs {
    /// Stroke color (default: white color)
    pub stroke_color: Color,
    /// Stroke width (default: 1.0)
    pub stroke_width: f32,
    /// Stroke opacity (default: 1.0)
    pub stroke_opacity: f32,
}

impl Default for LineAttrs {
    fn default() -> Self {
        Self {
            stroke_color: Color::default(),
            stroke_width: 1.,
            stroke_opacity: 1.,
        }
    }
}

/// Text alignment variants used in [`TextAttrs`] and
/// [`TextProperties`][`crate::draw::TextProperties`]
#[derive(Default, Clone)]
pub enum Alignment {
    /// Indicates to align the text on the start
    Start,
    /// Indicates to align the text on the center (default variant)
    #[default]
    Center,
    /// Indicates to align the text on the end
    End,
}

/// Text attributes for text values, fill values and alignments.
pub struct TextAttrs {
    /// Fill color (default: white color)
    pub fill_color: Color,
    /// Font size (default: 12)
    pub font_size: f32,
    /// X-oriented text alignment (default: center)
    pub align_x: Alignment,
    /// Y-oriented text alignment (default: center)
    pub align_y: Alignment,
}

impl Default for TextAttrs {
    fn default() -> Self {
        Self {
            fill_color: Color::default(),
            font_size: 12.,
            align_x: Alignment::default(),
            align_y: Alignment::default(),
        }
    }
}

#[doc = concat!(
    "Arrow attributes for shape and color values.\n\n",
    include_str!("../../docs/arrow_attrs.svg"),
    "\n\n",
    "- The bend angle is defined by the three points _A_, _C_, and _B_.\n",
    "- The head angle is defined by the three points _S_, _B_, and _C_.\n",
    "- The head length is the distance between points _H_ and _B_."
)]
pub struct ArrowAttrs {
    /// Bend angle in degrees (default: 0.0)
    pub bend_angle: f32,
    /// Head angle in degrees (default: 60.0)
    pub head_angle: f32,
    /// Head length (default: 8.0)
    pub head_length: f32,
    /// Stroke color (default: white color)
    pub stroke_color: Color,
    /// Stroke width (default: 1.0)
    pub stroke_width: f32,
    /// Stroke opacity (default: 1.0)
    pub stroke_opacity: f32,
}

impl Default for ArrowAttrs {
    fn default() -> Self {
        Self {
            bend_angle: 0.,
            head_angle: 60.,
            head_length: 8.,
            stroke_color: Color::default(),
            stroke_width: 1.,
            stroke_opacity: 1.,
        }
    }
}