Struct Header 

pub struct Header { /* private fields */ }

A structure representing header formatting for tables.

The Header struct allows customization of table headers including custom values, height, alignment, font, and fill color.

Example

use plotlars::{Table, Header, Plot, Text, Rgb};
use polars::prelude::*;

let dataset = df![
    "name" => &["Alice", "Bob", "Charlie"],
    "age" => &[25, 30, 35],
    "city" => &["New York", "London", "Tokyo"]
]
.unwrap();

let header = Header::new()
    .values(vec!["Full Name", "Years", "Location"])
    .height(40.0)
    .align("center")
    .font("Arial")
    .fill(Rgb(200, 200, 200));

Table::builder()
    .data(&dataset)
    .columns(vec!["name", "age", "city"])
    .header(&header)
    .plot_title(Text::from("Employee Information"))
    .build()
    .plot();

Implementations

impl Header

pub fn new() -> Self

Creates a new Header instance with default values.

Examples found in repository

examples/table.rs (line 14)

fn main() {
    let dataset = df![
        "name" => &["Alice Johnson", "Bob Smith", "Charlie Davis", "Diana Martinez", "Eva Wilson"],
        "department" => &["Engineering", "Marketing", "Engineering", "Sales", "Marketing"],
        "salary" => &[95000, 78000, 102000, 85000, 82000],
        "years" => &[5, 3, 7, 4, 2]
    ]
    .unwrap();

    let header = Header::new()
        .values(vec![
            "Employee Name",
            "Department",
            "Annual Salary ($)",
            "Years of Service",
        ])
        .align("center")
        .font("Arial Bold")
        .fill(Rgb(70, 130, 180));

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .font("Arial")
        .fill(Rgb(240, 248, 255));

    Table::builder()
        .data(&dataset)
        .columns(vec!["name", "department", "salary", "years"])
        .header(&header)
        .cell(&cell)
        .plot_title(
            Text::from("Employee Data")
                .font("Arial")
                .size(20)
                .color(Rgb(25, 25, 112)),
        )
        .build()
        .plot();
}

pub fn values(self, values: Vec<&str>) -> Self

Sets custom header values.

Argument

• values - A vector of string slices representing custom header names.

Examples found in repository

examples/table.rs (lines 15-20)

fn main() {
    let dataset = df![
        "name" => &["Alice Johnson", "Bob Smith", "Charlie Davis", "Diana Martinez", "Eva Wilson"],
        "department" => &["Engineering", "Marketing", "Engineering", "Sales", "Marketing"],
        "salary" => &[95000, 78000, 102000, 85000, 82000],
        "years" => &[5, 3, 7, 4, 2]
    ]
    .unwrap();

    let header = Header::new()
        .values(vec![
            "Employee Name",
            "Department",
            "Annual Salary ($)",
            "Years of Service",
        ])
        .align("center")
        .font("Arial Bold")
        .fill(Rgb(70, 130, 180));

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .font("Arial")
        .fill(Rgb(240, 248, 255));

    Table::builder()
        .data(&dataset)
        .columns(vec!["name", "department", "salary", "years"])
        .header(&header)
        .cell(&cell)
        .plot_title(
            Text::from("Employee Data")
                .font("Arial")
                .size(20)
                .color(Rgb(25, 25, 112)),
        )
        .build()
        .plot();
}

pub fn height(self, height: f64) -> Self

Sets the height of the header.

Argument

• height - A f64 value specifying the header height.

pub fn align(self, align: impl Into<String>) -> Self

Sets the alignment of the header text.

Argument

• align - A string specifying the alignment (left, center, right).

Examples found in repository

examples/table.rs (line 21)

fn main() {
    let dataset = df![
        "name" => &["Alice Johnson", "Bob Smith", "Charlie Davis", "Diana Martinez", "Eva Wilson"],
        "department" => &["Engineering", "Marketing", "Engineering", "Sales", "Marketing"],
        "salary" => &[95000, 78000, 102000, 85000, 82000],
        "years" => &[5, 3, 7, 4, 2]
    ]
    .unwrap();

    let header = Header::new()
        .values(vec![
            "Employee Name",
            "Department",
            "Annual Salary ($)",
            "Years of Service",
        ])
        .align("center")
        .font("Arial Bold")
        .fill(Rgb(70, 130, 180));

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .font("Arial")
        .fill(Rgb(240, 248, 255));

    Table::builder()
        .data(&dataset)
        .columns(vec!["name", "department", "salary", "years"])
        .header(&header)
        .cell(&cell)
        .plot_title(
            Text::from("Employee Data")
                .font("Arial")
                .size(20)
                .color(Rgb(25, 25, 112)),
        )
        .build()
        .plot();
}

pub fn font(self, font: &str) -> Self

Sets the font family of the header text.

Argument

• font - A string slice specifying the font family name.

Examples found in repository

examples/table.rs (line 22)

fn main() {
    let dataset = df![
        "name" => &["Alice Johnson", "Bob Smith", "Charlie Davis", "Diana Martinez", "Eva Wilson"],
        "department" => &["Engineering", "Marketing", "Engineering", "Sales", "Marketing"],
        "salary" => &[95000, 78000, 102000, 85000, 82000],
        "years" => &[5, 3, 7, 4, 2]
    ]
    .unwrap();

    let header = Header::new()
        .values(vec![
            "Employee Name",
            "Department",
            "Annual Salary ($)",
            "Years of Service",
        ])
        .align("center")
        .font("Arial Bold")
        .fill(Rgb(70, 130, 180));

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .font("Arial")
        .fill(Rgb(240, 248, 255));

    Table::builder()
        .data(&dataset)
        .columns(vec!["name", "department", "salary", "years"])
        .header(&header)
        .cell(&cell)
        .plot_title(
            Text::from("Employee Data")
                .font("Arial")
                .size(20)
                .color(Rgb(25, 25, 112)),
        )
        .build()
        .plot();
}

pub fn fill(self, fill: Rgb) -> Self

Sets the fill color of the header.

Argument

• fill - An Rgb value specifying the background color.

Examples found in repository

examples/table.rs (line 23)

fn main() {
    let dataset = df![
        "name" => &["Alice Johnson", "Bob Smith", "Charlie Davis", "Diana Martinez", "Eva Wilson"],
        "department" => &["Engineering", "Marketing", "Engineering", "Sales", "Marketing"],
        "salary" => &[95000, 78000, 102000, 85000, 82000],
        "years" => &[5, 3, 7, 4, 2]
    ]
    .unwrap();

    let header = Header::new()
        .values(vec![
            "Employee Name",
            "Department",
            "Annual Salary ($)",
            "Years of Service",
        ])
        .align("center")
        .font("Arial Bold")
        .fill(Rgb(70, 130, 180));

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .font("Arial")
        .fill(Rgb(240, 248, 255));

    Table::builder()
        .data(&dataset)
        .columns(vec!["name", "department", "salary", "years"])
        .header(&header)
        .cell(&cell)
        .plot_title(
            Text::from("Employee Data")
                .font("Arial")
                .size(20)
                .color(Rgb(25, 25, 112)),
        )
        .build()
        .plot();
}

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.