Struct plotters::chart::ChartBuilder

pub struct ChartBuilder<'a, 'b, DB: DrawingBackend> { /* fields omitted */ }

The helper object to create a chart context, which is used for the high-level figure drawing

Methods

impl<'a, 'b, DB: DrawingBackend> ChartBuilder<'a, 'b, DB>

pub fn on(root: &'a DrawingArea<DB, Shift>) -> Self

Create a chart builder on the given drawing area

• root: The root drawing area
• Returns: The chart builder object

pub fn margin(&mut self, size: u32) -> &mut Self

Set the margin size of the chart

• size: The size of the chart margin. If the chart builder is titled, we don't apply any margin

pub fn x_label_area_size(&mut self, size: u32) -> &mut Self

Set the size of X label area

• size: The height of the x label area, if x is 0, the chart doesn't have the X label area

pub fn y_label_area_size(&mut self, size: u32) -> &mut Self

Set the size of the Y label area

• size: The width of the Y label area. If size is 0, the chart doesn't have Y label area

pub fn caption<S: AsRef<str>, Style: Into<TextStyle<'b>>>(
    &mut self,
    caption: S,
    style: Style
) -> &mut Self

Set the caption of the chart

• caption: The caption of the chart
• style: The text style
• Note: If the caption is set, the margin option will be ignored

pub fn build_ranged<X: AsRangedCoord, Y: AsRangedCoord>(
    &mut self,
    x_spec: X,
    y_spec: Y
) -> Result<ChartContext<'a, DB, RangedCoord<X::CoordDescType, Y::CoordDescType>>, DrawingAreaErrorKind<DB::ErrorType>>

Build the chart with a 2D Cartesian coordinate system. The function will returns a chart context, where data series can be rendered on.

• x_spec: The specification of X axis
• y_spec: The specification of Y axis
• Returns: A chart context