Struct TimeSeriesPlot

pub struct TimeSeriesPlot { /* private fields */ }

A structure representing a time series plot.

The TimeSeriesPlot struct facilitates the creation and customization of time series plots with various options for data selection, grouping, layout configuration, and aesthetic adjustments. It supports the addition of multiple series, customization of marker shapes, colors, sizes, opacity settings, and comprehensive layout customization including titles, axes, and legends.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• x - A string slice specifying the column name to be used for the x-axis, typically representing time or dates.
• y - A string slice specifying the column name to be used for the y-axis, typically representing the primary metric.
• additional_series - An optional vector of string slices specifying additional y-axis columns to be plotted as series.
• size - An optional usize specifying the size of the markers or line thickness.
• color - An optional Rgb value specifying the color of the markers. This is used when group is not specified.
• colors - An optional vector of Rgb values specifying the colors for the markers. This is used when group is specified to differentiate between groups.
• with_shape - An optional bool indicating whether to use shapes for markers in the plot.
• shape - An optional Shape specifying the shape of the markers. This is used when group is not specified.
• shapes - An optional vector of Shape values specifying multiple shapes for the markers when plotting multiple groups.
• width - An optional f64 specifying the width of the plotted lines.
• line - An optional LineStyle specifying the style of the line. This is used when additional_series is not specified.
• lines - An optional vector of LineStyle enums specifying the styles of lines for each plotted series. This is used when additional_series is specified to differentiate between multiple series.
• plot_title - An optional Text struct specifying the title of the plot.
• x_title - An optional Text struct specifying the title of the x-axis.
• y_title - An optional Text struct specifying the title of the y-axis.
• legend_title - An optional Text struct specifying the title of the legend.
• x_axis - An optional reference to an Axis struct for customizing the x-axis.
• y_axis - An optional reference to an Axis struct for customizing the y-axis.
• y_axis2 - An optional reference to an Axis struct for customizing the y-axis2.
• legend - An optional reference to a Legend struct for customizing the legend of the plot (e.g., positioning, font, etc.).

Examples

use plotlars::{Axis, Legend, Line, Plot, Rgb, Shape, Text, TimeSeriesPlot};

let dataset = LazyCsvReader::new("data/revenue_and_cost.csv")
    .finish()
    .unwrap()
    .select([
        col("Date").cast(DataType::String),
        col("Revenue").cast(DataType::Int32),
        col("Cost").cast(DataType::Int32),
    ])
    .collect()
    .unwrap();

TimeSeriesPlot::builder()
    .data(&dataset)
    .x("Date")
    .y("Revenue")
    .additional_series(vec!["Cost"])
    .size(8)
    .colors(vec![
        Rgb(0, 0, 255),
        Rgb(255, 0, 0),
    ])
    .lines(vec![Line::Dash, Line::Solid])
    .with_shape(true)
    .shapes(vec![Shape::Circle, Shape::Square])
    .plot_title(
        Text::from("Time Series Plot")
            .font("Arial")
            .size(18)
    )
    .legend(
        &Legend::new()
            .x(0.05)
            .y(0.9)
    )
    .x_title("x")
    .y_title(
        Text::from("y")
            .color(Rgb(0, 0, 255))
    )
    .y_title2(
        Text::from("y2")
            .color(Rgb(255, 0, 0))
    )
    .y_axis(
        &Axis::new()
            .value_color(Rgb(0, 0, 255))
            .show_grid(false)
            .zero_line_color(Rgb(0, 0, 0))
    )
    .y_axis2(
        &Axis::new()
            .axis_side(plotlars::AxisSide::Right)
            .value_color(Rgb(255, 0, 0))
            .show_grid(false)
    )
    .build()
    .plot();

let dataset = LazyCsvReader::new("data/debilt_2023_temps.csv")
    .with_has_header(true)
    .with_try_parse_dates(true)
    .finish()
    .unwrap()
    .with_columns(vec![
        (col("tavg") / lit(10)).alias("tavg"),
        (col("tmin") / lit(10)).alias("tmin"),
        (col("tmax") / lit(10)).alias("tmax"),
    ])
    .collect()
    .unwrap();

    TimeSeriesPlot::builder()
    .data(&dataset)
    .x("date")
    .y("tavg")
    .additional_series(vec!["tmin", "tmax"])
    .colors(vec![
        Rgb(128, 128, 128),
        Rgb(0, 122, 255),
        Rgb(255, 128, 0),
    ])
    .lines(vec![
        Line::Solid,
        Line::Dot,
        Line::Dot,
    ])
    .plot_title("Temperature at De Bilt (2023)")
    .legend_title("Legend")
    .build()
    .plot();

Implementations

impl TimeSeriesPlot

pub fn builder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7, 'f8>() -> TimeSeriesPlotBuilder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7, 'f8>

Trait Implementations

impl Clone for TimeSeriesPlot

fn clone(&self) -> TimeSeriesPlot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Serialize for TimeSeriesPlot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.