Struct vega_lite_3::Header

pub struct Header {
    pub format: Option<String>,
    pub format_type: Option<FormatType>,
    pub label_align: Option<Align>,
    pub label_anchor: Option<TitleAnchor>,
    pub label_angle: Option<f64>,
    pub label_color: Option<String>,
    pub label_font: Option<String>,
    pub label_font_size: Option<f64>,
    pub label_limit: Option<f64>,
    pub label_orient: Option<Orient>,
    pub label_padding: Option<f64>,
    pub title: Option<String>,
    pub title_align: Option<Align>,
    pub title_anchor: Option<TitleAnchor>,
    pub title_angle: Option<f64>,
    pub title_baseline: Option<TextBaseline>,
    pub title_color: Option<String>,
    pub title_font: Option<String>,
    pub title_font_size: Option<f64>,
    pub title_font_weight: Option<FontWeight>,
    pub title_limit: Option<f64>,
    pub title_orient: Option<Orient>,
    pub title_padding: Option<f64>,
}

An object defining properties of a facet's header.

Headers of row / column channels for faceted plots.

Fields

format: Option<String>

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.

format_type: Option<FormatType>

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.

label_align: Option<Align>

Horizontal text alignment of header labels.

label_anchor: Option<TitleAnchor>

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.

label_angle: Option<f64>

The rotation angle of the header labels.

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

label_color: Option<String>

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

label_font: Option<String>

The font of the header label.

label_font_size: Option<f64>

The font size of the header label, in pixels.

label_limit: Option<f64>

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

label_orient: Option<Orient>

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

label_padding: Option<f64>

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

Default value: 10

title: Option<String>

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.

title_align: Option<Align>

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

title_anchor: Option<TitleAnchor>

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.

title_angle: Option<f64>

The rotation angle of the header title.

Default value: 0.

title_baseline: Option<TextBaseline>

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

Default value: "middle"

title_color: Option<String>

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

title_font: Option<String>

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

title_font_size: Option<f64>

Font size of the header title.

title_font_weight: Option<FontWeight>

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).

title_limit: Option<f64>

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

title_orient: Option<Orient>

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

title_padding: Option<f64>

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

Default value: 10

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for Header

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Header

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.