Struct plotlars::TimeSeriesPlot

pub struct TimeSeriesPlot { /* private fields */ }

A structure representing a time series plot.

Implementations

impl TimeSeriesPlot

pub fn builder<'__f0, '__f1>() -> TimeSeriesPlotBuilder<'__f0, '__f1>

Creates a new TimeSeriesPlot.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• x - A string specifying the column name to be used for the x-axis, typically representing time or dates.
• y - A string specifying the column name to be used for the y-axis, typically representing the primary metric.
• aditional_series - An optional vector of strings specifying additional y-axis columns to be plotted as series.
• size - An optional usize specifying the size of the markers or line thickness.
• colors - An optional vector of Rgb values specifying the colors to be used for the plot lines.
• line_types - An optional vector of LineType specifying the types of lines (e.g., solid, dashed) for each plotted 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.

Returns

Returns an instance of TimeSeriesPlot.

Example

TimeSeriesPlot::builder()
    .data(&dataset)
    .x("date")
    .y("y_variable_1")
    .aditional_series(vec!["y_variable_2"])
    .size(5)
    .colors(vec![
        Rgb(255, 0, 0),
        Rgb(0, 255, 0),
    ])
    .line_types(vec![
        LineType::Dash,
        LineType::Solid,
    ])
    .plot_title(
        Text::from("Time Series Plot")
            .font("Arial")
            .size(18)
    )
    .x_title(
        Text::from("date")
            .font("Arial")
            .size(15)
    )
    .y_title(
        Text::from("y variable")
            .font("Arial")
            .size(15)
    )
    .legend_title(
        Text::from("time series")
            .font("Arial")
            .size(15)
    )
    .build()
    .plot();

Trait Implementations

impl Plot for TimeSeriesPlot

fn get_layout(&self) -> &Layout

fn get_traces(&self) -> &Vec<Box<dyn TracePlotly + 'static>>

fn plot(self)

where Self: Sized,