nominal-api-conjure 0.1436.0

Conjure HTTP 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

/// A value table with three explicit layout modes: static, flow, and column.
/// Display settings live here rather than on the layout so a mode switch
/// preserves them; `column` has no home for them at all. The `grid` arm is
/// reused verbatim from V2, making a static V3 payload byte-identical to the
/// equivalent V2 one — the `v3` union tag is all that distinguishes them.
#[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 ValueTableDefinitionV3 {
    #[builder(default, into)]
    #[serde(rename = "title", skip_serializing_if = "Option::is_none", default)]
    title: Option<String>,
    #[builder(default, into)]
    #[serde(rename = "showUnits", skip_serializing_if = "Option::is_none", default)]
    show_units: Option<bool>,
    #[builder(default, into)]
    #[serde(
        rename = "showStalenessIndicator",
        skip_serializing_if = "Option::is_none",
        default
    )]
    show_staleness_indicator: Option<bool>,
    #[builder(default, into)]
    #[serde(rename = "showCellLabels", skip_serializing_if = "Option::is_none", default)]
    show_cell_labels: Option<bool>,
    #[builder(default, into)]
    #[serde(
        rename = "showColumnHeaders",
        skip_serializing_if = "Option::is_none",
        default
    )]
    show_column_headers: Option<bool>,
    #[builder(default, into)]
    #[serde(rename = "showRowHeaders", skip_serializing_if = "Option::is_none", default)]
    show_row_headers: Option<bool>,
    #[builder(default, into)]
    #[serde(rename = "rowHeaderWidth", skip_serializing_if = "Option::is_none", default)]
    #[derive_with(with = conjure_object::private::DoubleWrapper)]
    row_header_width: Option<f64>,
    #[builder(custom(type = super::ValueTableMultiCellConfig, convert = Box::new))]
    #[serde(rename = "gridDefaultCellConfigs")]
    grid_default_cell_configs: Box<super::ValueTableMultiCellConfig>,
    #[builder(custom(type = super::ValueTableLayoutV2, convert = Box::new))]
    #[serde(rename = "layout")]
    layout: Box<super::ValueTableLayoutV2>,
}
impl ValueTableDefinitionV3 {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        grid_default_cell_configs: super::ValueTableMultiCellConfig,
        layout: super::ValueTableLayoutV2,
    ) -> Self {
        Self::builder()
            .grid_default_cell_configs(grid_default_cell_configs)
            .layout(layout)
            .build()
    }
    /// The display title of the panel.
    #[inline]
    pub fn title(&self) -> Option<&str> {
        self.title.as_ref().map(|o| &**o)
    }
    /// If true, display units in the cells when available.
    #[inline]
    pub fn show_units(&self) -> Option<bool> {
        self.show_units.as_ref().map(|o| *o)
    }
    /// If true, display staleness indicator in the cells when available.
    #[inline]
    pub fn show_staleness_indicator(&self) -> Option<bool> {
        self.show_staleness_indicator.as_ref().map(|o| *o)
    }
    /// If true, display channel names in the cells.
    #[inline]
    pub fn show_cell_labels(&self) -> Option<bool> {
        self.show_cell_labels.as_ref().map(|o| *o)
    }
    /// If true, display column headers.
    #[inline]
    pub fn show_column_headers(&self) -> Option<bool> {
        self.show_column_headers.as_ref().map(|o| *o)
    }
    /// If true, display row headers.
    #[inline]
    pub fn show_row_headers(&self) -> Option<bool> {
        self.show_row_headers.as_ref().map(|o| *o)
    }
    /// The width of the row headers in pixels.
    #[inline]
    pub fn row_header_width(&self) -> Option<f64> {
        self.row_header_width.as_ref().map(|o| *o)
    }
    /// Panel-level defaults for cell visualisations, applying to every layout mode.
    #[inline]
    pub fn grid_default_cell_configs(&self) -> &super::ValueTableMultiCellConfig {
        &*self.grid_default_cell_configs
    }
    #[inline]
    pub fn layout(&self) -> &super::ValueTableLayoutV2 {
        &*self.layout
    }
}