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

#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct CartesianChartDefinitionV1 {
    #[builder(default, list(item(type = super::CartesianPlot)))]
    #[serde(rename = "plots", skip_serializing_if = "Vec::is_empty", default)]
    plots: Vec<super::CartesianPlot>,
    #[builder(default, into)]
    #[serde(rename = "events", skip_serializing_if = "Option::is_none", default)]
    events: Option<Vec<super::Event>>,
    #[builder(
        default,
        list(item(type = super::super::super::comparisonrun::api::ComparisonRunGroup))
    )]
    #[serde(
        rename = "comparisonRunGroups",
        skip_serializing_if = "Vec::is_empty",
        default
    )]
    comparison_run_groups: Vec<
        super::super::super::comparisonrun::api::ComparisonRunGroup,
    >,
    #[builder(default, into)]
    #[serde(rename = "title", skip_serializing_if = "Option::is_none", default)]
    title: Option<String>,
    #[builder(default, list(item(type = super::ValueAxis)))]
    #[serde(rename = "valueAxes", skip_serializing_if = "Vec::is_empty", default)]
    value_axes: Vec<super::ValueAxis>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::ScatterDecimation>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "decimation", skip_serializing_if = "Option::is_none", default)]
    decimation: Option<Box<super::ScatterDecimation>>,
    #[builder(default, into)]
    #[serde(rename = "connectPoints", skip_serializing_if = "Option::is_none", default)]
    connect_points: Option<bool>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::FloatingLegendConfig>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "floatingLegendsConfig",
        skip_serializing_if = "Option::is_none",
        default
    )]
    floating_legends_config: Option<Box<super::FloatingLegendConfig>>,
}
impl CartesianChartDefinitionV1 {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new() -> Self {
        Self::builder().build()
    }
    #[inline]
    pub fn plots(&self) -> &[super::CartesianPlot] {
        &*self.plots
    }
    #[deprecated(note = "Please use the workbook's eventRefs field instead.")]
    #[inline]
    pub fn events(&self) -> Option<&[super::Event]> {
        self.events.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn comparison_run_groups(
        &self,
    ) -> &[super::super::super::comparisonrun::api::ComparisonRunGroup] {
        &*self.comparison_run_groups
    }
    #[inline]
    pub fn title(&self) -> Option<&str> {
        self.title.as_ref().map(|o| &**o)
    }
    #[inline]
    pub fn value_axes(&self) -> &[super::ValueAxis] {
        &*self.value_axes
    }
    /// The strategy for bucketing points together.
    #[inline]
    pub fn decimation(&self) -> Option<&super::ScatterDecimation> {
        self.decimation.as_ref().map(|o| &**o)
    }
    /// If toggled true, will visually connect the points of the series
    #[inline]
    pub fn connect_points(&self) -> Option<bool> {
        self.connect_points.as_ref().map(|o| *o)
    }
    /// Config for showing a floating legend in the chart. If undefined, defaults to hiding.
    #[inline]
    pub fn floating_legends_config(&self) -> Option<&super::FloatingLegendConfig> {
        self.floating_legends_config.as_ref().map(|o| &**o)
    }
}