Struct vega_lite_4::HeaderBuilder

pub struct HeaderBuilder { /* fields omitted */ }

Builder for Header.

Implementations

impl HeaderBuilder

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

When used with the default "number" and "time" format type, 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.

When used with a custom formatType, this value will be passed as format alongside datum.value to the registered function.

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

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

The format type for labels. One of "number", "time", or a registered custom format type.

Default value: - "time" for temporal fields and ordinal and nominal fields with timeUnit. - "number" for quantitative fields as well as ordinal and nominal fields without timeUnit.

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

Horizontal text alignment of header labels. One of "left", "center", or "right".

pub fn label_anchor<VALUE: Into<TitleAnchorEnum>>(
    &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_baseline<VALUE: Into<TextBaseline>>(
    &mut self,
    value: VALUE
) -> &mut Self

The vertical text baseline for the header labels. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", or "line-bottom". The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the titleLineHeight rather than titleFontSize alone.

pub fn label_color<VALUE: Into<Color>>(&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_expr<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Vega expression for customizing labels.

Note: The label text and value can be assessed via the label and value properties of the header's backing datum object.

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

The font of the header label.

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

The font size of the header label, in pixels.

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

The font style of the header label.

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

The font weight of the header label.

pub fn label_limit<VALUE: Into<CornerRadiusUnion>>(
    &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_line_height<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Line height in pixels for multi-line header labels or title text with "line-top" or "line-bottom" baseline.

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<CornerRadiusUnion>>(
    &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 orient<VALUE: Into<Orient>>(&mut self, value: VALUE) -> &mut Self

Shortcut for setting both labelOrient and titleOrient.

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

A title for the field. If null, the title will be removed.

Default value: derived from the field's name and transformation function (aggregate, bin and timeUnit). If the field has an aggregate function, the function is displayed as part of the title (e.g., "Sum of Profit"). If the field is binned or has a time unit applied, the applied function is shown in parentheses (e.g., "Profit (binned)", "Transaction Date (year-month)"). Otherwise, the title is simply the field name.

Notes:

1. You can customize the default field title format by providing the fieldTitle property in the config or fieldTitle function via the compile function's options.

2. If both field definition's title and axis, header, or legend title are defined, axis/header/legend title will be used.

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

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

pub fn title_anchor<VALUE: Into<TitleAnchorEnum>>(
    &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

The vertical text baseline for the header title. One of "alphabetic" (default), "top", "middle", "bottom", "line-top", or "line-bottom". The "line-top" and "line-bottom" values operate similarly to "top" and "bottom", but are calculated relative to the titleLineHeight rather than titleFontSize alone.

Default value: "middle"

pub fn title_color<VALUE: Into<Color>>(&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<Color>>(&mut self, value: VALUE) -> &mut Self

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

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

Font size of the header title.

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

The font style of the header title.

pub fn title_font_weight<VALUE: Into<FontWeightUnion>>(
    &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<CornerRadiusUnion>>(
    &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_line_height<VALUE: Into<CornerRadiusUnion>>(
    &mut self,
    value: VALUE
) -> &mut Self

Line height in pixels for multi-line header title text or title text with "line-top" or "line-bottom" baseline.

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<CornerRadiusUnion>>(
    &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<Header, String>

Builds a new Header.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for HeaderBuilder

pub fn clone(&self) -> HeaderBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for HeaderBuilder

pub fn default() -> HeaderBuilder

Returns the "default value" for a type.