Struct Matrix 

pub struct Matrix { /* private fields */ }

A container for table-based data entry.

Matrix is a specialized container that displays data in a table format where rows represent items/questions and columns represent possible values.

Value Format

For single-select (Radio/Dropdown):

{
  "row1_key": "column_value",
  "row2_key": "column_value"
}

For multi-select (Checkbox):

{
  "row1_key": ["value1", "value2"],
  "row2_key": ["value1"]
}

Example

use paramdef::container::Matrix;

// Satisfaction survey matrix
let satisfaction = Matrix::builder("satisfaction")
    .label("Rate your satisfaction")
    .rows([
        ("price", "Price"),
        ("quality", "Quality"),
        ("support", "Customer Support"),
    ])
    .columns([
        ("1", "Very Poor"),
        ("2", "Poor"),
        ("3", "Fair"),
        ("4", "Good"),
        ("5", "Excellent"),
    ])
    .required()
    .build()
    .unwrap();

// Value: { "price": "4", "quality": "5", "support": "3" }

Implementations

impl Matrix

pub fn builder(key: impl Into<Key>) -> MatrixBuilder

Creates a new builder for a Matrix.

pub fn flags(&self) -> Flags

Returns the flags for this matrix.

pub fn rows(&self) -> &[MatrixRow]

Returns all rows.

pub fn row_count(&self) -> usize

Returns the number of rows.

pub fn columns(&self) -> &[MatrixColumn]

Returns all columns.

pub fn column_count(&self) -> usize

Returns the number of columns.

pub fn cell_type(&self) -> MatrixCellType

Returns the cell type.

pub fn all_rows_required(&self) -> bool

Returns true if all rows are required to have a value.

pub fn show_row_numbers(&self) -> bool

Returns true if row numbers should be shown.

pub fn alternate_rows(&self) -> bool

Returns true if alternate row styling is enabled.

pub fn get_row(&self, key: &str) -> Option<&MatrixRow>

Gets a row by key.

pub fn get_column(&self, value: &str) -> Option<&MatrixColumn>

Gets a column by value.

pub fn exclusive_columns(&self) -> impl Iterator<Item = &MatrixColumn>

Returns exclusive columns (columns that deselect others when selected).

pub fn has_exclusive_columns(&self) -> bool

Returns true if this matrix has any exclusive columns.

pub fn row_keys(&self) -> impl Iterator<Item = &Key>

Returns an iterator over row keys.

pub fn column_values(&self) -> impl Iterator<Item = &SmartStr>

Returns an iterator over column values.

Trait Implementations

impl Clone for Matrix

fn clone(&self) -> Matrix

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Container for Matrix

fn children(&self) -> &[Arc<dyn Node>]

Returns all child nodes.

impl Debug for Matrix

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Node for Matrix

fn metadata(&self) -> &Metadata

Returns the node’s metadata.

fn key(&self) -> &Key

Returns the node’s unique key.

fn kind(&self) -> NodeKind

Returns the node’s kind (category).

fn as_any(&self) -> &dyn Any

Returns a reference to the underlying type for downcasting.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns a mutable reference to the underlying type for downcasting.