Struct BoxPlot 

pub struct BoxPlot { /* private fields */ }

A diagram containing a series of BoxElem elements.

Implementations

impl BoxPlot

pub fn new(name: impl Into<String>, boxes: Vec<BoxElem>) -> Self

Create a plot containing multiple boxes. It defaults to vertically oriented elements.

pub fn color(self, color: impl Into<Color32>) -> Self

Set the default color. It is set on all elements that do not already have a specific color. This is the color that shows up in the legend. It can be overridden at the element level (see BoxElem). Default is Color32::TRANSPARENT which means a color will be auto-assigned.

pub fn vertical(self) -> Self

Set all elements to be in a vertical orientation. Argument axis will be X and values will be on the Y axis.

pub fn horizontal(self) -> Self

Set all elements to be in a horizontal orientation. Argument axis will be Y and values will be on the X axis.

pub fn element_formatter( self, formatter: Box<dyn Fn(&BoxElem, &Self) -> String>, ) -> Self

Add a custom way to format an element. Can be used to display a set number of decimals or custom labels.

pub fn name(self, name: impl ToString) -> Self

Name of this plot item.

This name will show up in the plot legend, if legends are turned on.

Setting the name via this method does not change the item’s id, so you can use it to change the name dynamically between frames without losing the item’s state. You should make sure the name passed to Self::new is unique and stable for each item, or set unique and stable ids explicitly via Self::id.

pub fn highlight(self, highlight: bool) -> Self

Highlight this plot item, typically by scaling it up.

If false, the item may still be highlighted via user interaction.

pub fn allow_hover(self, hovering: bool) -> Self

Allowed hovering this item in the plot. Default: true.

pub fn id(self, id: impl Into<Id>) -> Self

Sets the id of this plot item.

By default the id is determined from the name passed to Self::new, but it can be explicitly set to a different value.

Trait Implementations

impl PlotItem for BoxPlot

fn shapes(&self, _ui: &Ui, transform: &PlotTransform, shapes: &mut Vec<Shape>)

fn initialize(&mut self, _x_range: RangeInclusive<f64>)

For plot-items which are generated based on x values (plotting functions).

fn color(&self) -> Color32

fn geometry(&self) -> PlotGeometry<'_>

fn bounds(&self) -> PlotBounds

fn find_closest( &self, point: Pos2, transform: &PlotTransform, ) -> Option<ClosestElem>

fn on_hover( &self, _plot_area_response: &Response, elem: ClosestElem, shapes: &mut Vec<Shape>, cursors: &mut Vec<Cursor>, plot: &PlotConfig<'_>, _: &LabelFormatter<'_>, )

fn base(&self) -> &PlotItemBase

fn base_mut(&mut self) -> &mut PlotItemBase

fn name(&self) -> &str

fn highlight(&mut self)

fn highlighted(&self) -> bool

fn allow_hover(&self) -> bool

Can the user hover this item?

fn id(&self) -> Id