Struct Header 

pub struct Header {
    pub values: Option<Vec<String>>,
    pub height: Option<f64>,
    pub align: Option<String>,
    pub font: Option<String>,
    pub fill: Option<Rgb>,
}

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();

Fields

values: Option<Vec<String>>

height: Option<f64>

align: Option<String>

font: Option<String>

fill: Option<Rgb>

Implementations

impl Header

pub fn new() -> Header

Creates a new Header instance with default values.

Examples found in repository

examples/plotly_table.rs (line 6)

fn main() {
    let dataset = CsvReader::new("data/employee_data.csv").finish().unwrap();

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

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .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>) -> Header

Sets custom header values.

Argument

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

Examples found in repository

examples/plotly_table.rs (lines 7-12)

fn main() {
    let dataset = CsvReader::new("data/employee_data.csv").finish().unwrap();

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

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .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) -> Header

Sets the height of the header.

Argument

• height - A f64 value specifying the header height.

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

Sets the alignment of the header text.

Argument

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

Examples found in repository

examples/plotly_table.rs (line 13)

fn main() {
    let dataset = CsvReader::new("data/employee_data.csv").finish().unwrap();

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

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .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) -> Header

Sets the font family of the header text.

Argument

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

Examples found in repository

examples/plotly_table.rs (line 14)

fn main() {
    let dataset = CsvReader::new("data/employee_data.csv").finish().unwrap();

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

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .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) -> Header

Sets the fill color of the header.

Argument

• fill - An Rgb value specifying the background color.

Examples found in repository

examples/plotly_table.rs (line 15)

fn main() {
    let dataset = CsvReader::new("data/employee_data.csv").finish().unwrap();

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

    let cell = Cell::new()
        .align("center")
        .height(25.0)
        .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.