Struct BoxPlot 

pub struct BoxPlot<C> { /* private fields */ }

A single box-and-whisker, positioned at one coordinate on the category axis.

Generic over the full chart coordinate C so the same type serves both orientations: a vertical box lives on a (X, f64) chart, a horizontal box on a (f64, Y) chart. Use BoxPlot::vertical / BoxPlot::horizontal to construct one; the width is measured in pixels, so it is independent of the axis scale.

use plotters::prelude::*;
use plotters_statistical::BoxPlot;

let root = SVGBackend::new("one_box.svg", (400, 300)).into_drawing_area();
let mut chart = ChartBuilder::on(&root)
    .build_cartesian_2d(0.5f64..1.5f64, 0f64..10f64)?;
let bx = BoxPlot::vertical(1.0f64, &[1.0, 2.0, 3.0, 4.0, 9.0])?;
chart.draw_series(std::iter::once(bx))?;

Implementations

impl<X: Clone> BoxPlot<(X, f64)>

pub fn vertical(x: X, data: &[f64]) -> Result<Self, StatsError>

A vertical box at category position x, computed from a raw data sample. Errors if the sample has no finite values.

pub fn vertical_from_quartiles(x: X, q: &Quartiles) -> Self

A vertical box from already-computed Quartiles — useful when the summary was produced elsewhere (e.g. streamed) and the raw sample is no longer held.

impl<Y: Clone> BoxPlot<(f64, Y)>

pub fn horizontal(y: Y, data: &[f64]) -> Result<Self, StatsError>

A horizontal box at category position y, computed from a raw data sample. Errors if the sample has no finite values.

pub fn horizontal_from_quartiles(y: Y, q: &Quartiles) -> Self

A horizontal box from already-computed Quartiles.

impl<C> BoxPlot<C>

pub fn width(self, width: u32) -> Self

Set the box width in pixels (default 24).

pub fn style(self, style: BoxStyle) -> Self

Replace the entire style block.

pub fn with_style(self, f: impl FnOnce(&mut BoxStyle)) -> Self

Mutate the style in place (for tweaking one property).

Trait Implementations

impl<C: Clone> Clone for BoxPlot<C>

fn clone(&self) -> BoxPlot<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for BoxPlot<C>

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

Formats the value using the given formatter.

impl<C, DB: DrawingBackend> Drawable<DB> for BoxPlot<C>

fn draw<I: Iterator<Item = BackendCoord>>( &self, points: I, backend: &mut DB, _parent_dim: (u32, u32), ) -> Result<(), DrawingErrorKind<DB::ErrorType>>

Actually draws the element. The key points is already translated into the image coordinate and can be used by DC directly

impl<'a, C: 'a> PointCollection<'a, C> for &'a BoxPlot<C>

type Point = &'a C

The item in point iterator

type IntoIter = &'a [C]

The point iterator

fn point_iter(self) -> &'a [C]

framework to do the coordinate mapping