Struct vega_lite_3::TitleParamsBuilder

pub struct TitleParamsBuilder { /* fields omitted */ }

Builder for TitleParams.

Methods

impl TitleParamsBuilder

pub fn align<VALUE: Into<Align>>(&mut self, value: VALUE) -> &mut Self

pub fn anchor<VALUE: Into<TitleAnchor>>(&mut self, value: VALUE) -> &mut Self

The anchor position for placing the title. One of "start", "middle", or "end". For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

Default value: "middle" for single and layered views. "start" for other composite views.

Note: For now, anchor is only customizable only for single and layered views. For other composite views, anchor is always "start".

pub fn angle<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Angle in degrees of title text.

pub fn baseline<VALUE: Into<TextBaseline>>(&mut self, value: VALUE) -> &mut Self

Vertical text baseline for title text. One of "top", "middle", "bottom", or "alphabetic".

pub fn color<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Text color for title text.

pub fn dx<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Delta offset for title text x-coordinate.

pub fn dy<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Delta offset for title text y-coordinate.

pub fn font<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Font name for title text.

pub fn font_size<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

Font size in pixels for title text.

Default value: 10.

pub fn font_style<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Font style for title text.

pub fn font_weight<VALUE: Into<FontWeight>>(
    &mut self,
    value: VALUE
) -> &mut Self

Font weight for title text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, ..., 900 where "normal" = 400 and "bold" = 700).

pub fn frame<VALUE: Into<TitleFrame>>(&mut self, value: VALUE) -> &mut Self

The reference frame for the anchor position, one of "bounds" (to anchor relative to the full bounding box) or "group" (to anchor relative to the group width or height).

pub fn limit<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

The maximum allowed length in pixels of legend labels.

pub fn offset<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.

pub fn orient<VALUE: Into<TitleOrient>>(&mut self, value: VALUE) -> &mut Self

Default title orientation ("top", "bottom", "left", or "right")

pub fn style<VALUE: Into<Style>>(&mut self, value: VALUE) -> &mut Self

A mark style property to apply to the title text mark.

Default value: "group-title".

pub fn text<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The title text.

pub fn zindex<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

The integer z-index indicating the layering of the title group relative to other axis, mark and legend groups.

Default value: 0.

pub fn build(&self) -> Result<TitleParams, String>

Builds a new TitleParams.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for TitleParamsBuilder

fn clone(&self) -> TitleParamsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TitleParamsBuilder

fn default() -> TitleParamsBuilder

Returns the "default value" for a type.