Struct plotly::traces::box_plot::BoxPlot

pub struct BoxPlot<X, Y>
where
    X: Serialize + Clone,
    Y: Serialize + Clone,
{ /* private fields */ }

Construct a box trace.

Examples

use plotly::{BoxPlot, box_plot::BoxPoints};

let trace = BoxPlot::new(vec![0, 1, 2, 3, 4, 5])
    .box_points(BoxPoints::All)
    .jitter(0.3)
    .point_pos(-1.8);

let expected = serde_json::json!({
    "type": "box",
    "y": [0, 1, 2, 3, 4, 5],
    "boxpoints": "all",
    "jitter": 0.3,
    "pointpos": -1.8
});

assert_eq!(serde_json::to_value(trace).unwrap(), expected);

Implementations

impl<X, Y> BoxPlot<X, Y>

where X: Serialize + Clone, Y: Serialize + Clone,

pub fn x(self, value: Vec<X>) -> Box<Self>

pub fn modify_all_x(value: Vec<X>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_x(values: Vec<Vec<X>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn y(self, value: Vec<Y>) -> Box<Self>

pub fn modify_all_y(value: Vec<Y>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_y(values: Vec<Vec<Y>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn name(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_name(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_name(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn visible(self, value: Visible) -> Box<Self>

pub fn modify_all_visible(value: Visible) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_visible(values: Vec<Visible>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn show_legend(self, value: bool) -> Box<Self>

pub fn modify_all_show_legend(value: bool) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_show_legend(values: Vec<bool>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn legend_group(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_legend_group(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_legend_group(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn legend_group_title(self, value: impl Into<LegendGroupTitle>) -> Box<Self>

pub fn modify_all_legend_group_title( value: impl Into<LegendGroupTitle>, ) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_legend_group_title( values: Vec<impl Into<LegendGroupTitle>>, ) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn opacity(self, value: f64) -> Box<Self>

pub fn modify_all_opacity(value: f64) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_opacity(values: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn ids(self, value: Vec<impl AsRef<str>>) -> Box<Self>

pub fn modify_all_ids(value: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_ids(values: Vec<Vec<impl AsRef<str>>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn width(self, value: usize) -> Box<Self>

pub fn modify_all_width(value: usize) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_width(values: Vec<usize>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_text(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_text(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text_array(self, value: Vec<impl AsRef<str>>) -> Box<Self>

pub fn hover_text(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_hover_text(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_hover_text(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_text_array(self, value: Vec<impl AsRef<str>>) -> Box<Self>

pub fn hover_info(self, value: HoverInfo) -> Box<Self>

pub fn modify_all_hover_info(value: HoverInfo) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_hover_info(values: Vec<HoverInfo>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_template(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_hover_template(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_hover_template( values: Vec<impl AsRef<str>>, ) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_template_array(self, value: Vec<impl AsRef<str>>) -> Box<Self>

pub fn x_axis(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_x_axis(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_x_axis(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn y_axis(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_y_axis(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_y_axis(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn orientation(self, value: Orientation) -> Box<Self>

pub fn modify_all_orientation(value: Orientation) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_orientation(values: Vec<Orientation>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn alignment_group(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_alignment_group( value: impl AsRef<str>, ) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_alignment_group( values: Vec<impl AsRef<str>>, ) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn offset_group(self, value: impl AsRef<str>) -> Box<Self>

pub fn modify_all_offset_group(value: impl AsRef<str>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_offset_group(values: Vec<impl AsRef<str>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn marker(self, value: Marker) -> Box<Self>

pub fn modify_all_marker(value: Marker) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_marker(values: Vec<Marker>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn line(self, value: Line) -> Box<Self>

pub fn modify_all_line(value: Line) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_line(values: Vec<Line>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn box_mean(self, value: BoxMean) -> Box<Self>

pub fn modify_all_box_mean(value: BoxMean) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_box_mean(values: Vec<BoxMean>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn box_points(self, value: BoxPoints) -> Box<Self>

pub fn modify_all_box_points(value: BoxPoints) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_box_points(values: Vec<BoxPoints>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn notched(self, value: bool) -> Box<Self>

pub fn modify_all_notched(value: bool) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_notched(values: Vec<bool>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn notch_width(self, value: f64) -> Box<Self>

pub fn modify_all_notch_width(value: f64) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_notch_width(values: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn whisker_width(self, value: f64) -> Box<Self>

pub fn modify_all_whisker_width(value: f64) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_whisker_width(values: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn q1(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_q1(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_q1(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn median(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_median(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_median(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn q3(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_q3(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_q3(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn upper_fence(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_upper_fence(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_upper_fence(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn lower_fence(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_lower_fence(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_lower_fence(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn notch_span(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_notch_span(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_notch_span(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn mean(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_mean(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_mean(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn standard_deviation(self, value: Vec<f64>) -> Box<Self>

pub fn modify_all_standard_deviation(value: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_standard_deviation(values: Vec<Vec<f64>>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn quartile_method(self, value: QuartileMethod) -> Box<Self>

pub fn modify_all_quartile_method(value: QuartileMethod) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_quartile_method( values: Vec<QuartileMethod>, ) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn fill_color(self, value: impl Color) -> Box<Self>

pub fn modify_all_fill_color(value: impl Color) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_fill_color(values: Vec<impl Color>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_label(self, value: Label) -> Box<Self>

pub fn modify_all_hover_label(value: Label) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_hover_label(values: Vec<Label>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_on(self, value: HoverOn) -> Box<Self>

pub fn modify_all_hover_on(value: HoverOn) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_hover_on(values: Vec<HoverOn>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn point_pos(self, value: f64) -> Box<Self>

pub fn modify_all_point_pos(value: f64) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_point_pos(values: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn jitter(self, value: f64) -> Box<Self>

pub fn modify_all_jitter(value: f64) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_jitter(values: Vec<f64>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn x_calendar(self, value: Calendar) -> Box<Self>

pub fn modify_all_x_calendar(value: Calendar) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_x_calendar(values: Vec<Calendar>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn y_calendar(self, value: Calendar) -> Box<Self>

pub fn modify_all_y_calendar(value: Calendar) -> RestyleBoxPlot<X, Y>

Apply the same restyling to all the traces

pub fn modify_y_calendar(values: Vec<Calendar>) -> RestyleBoxPlot<X, Y>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

impl<Y> BoxPlot<f64, Y>

where Y: Serialize + Clone,

pub fn new(y: Vec<Y>) -> Box<BoxPlot<f64, Y>>

impl<X, Y> BoxPlot<X, Y>

where X: Serialize + Clone, Y: Serialize + Clone,

pub fn new_xy(x: Vec<X>, y: Vec<Y>) -> Box<Self>

Trait Implementations

impl<X, Y> Clone for BoxPlot<X, Y>

where X: Serialize + Clone + Clone, Y: Serialize + Clone + Clone,

fn clone(&self) -> BoxPlot<X, Y>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<X, Y> Debug for BoxPlot<X, Y>

where X: Serialize + Clone + Debug, Y: Serialize + Clone + Debug,

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

Formats the value using the given formatter.

impl<X, Y> Default for BoxPlot<X, Y>

where X: Serialize + Clone, Y: Serialize + Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<X, Y> Serialize for BoxPlot<X, Y>

where X: Serialize + Clone + Serialize, Y: Serialize + Clone + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<X, Y> Trace for BoxPlot<X, Y>

where X: Serialize + Clone, Y: Serialize + Clone,

fn to_json(&self) -> String