charming 0.1.2

A visualization library for Rust
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296

use serde::Serialize;

use crate::{
    datatype::CompositeValue,
    element::{Color, LinkTarget, Padding, TextAlign, TextStyle, TextVerticalAlign},
};

/// Title component, including main title and subtitle.
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Title {
    /// Component ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    id: Option<String>,

    /// Whether to show the title component.
    #[serde(skip_serializing_if = "Option::is_none")]
    show: Option<bool>,

    /// The main title text, supporting for `\n` for newlines.
    #[serde(skip_serializing_if = "Option::is_none")]
    text: Option<String>,

    /// The hyper link of main title text.
    #[serde(skip_serializing_if = "Option::is_none")]
    link: Option<String>,

    /// Open the hyper link of main title in specified target.
    #[serde(skip_serializing_if = "Option::is_none")]
    target: Option<LinkTarget>,

    /// The text style of main title.
    #[serde(skip_serializing_if = "Option::is_none")]
    text_style: Option<TextStyle>,

    /// The sub title text, supporting for `\n` for newlines.
    #[serde(skip_serializing_if = "Option::is_none")]
    subtext: Option<String>,

    /// The hyper link of sub title text.
    #[serde(skip_serializing_if = "Option::is_none")]
    sublink: Option<String>,

    /// Open the hyper link of sub title in specified target.
    #[serde(skip_serializing_if = "Option::is_none")]
    subtarget: Option<LinkTarget>,

    /// The text style of sub title.
    #[serde(skip_serializing_if = "Option::is_none")]
    subtext_style: Option<TextStyle>,

    /// The horizontal align of the component.
    #[serde(skip_serializing_if = "Option::is_none")]
    text_align: Option<TextAlign>,

    /// The vertical align of the component.
    #[serde(skip_serializing_if = "Option::is_none")]
    text_vertical_align: Option<TextVerticalAlign>,

    /// Title padding, the unit is px.
    #[serde(skip_serializing_if = "Option::is_none")]
    padding: Option<Padding>,

    /// The gap between the main title and the sub title, the unit is px.
    #[serde(skip_serializing_if = "Option::is_none")]
    item_gap: Option<f64>,

    /// The `zlevel` value of all graphical elements in the title.
    #[serde(skip_serializing_if = "Option::is_none")]
    zlevel: Option<f64>,

    /// The `z` value of all graphical elements in the title.
    #[serde(skip_serializing_if = "Option::is_none")]
    z: Option<f64>,

    /// Distance between title component and the left side of the container.
    #[serde(skip_serializing_if = "Option::is_none")]
    left: Option<CompositeValue>,

    /// Distance between title component and the top side of the container.
    #[serde(skip_serializing_if = "Option::is_none")]
    top: Option<CompositeValue>,

    /// Distance between title component and the right side of the container.
    #[serde(skip_serializing_if = "Option::is_none")]
    right: Option<CompositeValue>,

    /// Distance between title component and the bottom side of the container.
    #[serde(skip_serializing_if = "Option::is_none")]
    bottom: Option<CompositeValue>,

    /// Background color of title, default to be transparent.
    #[serde(skip_serializing_if = "Option::is_none")]
    background_color: Option<Color>,

    /// Border color of title.
    #[serde(skip_serializing_if = "Option::is_none")]
    border_color: Option<Color>,

    /// Border width of title.
    #[serde(skip_serializing_if = "Option::is_none")]
    border_width: Option<f64>,

    /// Border radius of title.
    #[serde(skip_serializing_if = "Option::is_none")]
    border_radius: Option<f64>,

    /// Shadow color of title.
    #[serde(skip_serializing_if = "Option::is_none")]
    shadow_color: Option<Color>,

    /// Size of shadow blur.
    #[serde(skip_serializing_if = "Option::is_none")]
    shadow_blur: Option<f64>,

    /// Offset distance on the horizontal direction of shadow.
    #[serde(skip_serializing_if = "Option::is_none")]
    shadow_offset_x: Option<f64>,

    /// Offset distance on the vertical direction of shadow.
    #[serde(skip_serializing_if = "Option::is_none")]
    shadow_offset_y: Option<f64>,
}

impl Title {
    pub fn new() -> Self {
        Self {
            id: None,
            show: None,
            text: None,
            link: None,
            target: None,
            text_style: None,
            subtext: None,
            sublink: None,
            subtarget: None,
            subtext_style: None,
            text_align: None,
            text_vertical_align: None,
            padding: None,
            item_gap: None,
            zlevel: None,
            z: None,
            left: None,
            top: None,
            right: None,
            bottom: None,
            background_color: None,
            border_color: None,
            border_width: None,
            border_radius: None,
            shadow_color: None,
            shadow_blur: None,
            shadow_offset_x: None,
            shadow_offset_y: None,
        }
    }

    pub fn show(mut self, show: bool) -> Self {
        self.show = Some(show);
        self
    }

    pub fn text<S: Into<String>>(mut self, text: S) -> Self {
        self.text = Some(text.into());
        self
    }

    pub fn link<S: Into<String>>(mut self, link: S) -> Self {
        self.link = Some(link.into());
        self
    }

    pub fn target<T: Into<LinkTarget>>(mut self, target: T) -> Self {
        self.target = Some(target.into());
        self
    }

    pub fn text_style<S: Into<TextStyle>>(mut self, text_style: S) -> Self {
        self.text_style = Some(text_style.into());
        self
    }

    pub fn subtext<S: Into<String>>(mut self, subtext: S) -> Self {
        self.subtext = Some(subtext.into());
        self
    }

    pub fn sublink<S: Into<String>>(mut self, sublink: S) -> Self {
        self.sublink = Some(sublink.into());
        self
    }

    pub fn subtarget<T: Into<LinkTarget>>(mut self, subtarget: T) -> Self {
        self.subtarget = Some(subtarget.into());
        self
    }

    pub fn subtext_style<S: Into<TextStyle>>(mut self, subtext_style: S) -> Self {
        self.subtext_style = Some(subtext_style.into());
        self
    }

    pub fn text_align<A: Into<TextAlign>>(mut self, text_align: A) -> Self {
        self.text_align = Some(text_align.into());
        self
    }

    pub fn text_vertical_align<A: Into<TextVerticalAlign>>(
        mut self,
        text_vertical_align: A,
    ) -> Self {
        self.text_vertical_align = Some(text_vertical_align.into());
        self
    }

    pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
        self.padding = Some(padding.into());
        self
    }

    pub fn item_gap<F: Into<f64>>(mut self, item_gap: F) -> Self {
        self.item_gap = Some(item_gap.into());
        self
    }

    pub fn zlevel<F: Into<f64>>(mut self, zlevel: F) -> Self {
        self.zlevel = Some(zlevel.into());
        self
    }

    pub fn z<F: Into<f64>>(mut self, z: F) -> Self {
        self.z = Some(z.into());
        self
    }

    pub fn left<C: Into<CompositeValue>>(mut self, left: C) -> Self {
        self.left = Some(left.into());
        self
    }

    pub fn top<C: Into<CompositeValue>>(mut self, top: C) -> Self {
        self.top = Some(top.into());
        self
    }

    pub fn right<C: Into<CompositeValue>>(mut self, right: C) -> Self {
        self.right = Some(right.into());
        self
    }

    pub fn bottom<C: Into<CompositeValue>>(mut self, bottom: C) -> Self {
        self.bottom = Some(bottom.into());
        self
    }

    pub fn background_color<C: Into<Color>>(mut self, background_color: C) -> Self {
        self.background_color = Some(background_color.into());
        self
    }

    pub fn border_color<C: Into<Color>>(mut self, border_color: C) -> Self {
        self.border_color = Some(border_color.into());
        self
    }

    pub fn border_width<F: Into<f64>>(mut self, border_width: F) -> Self {
        self.border_width = Some(border_width.into());
        self
    }

    pub fn border_radius<F: Into<f64>>(mut self, border_radius: F) -> Self {
        self.border_radius = Some(border_radius.into());
        self
    }

    pub fn shadow_color<C: Into<Color>>(mut self, shadow_color: C) -> Self {
        self.shadow_color = Some(shadow_color.into());
        self
    }

    pub fn shadow_blur<F: Into<f64>>(mut self, shadow_blur: F) -> Self {
        self.shadow_blur = Some(shadow_blur.into());
        self
    }

    pub fn shadow_offset_x<F: Into<f64>>(mut self, shadow_offset_x: F) -> Self {
        self.shadow_offset_x = Some(shadow_offset_x.into());
        self
    }

    pub fn shadow_offset_y<F: Into<f64>>(mut self, shadow_offset_y: F) -> Self {
        self.shadow_offset_y = Some(shadow_offset_y.into());
        self
    }
}