nominal-api 0.1239.0

API bindings for the Nominal platform
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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Hash
)]
#[serde(crate = "conjure_object::serde")]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct ChartThemeContentV1 {
    #[serde(rename = "titleEnabled")]
    title_enabled: bool,
    #[serde(rename = "titleAlignment")]
    title_alignment: super::TextAlignment,
    #[serde(rename = "titleFontSize")]
    title_font_size: i32,
    #[serde(rename = "titleFontColor")]
    title_font_color: super::HexColor,
    #[serde(rename = "captionEnabled")]
    caption_enabled: bool,
    #[serde(rename = "captionAlignment")]
    caption_alignment: super::TextAlignment,
    #[serde(rename = "captionFontSize")]
    caption_font_size: i32,
    #[serde(rename = "captionFontColor")]
    caption_font_color: super::HexColor,
    #[serde(rename = "backgroundEnabled")]
    background_enabled: bool,
    #[serde(rename = "legendEnabled")]
    legend_enabled: bool,
    #[serde(rename = "legendPosition")]
    legend_position: super::LegendPosition,
    #[serde(rename = "legendFontSize")]
    legend_font_size: i32,
    #[serde(rename = "legendFontColor")]
    legend_font_color: super::HexColor,
    #[serde(rename = "legendPlacement")]
    legend_placement: super::LegendPlacement,
    #[serde(rename = "rowGapEnabled")]
    row_gap_enabled: bool,
    #[builder(default, into)]
    #[serde(rename = "rowGapSize", skip_serializing_if = "Option::is_none", default)]
    row_gap_size: Option<i32>,
    #[serde(rename = "aspectRatioWidth")]
    aspect_ratio_width: i32,
    #[serde(rename = "aspectRatioHeight")]
    aspect_ratio_height: i32,
    #[builder(custom(type = super::ChartTypeThemes, convert = Box::new))]
    #[serde(rename = "chartTypeThemes")]
    chart_type_themes: Box<super::ChartTypeThemes>,
}
impl ChartThemeContentV1 {
    /// Whether to show a title in the export.
    #[inline]
    pub fn title_enabled(&self) -> bool {
        self.title_enabled
    }
    /// How to align the text of the title.
    #[inline]
    pub fn title_alignment(&self) -> &super::TextAlignment {
        &self.title_alignment
    }
    /// Font size of the title.
    #[inline]
    pub fn title_font_size(&self) -> i32 {
        self.title_font_size
    }
    /// Font color of the title.
    #[inline]
    pub fn title_font_color(&self) -> &super::HexColor {
        &self.title_font_color
    }
    /// Whether to show a caption in the export.
    #[inline]
    pub fn caption_enabled(&self) -> bool {
        self.caption_enabled
    }
    /// How to align the text of the caption.
    #[inline]
    pub fn caption_alignment(&self) -> &super::TextAlignment {
        &self.caption_alignment
    }
    /// Font size of the caption.
    #[inline]
    pub fn caption_font_size(&self) -> i32 {
        self.caption_font_size
    }
    /// Font color of the caption.
    #[inline]
    pub fn caption_font_color(&self) -> &super::HexColor {
        &self.caption_font_color
    }
    /// Whether to include a default background with the export.
    /// (`false` indicates that the background should be transparent)
    #[inline]
    pub fn background_enabled(&self) -> bool {
        self.background_enabled
    }
    /// Whether to include a legend in the export.
    #[inline]
    pub fn legend_enabled(&self) -> bool {
        self.legend_enabled
    }
    /// Which side the legend should appear on.
    #[inline]
    pub fn legend_position(&self) -> &super::LegendPosition {
        &self.legend_position
    }
    /// Font size of the legend.
    #[inline]
    pub fn legend_font_size(&self) -> i32 {
        self.legend_font_size
    }
    /// Font color of the legend.
    #[inline]
    pub fn legend_font_color(&self) -> &super::HexColor {
        &self.legend_font_color
    }
    /// Where on the chart the legend should be placed.
    #[inline]
    pub fn legend_placement(&self) -> &super::LegendPlacement {
        &self.legend_placement
    }
    /// Whether rows will be separated.
    #[inline]
    pub fn row_gap_enabled(&self) -> bool {
        self.row_gap_enabled
    }
    /// The size of the row gap.
    #[inline]
    pub fn row_gap_size(&self) -> Option<i32> {
        self.row_gap_size.as_ref().map(|o| *o)
    }
    /// The relative width of the chart export.
    #[inline]
    pub fn aspect_ratio_width(&self) -> i32 {
        self.aspect_ratio_width
    }
    /// The relative height of the chart export.
    #[inline]
    pub fn aspect_ratio_height(&self) -> i32 {
        self.aspect_ratio_height
    }
    /// Theme parameters specific to chart types.
    #[inline]
    pub fn chart_type_themes(&self) -> &super::ChartTypeThemes {
        &*self.chart_type_themes
    }
}