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

/// A 2D grid layout for the value table where cells are laid out in specific
/// rows and columns. Supports hierarchical cell visualisation configurations, favoring when present:
/// the cell's own definition, then the column's, then the row's, then the panel's.
#[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 ValueTableLayoutGrid {
    #[builder(default, into)]
    #[serde(rename = "showRowHeaders", skip_serializing_if = "Option::is_none", default)]
    show_row_headers: 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 = "showCellLabels", skip_serializing_if = "Option::is_none", default)]
    show_cell_labels: Option<bool>,
    #[builder(custom(type = super::ValueTableMultiCellConfig, convert = Box::new))]
    #[serde(rename = "gridDefaultCellConfigs")]
    grid_default_cell_configs: Box<super::ValueTableMultiCellConfig>,
    #[builder(default, list(item(type = super::ValueTableGridRowColumnConfig)))]
    #[serde(rename = "columnConfigs", skip_serializing_if = "Vec::is_empty", default)]
    column_configs: Vec<super::ValueTableGridRowColumnConfig>,
    #[builder(default, list(item(type = super::ValueTableGridRowColumnConfig)))]
    #[serde(rename = "rowConfigs", skip_serializing_if = "Vec::is_empty", default)]
    row_configs: Vec<super::ValueTableGridRowColumnConfig>,
    #[serde(rename = "rowCount")]
    row_count: i32,
    #[serde(rename = "columnCount")]
    column_count: i32,
    #[builder(default, list(item(type = super::ValueTableGridValueTableCell)))]
    #[serde(rename = "cells", skip_serializing_if = "Vec::is_empty", default)]
    cells: Vec<super::ValueTableGridValueTableCell>,
}
impl ValueTableLayoutGrid {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        grid_default_cell_configs: super::ValueTableMultiCellConfig,
        row_count: i32,
        column_count: i32,
    ) -> Self {
        Self::builder()
            .grid_default_cell_configs(grid_default_cell_configs)
            .row_count(row_count)
            .column_count(column_count)
            .build()
    }
    /// If true, display row headers.
    #[inline]
    pub fn show_row_headers(&self) -> Option<bool> {
        self.show_row_headers.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 channel names in the cells.
    #[inline]
    pub fn show_cell_labels(&self) -> Option<bool> {
        self.show_cell_labels.as_ref().map(|o| *o)
    }
    /// Panel-level defaults for cell visualisations
    #[inline]
    pub fn grid_default_cell_configs(&self) -> &super::ValueTableMultiCellConfig {
        &*self.grid_default_cell_configs
    }
    /// Column-level configurations.
    #[inline]
    pub fn column_configs(&self) -> &[super::ValueTableGridRowColumnConfig] {
        &*self.column_configs
    }
    /// Row-level configurations.
    #[inline]
    pub fn row_configs(&self) -> &[super::ValueTableGridRowColumnConfig] {
        &*self.row_configs
    }
    #[inline]
    pub fn row_count(&self) -> i32 {
        self.row_count
    }
    #[inline]
    pub fn column_count(&self) -> i32 {
        self.column_count
    }
    /// An array of cells to display in the table.
    #[inline]
    pub fn cells(&self) -> &[super::ValueTableGridValueTableCell] {
        &*self.cells
    }
}