Struct plotters_unstable::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. With the help of this object, we can convert a basic drawing area into a chart context, which allows the high-level charting API being used on the drawing area.

Implementations

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<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the margin size of the chart (applied for top, bottom, left and right at the same time)

• size: The size of the chart margin.

pub fn margin_top<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the top margin of current chart

• size: The size of the top margin.

pub fn margin_bottom<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the bottom margin of current chart

• size: The size of the bottom margin.

pub fn margin_left<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the left margin of current chart

• size: The size of the left margin.

pub fn margin_right<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the right margin of current chart

• size: The size of the right margin.

pub fn set_all_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set all the label area size with the same value

pub fn set_left_and_bottom_label_area_size<S: SizeDesc>(
    &mut self,
    size: S
) -> &mut Self

Set the most commonly used label area size to the same value

pub fn x_label_area_size<S: SizeDesc>(&mut self, size: S) -> &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<S: SizeDesc>(&mut self, size: S) -> &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 top_x_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the size of X label area on the top of the chart

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

pub fn right_y_label_area_size<S: SizeDesc>(&mut self, size: S) -> &mut Self

Set the size of the Y label area on the right side

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

pub fn set_label_area_size<S: SizeDesc>(
    &mut self,
    pos: LabelAreaPosition,
    size: S
) -> &mut Self

Set a label area size

• pos: THe position where the label area located
• size: The size of the label area size

pub fn caption<S: AsRef<str>, Style: IntoTextStyle<'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, Cartesian2d<X::CoordDescType, Y::CoordDescType>>, DrawingAreaErrorKind<DB::ErrorType>>

👎 Deprecated:

build_ranged has been renamed to build_cartesian_2d and is to be removed in the future.

pub fn build_cartesian_2d<X: AsRangedCoord, Y: AsRangedCoord>(
    &mut self,
    x_spec: X,
    y_spec: Y
) -> Result<ChartContext<'a, DB, Cartesian2d<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