Struct plotters::element::MultiLineText

pub struct MultiLineText<'a, Coord, T: Borrow<str>> { /* fields omitted */ }

An multi-line text element. The Text element allows only single line text and the MultiLineText supports drawing multiple lines

Methods

impl<'a, Coord, T: Borrow<str>> MultiLineText<'a, Coord, T>

pub fn new<S: Into<TextStyle<'a>>>(pos: Coord, style: S) -> Self

Create an empty multi-line text element. Lines can be append to the empty multi-line by calling push_line method

pos: The upper left corner style: The style of the text

pub fn set_line_height(&mut self, value: f64) -> &mut Self

Set the line height of the multi-line text element

pub fn push_line<L: Into<T>>(&mut self, line: L)

Push a new line into the given multi-line text line: The line to be pushed

pub fn estimate_dimension(&self) -> FontResult<(i32, i32)>

Estimate the multi-line text element's dimension

pub fn relocate(&mut self, coord: Coord)

Move the location to the specified location

impl<'a, T: Borrow<str>> MultiLineText<'a, BackendCoord, T>

pub fn compute_line_layout(&self) -> FontResult<Vec<LayoutBox>>

Compute the line layout

impl<'a, Coord> MultiLineText<'a, Coord, &'a str>

pub fn from_str<ST: Into<&'a str>, S: Into<TextStyle<'a>>>(
    text: ST,
    pos: Coord,
    style: S,
    max_width: u32
) -> Self

Parse a multi-line text into an multi-line element.

text: The text that is parsed pos: The position of the text style: The style for this text max_width: The width of the multi-line text element, the line will break into two lines if the line is wider than the max_width. If 0 is given, do not do any line wrapping

impl<'a, Coord> MultiLineText<'a, Coord, String>

pub fn from_string<S: Into<TextStyle<'a>>>(
    text: String,
    pos: Coord,
    style: S,
    max_width: u32
) -> Self

Parse a multi-line text into an multi-line element.

text: The text that is parsed pos: The position of the text style: The style for this text max_width: The width of the multi-line text element, the line will break into two lines if the line is wider than the max_width. If 0 is given, do not do any line wrapping

Trait Implementations

impl<'b, 'a, Coord: 'a, T: Borrow<str> + 'a> PointCollection<'a, Coord> for &'a MultiLineText<'b, Coord, T>

type Borrow = &'a Coord

The item in point iterator

type IntoIter = Once<&'a Coord>

The point iterator

fn point_iter(self) -> Self::IntoIter

framework to do the coordinate mapping

impl<'a, Coord: 'a, DB: DrawingBackend, T: Borrow<str>> Drawable<DB> for MultiLineText<'a, Coord, T>

fn draw<I: Iterator<Item = BackendCoord>>(
    &self,
    points: I,
    backend: &mut DB,
    _: (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