plotly 0.14.1

A plotting library powered by Plotly.js
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

//! Open-high-low-close (OHLC) trace

use plotly_derive::FieldSetter;
use serde::Serialize;

use crate::{
    common::{
        Calendar, Dim, Direction, HoverInfo, Label, LegendGroupTitle, Line, PlotType, Visible,
    },
    Trace,
};

/// Construct an OHLC trace.
///
/// # Examples
///
/// ```
/// use plotly::Ohlc;
///
/// let trace = Ohlc::new(
///     vec!["2022-08-22", "2022-08-23"],
///     vec![5, 6],
///     vec![8, 10],
///     vec![2, 4],
///     vec![6, 7],
/// );
///
/// let expected = serde_json::json!({
///     "type": "ohlc",
///     "x": ["2022-08-22", "2022-08-23"],
///     "open": [5, 6],
///     "high": [8, 10],
///     "low": [2, 4],
///     "close": [6, 7]
/// });
///
/// assert_eq!(serde_json::to_value(trace).unwrap(), expected);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Serialize, Debug, Clone, FieldSetter)]
pub struct Ohlc<X, O>
where
    X: Serialize + Clone,
    O: Serialize + Clone,
{
    #[field_setter(default = "PlotType::Ohlc")]
    r#type: PlotType,
    x: Option<Vec<X>>,
    open: Option<Vec<O>>,
    high: Option<Vec<O>>,
    low: Option<Vec<O>>,
    close: Option<Vec<O>>,
    decreasing: Option<Direction>,
    #[serde(rename = "hoverinfo")]
    hover_info: Option<HoverInfo>,
    #[serde(rename = "hoverlabel")]
    hover_label: Option<Label>,
    #[serde(rename = "hovertext")]
    hover_text: Option<Dim<String>>,
    increasing: Option<Direction>,
    #[serde(rename = "legendgroup")]
    legend_group: Option<String>,
    #[serde(rename = "legendgrouptitle")]
    legend_group_title: Option<LegendGroupTitle>,
    line: Option<Line>,
    name: Option<String>,
    opacity: Option<f64>,
    #[serde(rename = "showlegend")]
    show_legend: Option<bool>,
    text: Option<Dim<String>>,
    #[serde(rename = "tickwidth")]
    tick_width: Option<f64>,
    visible: Option<Visible>,
    #[serde(rename = "xcalendar")]
    x_calendar: Option<Calendar>,
}

impl<X, O> Ohlc<X, O>
where
    X: Serialize + Clone,
    O: Serialize + Clone,
{
    pub fn new(x: Vec<X>, open: Vec<O>, high: Vec<O>, low: Vec<O>, close: Vec<O>) -> Box<Self> {
        Box::new(Ohlc {
            r#type: PlotType::Ohlc,
            x: Some(x),
            open: Some(open),
            high: Some(high),
            low: Some(low),
            close: Some(close),
            ..Default::default()
        })
    }
}

impl<X, O> Trace for Ohlc<X, O>
where
    X: Serialize + Clone,
    O: Serialize + Clone,
{
    fn to_json(&self) -> String {
        serde_json::to_string(self).unwrap()
    }
}

#[cfg(test)]
mod test {
    use serde_json::{json, to_value};

    use super::*;

    #[test]
    fn serialize_default_ohlc() {
        let trace = Ohlc::<u32, u32>::default();
        let expected = json!({"type": "ohlc"});

        assert_eq!(to_value(trace).unwrap(), expected);
    }

    #[test]
    fn serialize_ohlc() {
        let trace = Ohlc::new(
            vec![0, 1],
            vec![5.0, 6.0],
            vec![10.0, 15.0],
            vec![4.0, 2.0],
            vec![6.0, 13.0],
        )
        .decreasing(Direction::Decreasing { line: Line::new() })
        .hover_info(HoverInfo::X)
        .hover_label(Label::new())
        .hover_text_array(vec!["1", "2"])
        .hover_text("1")
        .increasing(Direction::Increasing { line: Line::new() })
        .legend_group("legendgroup")
        .legend_group_title("Legend Group Title")
        .line(Line::new())
        .name("ohlc_trace")
        .opacity(0.4)
        .show_legend(true)
        .text_array(vec!["3", "4"])
        .text("3")
        .tick_width(0.1)
        .visible(Visible::LegendOnly)
        .x_calendar(Calendar::Nepali);

        let expected = json!({
            "type": "ohlc",
            "x": [0, 1],
            "open": [5.0, 6.0],
            "high": [10.0, 15.0],
            "low": [4.0, 2.0],
            "close": [6.0, 13.0],
            "decreasing": {"line": {}},
            "hoverinfo": "x",
            "hoverlabel": {},
            "hovertext": "1",
            "increasing": {"line": {}},
            "legendgroup": "legendgroup",
            "legendgrouptitle": {"text": "Legend Group Title"},
            "line": {},
            "name": "ohlc_trace",
            "opacity": 0.4,
            "showlegend": true,
            "text": "3",
            "tickwidth": 0.1,
            "visible": "legendonly",
            "xcalendar": "nepali"
        });

        assert_eq!(to_value(trace).unwrap(), expected);
    }
}