Struct BoxPlotState 

pub struct BoxPlotState { /* private fields */ }

State for a BoxPlot component.

Contains the datasets, display configuration, and interaction state.

Example

use envision::component::{BoxPlotState, BoxPlotData, BoxPlotOrientation};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("Service A", 10.0, 20.0, 30.0, 40.0, 50.0),
    BoxPlotData::new("Service B", 15.0, 25.0, 35.0, 45.0, 55.0),
])
.with_title("Latency Distribution")
.with_show_outliers(true);
assert_eq!(state.datasets().len(), 2);
assert_eq!(state.title(), Some("Latency Distribution"));
assert!(state.show_outliers());

Implementations

impl BoxPlotState

pub fn new(datasets: Vec<BoxPlotData>) -> Self

Creates a new box plot state with the given datasets.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
]);
assert_eq!(state.datasets().len(), 1);

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title (builder pattern).

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("Test", 1.0, 2.0, 3.0, 4.0, 5.0),
])
.with_title("My Box Plot");
assert_eq!(state.title(), Some("My Box Plot"));

pub fn with_show_outliers(self, show: bool) -> Self

Sets whether to show outliers (builder pattern).

Example

use envision::component::BoxPlotState;

let state = BoxPlotState::default().with_show_outliers(false);
assert!(!state.show_outliers());

pub fn with_orientation(self, orientation: BoxPlotOrientation) -> Self

Sets the orientation (builder pattern).

Example

use envision::component::{BoxPlotState, BoxPlotOrientation};

let state = BoxPlotState::default()
    .with_orientation(BoxPlotOrientation::Horizontal);
assert_eq!(state.orientation(), &BoxPlotOrientation::Horizontal);

pub fn datasets(&self) -> &[BoxPlotData]

Returns the datasets.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
    BoxPlotData::new("B", 2.0, 3.0, 4.0, 5.0, 6.0),
]);
assert_eq!(state.datasets().len(), 2);

pub fn datasets_mut(&mut self) -> &mut [BoxPlotData]

Returns a mutable reference to the datasets.

Example

use envision::component::{BoxPlotState, BoxPlotData};
use ratatui::style::Color;

let mut state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
]);
state.datasets_mut()[0].set_color(Color::Red);
assert_eq!(state.datasets()[0].color(), Color::Red);

pub fn get_dataset(&self, index: usize) -> Option<&BoxPlotData>

Returns the dataset at the given index.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("Service A", 1.0, 2.0, 3.0, 4.0, 5.0),
]);
assert_eq!(state.get_dataset(0).unwrap().label(), "Service A");
assert!(state.get_dataset(99).is_none());

pub fn get_dataset_mut(&mut self, index: usize) -> Option<&mut BoxPlotData>

Returns a mutable reference to the dataset at the given index.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let mut state = BoxPlotState::new(vec![
    BoxPlotData::new("Service A", 1.0, 2.0, 3.0, 4.0, 5.0),
]);
if let Some(ds) = state.get_dataset_mut(0) {
    ds.set_label("Service B");
}
assert_eq!(state.datasets()[0].label(), "Service B");

pub fn title(&self) -> Option<&str>

Returns the title.

Example

use envision::component::BoxPlotState;

let state = BoxPlotState::default().with_title("Latency");
assert_eq!(state.title(), Some("Latency"));

pub fn set_title(&mut self, title: Option<String>)

Sets the title.

Example

use envision::component::BoxPlotState;

let mut state = BoxPlotState::default();
state.set_title(Some("Response Times".to_string()));
assert_eq!(state.title(), Some("Response Times"));

pub fn show_outliers(&self) -> bool

Returns whether outliers are shown.

Example

use envision::component::BoxPlotState;

let state = BoxPlotState::default();
assert!(state.show_outliers());

pub fn set_show_outliers(&mut self, show: bool)

Sets whether outliers are shown.

Example

use envision::component::BoxPlotState;

let mut state = BoxPlotState::default();
state.set_show_outliers(false);
assert!(!state.show_outliers());

pub fn orientation(&self) -> &BoxPlotOrientation

Returns the orientation.

Example

use envision::component::{BoxPlotState, BoxPlotOrientation};

let state = BoxPlotState::default().with_orientation(BoxPlotOrientation::Horizontal);
assert_eq!(state.orientation(), &BoxPlotOrientation::Horizontal);

pub fn set_orientation(&mut self, orientation: BoxPlotOrientation)

Sets the orientation.

Example

use envision::component::{BoxPlotState, BoxPlotOrientation};

let mut state = BoxPlotState::default();
state.set_orientation(BoxPlotOrientation::Horizontal);
assert_eq!(state.orientation(), &BoxPlotOrientation::Horizontal);

pub fn selected(&self) -> usize

Returns the currently selected dataset index.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
]);
assert_eq!(state.selected(), 0);

pub fn set_selected(&mut self, index: usize)

Sets the selected dataset index.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let mut state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
    BoxPlotData::new("B", 2.0, 3.0, 4.0, 5.0, 6.0),
]);
state.set_selected(1);
assert_eq!(state.selected(), 1);

pub fn dataset_count(&self) -> usize

Returns the number of datasets.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
    BoxPlotData::new("B", 2.0, 3.0, 4.0, 5.0, 6.0),
]);
assert_eq!(state.dataset_count(), 2);

pub fn is_empty(&self) -> bool

Returns true if there are no datasets.

Example

use envision::component::BoxPlotState;

assert!(BoxPlotState::default().is_empty());

pub fn add_dataset(&mut self, dataset: BoxPlotData)

Adds a dataset.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let mut state = BoxPlotState::default();
state.add_dataset(BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0));
assert_eq!(state.dataset_count(), 1);

pub fn clear_datasets(&mut self)

Clears all datasets.

Example

use envision::component::{BoxPlotState, BoxPlotData};

let mut state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 1.0, 2.0, 3.0, 4.0, 5.0),
]);
state.clear_datasets();
assert!(state.is_empty());

pub fn global_min(&self) -> f64

Computes the global minimum value across all datasets (including outliers if show_outliers is enabled).

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 5.0, 10.0, 20.0, 30.0, 40.0),
    BoxPlotData::new("B", 8.0, 15.0, 25.0, 35.0, 50.0),
]);
assert_eq!(state.global_min(), 5.0);

pub fn global_max(&self) -> f64

Computes the global maximum value across all datasets (including outliers if show_outliers is enabled).

Example

use envision::component::{BoxPlotState, BoxPlotData};

let state = BoxPlotState::new(vec![
    BoxPlotData::new("A", 5.0, 10.0, 20.0, 30.0, 40.0),
    BoxPlotData::new("B", 8.0, 15.0, 25.0, 35.0, 50.0),
]);
assert_eq!(state.global_max(), 50.0);

pub fn update(&mut self, msg: BoxPlotMessage) -> Option<()>

Updates the state with a message, returning any output.

Trait Implementations

impl Clone for BoxPlotState

fn clone(&self) -> BoxPlotState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoxPlotState

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

Formats the value using the given formatter.

impl Default for BoxPlotState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BoxPlotState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BoxPlotState

fn eq(&self, other: &BoxPlotState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BoxPlotState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BoxPlotState