Struct plotters::chart::MeshStyle

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

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

Implementations

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

pub fn set_all_tick_mark_size<S: SizeDesc>(&mut self, value: S) -> &mut Self

Set all the tick mark to the same size value: The new size

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

Set the tick mark size on the axes. When this is set to negative, the axis value label will become inward.

• pos: The which label area we want to set
• value: The size specification

pub fn x_label_offset<S: SizeDesc>(&mut self, value: S) -> &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 used to adjust label position for histograms, but since plotters 0.3, this use case is deprecated, see SegmentedCoord coord decorator for more details

• value: The offset in pixel

pub fn y_label_offset<S: SizeDesc>(&mut self, value: S) -> &mut Self

The offset of y labels. This is used when we want to place the label in the middle of the grid. This is used to adjust label position for histograms, but since plotters 0.3, this use case is deprecated, see SegmentedCoord coord decorator for more details

• 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 disable_mesh(&mut self) -> &mut Self

Disable drawing all meshes

pub fn disable_axes(&mut self) -> &mut Self

Disable drawing all axes

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_max_light_lines(&mut self, value: usize) -> &mut Self

Set the maximum number of divisions for the minor grid

• value: Maximum desired divisions between two consecutive X labels

pub fn y_max_light_lines(&mut self, value: usize) -> &mut Self

Set the maximum number of divisions for the minor grid

• value: Maximum desired divisions between two consecutive Y labels

pub fn max_light_lines(&mut self, value: usize) -> &mut Self

Set the maximum number of divisions for the minor grid

• value: Maximum desired divisions between two consecutive labels in X and Y

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 bold_line_style<T: Into<ShapeStyle>>(&mut self, style: T) -> &mut Self

Set the style for the coarse grind grid

• style: This is the coarse grind grid style

pub fn light_line_style<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: IntoTextStyle<'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_style<T: IntoTextStyle<'b>>(&mut self, style: T) -> &mut Self

Set the style of the label X axis text

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

pub fn y_label_style<T: IntoTextStyle<'b>>(&mut self, style: T) -> &mut Self

Set the style of the label Y axis 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: IntoTextStyle<'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>> where
    X: ValueFormatter<<X as Ranged>::ValueType>,
    Y: ValueFormatter<<Y as Ranged>::ValueType>, 

Draw the configured mesh on the target plot