Struct fdg_img::style::FontDesc

pub struct FontDesc<'a> { /* private fields */ }

Describes a font

Implementations

impl<'a> FontDesc<'a>

pub fn new(family: FontFamily<'a>, size: f64, style: FontStyle) -> FontDesc<'a>

Create a new font

• family: The font family name
• size: The size of the font
• style: The font variations
• returns The newly created font description

pub fn resize(&self, size: f64) -> FontDesc<'a>

Create a new font desc with the same font but different size

• size: The new size to set
• returns The newly created font descriptor with a new size

pub fn style(&self, style: FontStyle) -> FontDesc<'a>

Set the style of the font

• style: The new style
• returns The new font description with this style applied

pub fn transform(&self, trans: FontTransform) -> FontDesc<'a>

Set the font transformation

• trans: The new transformation
• returns The new font description with this font transformation applied

pub fn get_transform(&self) -> FontTransform

Get the font transformation description

pub fn color<C>(&self, color: &C) -> TextStyle<'a>where
    C: Color,

Returns a new text style object with the specified color.

Example

use plotters::prelude::*;
let text_style = ("sans-serif", 20).into_font().color(&RED);
let drawing_area = SVGBackend::new("font_desc_color.svg", (200, 100)).into_drawing_area();
drawing_area.fill(&WHITE).unwrap();
drawing_area.draw_text("This is a big red label", &text_style, (10, 50));

The result is a text label colorized accordingly:

See also

IntoTextStyle::with_color()

IntoTextStyle::into_text_style() for a more succinct example

pub fn get_family(&self) -> FontFamily<'_>

Returns the font family

pub fn get_name(&self) -> &str

Get the name of the font

pub fn get_style(&self) -> FontStyle

Get the name of the style

pub fn get_size(&self) -> f64

Get the size of font

pub fn layout_box(
    &self,
    text: &str
) -> Result<((i32, i32), (i32, i32)), <FontDataInternal as FontData>::ErrorType>

Get the size of the text if rendered in this font

For a TTF type, zero point of the layout box is the left most baseline char of the string Thus the upper bound of the box is most likely be negative

pub fn box_size(
    &self,
    text: &str
) -> Result<(u32, u32), <FontDataInternal as FontData>::ErrorType>

Get the size of the text if rendered in this font. This is similar to layout_box function, but it apply the font transformation and estimate the overall size of the font

pub fn draw<E, DrawFunc>(
    &self,
    text: &str,
    (i32, i32),
    draw: DrawFunc
) -> Result<Result<(), E>, <FontDataInternal as FontData>::ErrorType>where
    DrawFunc: FnMut(i32, i32, f32) -> Result<(), E>,

Actually draws a font with a drawing function

Trait Implementations

impl<'a> Clone for FontDesc<'a>

fn clone(&self) -> FontDesc<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> From<&'a str> for FontDesc<'a>

fn from(from: &'a str) -> FontDesc<'a>

Converts to this type from the input type.

impl<'a, T, S> From<(&'a str, T, S)> for FontDesc<'a>where
    T: Into<f64>,
    S: Into<FontStyle>,

fn from((&'a str, T, S)) -> FontDesc<'a>

Converts to this type from the input type.

impl<'a, T> From<(&'a str, T)> for FontDesc<'a>where
    T: Into<f64>,

fn from((&'a str, T)) -> FontDesc<'a>

Converts to this type from the input type.

impl<'a, T, S> From<(FontFamily<'a>, T, S)> for FontDesc<'a>where
    T: Into<f64>,
    S: Into<FontStyle>,

fn from((FontFamily<'a>, T, S)) -> FontDesc<'a>

Converts to this type from the input type.

impl<'a, T> From<(FontFamily<'a>, T)> for FontDesc<'a>where
    T: Into<f64>,

fn from((FontFamily<'a>, T)) -> FontDesc<'a>

Converts to this type from the input type.

impl<'a> From<FontFamily<'a>> for FontDesc<'a>

fn from(family: FontFamily<'a>) -> FontDesc<'a>

Converts to this type from the input type.

impl<'a> IntoTextStyle<'a> for FontDesc<'a>

fn into_text_style<P>(self, &P) -> TextStyle<'a>where
    P: HasDimension,

Converts the value into a TextStyle value.

fn with_color<C>(self, color: C) -> TextStyleBuilder<'a, Self>where
    C: Color,

Specifies the color of the text element

fn with_anchor<C>(self, pos: Pos) -> TextStyleBuilder<'a, Self>where
    C: Color,

Specifies the position of the text anchor relative to the text element