Struct Title

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

Implementations

impl<'a> Title<'a>

pub fn text(&mut self, text: &'a str) -> &mut Self

Sets the plot’s title. Note that before the existence of title.text, the title’s contents used to be defined as the title attribute itself. This behavior has been deprecated.

pub fn font(&mut self) -> &mut Font<'a>

Sets the title font. Note that the title’s font used to be customized by the now deprecated titlefont attribute.

pub fn xref(&mut self, xref: Xref) -> &mut Self

Sets the container x refers to. container spans the entire width of the plot. paper refers to the width of the plotting area only.

default: container

pub fn yref(&mut self, yref: Yref) -> &mut Self

Sets the container y refers to. container spans the entire height of the plot. paper refers to the height of the plotting area only.

default: container

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

Sets the x position with respect to xref in normalized coordinates from 0 (left) to 1 (right).

default: 0.5

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

Sets the y position with respect to yref in normalized coordinates from 0 (bottom) to 1 (top). auto places the baseline of the title onto the vertical center of the top margin.

default: auto

pub fn xanchor(&mut self, xanchor: Xanchor) -> &mut Self

Sets the title’s horizontal alignment with respect to its x position. left means that the title starts at x, right means that the title ends at x and center means that the title’s center is at x. auto divides xref by three and calculates the xanchor value automatically based on the value of x.

default: auto

pub fn yanchor(&mut self, yanchor: Yanchor) -> &mut Self

Sets the title’s vertical alignment with respect to its y position. top means that the title’s cap line is at y, bottom means that the title’s baseline is at y and middle means that the title’s midline is at y. auto divides yref by three and calculates the yanchor value automatically based on the value of y.

default: auto

pub fn pad(&mut self) -> &mut Pad

Sets the padding of the title. Each padding value only applies when the corresponding xanchor/yanchor value is set accordingly. E.g. for left padding to take effect, xanchor must be set to left. The same rule applies if xanchor/yanchor is determined automatically. Padding is muted if the respective anchor value is middle/center.

Trait Implementations

impl<'a> Default for Title<'a>

fn default() -> Title<'a>

Returns the “default value” for a type.

impl<'a> Serialize for Title<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.