Struct plotters::chart::MeshStyle

[+] Show declaration

pub struct MeshStyle<'a, 'b, X: Ranged, Y: Ranged, DB> where
    DB: DrawingBackend,  { /* fields omitted */ }

[−] Expand description

The struct that is used for tracking the configuration of a mesh of any chart

Methods

impl<'a, 'b, X, Y, DB> MeshStyle<'a, 'b, X, Y, DB> where
    X: Ranged,
    Y: Ranged,
    DB: DrawingBackend, [−]

pub fn x_label_offset(&mut self, value: i32) -> &mut Self[+]

The offset of x labels. This is used when we want to place the label in the middle of the grid. This is useful if we are drawing a histogram

• value: The offset in pixel

pub fn disable_x_mesh(&mut self) -> &mut Self[+]

Disable the mesh for the x axis.

pub fn disable_y_mesh(&mut self) -> &mut Self[+]

Disable the mesh for the y axis

pub fn disable_x_axis(&mut self) -> &mut Self[+]

Disable drawing the X axis

pub fn disable_y_axis(&mut self) -> &mut Self[+]

Disable drawing the Y axis

pub fn axis_style<T: Into<ShapeStyle>>(&mut self, style: T) -> &mut Self[+]

Set the style definition for the axis

• style: The style for the axis

pub fn x_labels(&mut self, value: usize) -> &mut Self[+]

Set how many labels for the X axis at most

• value: The maximum desired number of labels in the X axis

pub fn y_labels(&mut self, value: usize) -> &mut Self[+]

Set how many label for the Y axis at most

• value: The maximum desired number of labels in the Y axis

pub fn line_style_1<T: Into<ShapeStyle>>(&mut self, style: T) -> &mut Self[+]

Set the style for the coarse grind grid

• style: This is the fcoarse grind grid style

pub fn line_style_2<T: Into<ShapeStyle>>(&mut self, style: T) -> &mut Self[+]

Set the style for the fine grind grid

• style: The fine grind grid style

pub fn label_style<T: Into<TextStyle<'b>>>(&mut self, style: T) -> &mut Self[+]

Set the style of the label text

• style: The text style that would be applied to the labels

pub fn x_label_formatter(
    &mut self,
    fmt: &'b dyn Fn(&X::ValueType) -> String
) -> &mut Self[+]

Set the formatter function for the X label text

• fmt: The formatter function

pub fn y_label_formatter(
    &mut self,
    fmt: &'b dyn Fn(&Y::ValueType) -> String
) -> &mut Self[+]

Set the formatter function for the Y label text

• fmt: The formatter function

pub fn axis_desc_style<T: Into<TextStyle<'b>>>(&mut self, style: T) -> &mut Self[+]

Set the axis description's style. If not given, use label style instead.

• style: The text style that would be applied to descriptions

pub fn x_desc<T: Into<String>>(&mut self, desc: T) -> &mut Self[+]

Set the X axis's description

• desc: The description of the X axis

pub fn y_desc<T: Into<String>>(&mut self, desc: T) -> &mut Self[+]

Set the Y axis's description

• desc: The description of the Y axis

pub fn draw(&mut self) -> Result<(), DrawingAreaErrorKind<DB::ErrorType>>[+]

Draw the configured mesh on the target plot