Struct vega_lite_3::HeaderConfigBuilder

pub struct HeaderConfigBuilder { /* fields omitted */ }

Builder for HeaderConfig.

Methods

impl HeaderConfigBuilder

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

The text formatting pattern for labels of guides (axes, legends, headers) and text marks.

• If the format type is "number" (e.g., for quantitative fields), this is D3's number format pattern.
• If the format type is "time" (e.g., for temporal fields), this is D3's time format pattern.

See the format documentation for more examples.

Default value: Derived from numberFormat config for number format and from timeFormat config for time format.

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

The format type for labels ("number" or "time").

Default value:

• "time" for temporal fields and ordinal and nomimal fields with timeUnit.
• "number" for quantitative fields as well as ordinal and nomimal fields without timeUnit.

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

Horizontal text alignment of header labels.

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

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

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

The rotation angle of the header labels.

Default value: 0 for column header, -90 for row header.

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

The color of the header label, can be in hex color code or regular color name.

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

The font of the header label.

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

The font size of the header label, in pixels.

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

The font style of the header label.

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

The maximum length of the header label in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.

Default value: 0, indicating no limit

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

The orientation of the header label. One of "top", "bottom", "left" or "right".

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

The padding, in pixel, between facet header's label and the plot.

Default value: 10

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

A boolean flag indicating if labels should be included as part of the header.

Default value: true.

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

Whether month names and weekday names should be abbreviated.

Default value: false

pub fn title<VALUE: Into<RemovableValue<Value>>>(
    &mut self,
    value: VALUE
) -> &mut Self

Set to null to disable title for the axis, legend, or header.

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

Horizontal text alignment (to the anchor) of header titles.

pub fn title_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.

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

The rotation angle of the header title.

Default value: 0.

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

Vertical text baseline for the header title. One of "top", "bottom", "middle".

Default value: "middle"

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

Color of the header title, can be in hex color code or regular color name.

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

Font of the header title. (e.g., "Helvetica Neue").

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

Font size of the header title.

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

The font style of the header title.

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

Font weight of the header title. 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 title_limit<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self

The maximum length of the header title in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.

Default value: 0, indicating no limit

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

The orientation of the header title. One of "top", "bottom", "left" or "right".

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

The padding, in pixel, between facet header's title and the label.

Default value: 10

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

Builds a new HeaderConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for HeaderConfigBuilder

fn clone(&self) -> HeaderConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for HeaderConfigBuilder

fn default() -> HeaderConfigBuilder

Returns the "default value" for a type.