Struct LinePlot

pub struct LinePlot { /* private fields */ }

A structure representing a line plot.

Implementations

impl LinePlot

pub fn builder<'__f0, '__f1, '__f2, '__f3, '__f4>() -> LinePlotBuilder<'__f0, '__f1, '__f2, '__f3, '__f4>

Creates a new LinePlot.

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.
• y - A string specifying the column name to be used for the y-axis.
• additional_lines - An optional vector of strings specifying additional y-axis columns to be plotted as lines.
• size - An optional usize specifying the size of the markers or line thickness.
• color - An optional Rgb value specifying the color of the marker to be used for the plot.
• colors - An optional vector of Rgb values specifying the color for the markers to be used for the plot.
• 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.
• shapes - An optional Vec<Shape> specifying multiple shapes for the markers.
• line_types - An optional vector of LineType specifying the types of lines (e.g., solid, dashed) for each plotted line.
• line_width - An optional f64 specifying the width of the plotted lines.
• 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.
• 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.
• legend_title - An optional Text struct specifying the title of the legend.
• legend - An optional reference to a Legend struct for customizing the legend of the plot (e.g., positioning, font, etc.).

Returns

Returns an instance of LinePlot.

Example

LinePlot::builder()
    .data(&lineplot_dataset)
    .x("x")
    .y("sine")
    .additional_lines(vec!["cosine"])
    .colors(vec![Rgb(255, 0, 0), Rgb(0, 255, 0)])
    .line_types(vec![LineType::Solid, LineType::Dot])
    .line_width(3.0)
    .with_shape(false)
    .plot_title(
        Text::from("Line Plot")
            .font("Arial")
            .size(18)
    )
    .x_axis(
       &Axis::new()
           .tick_direction(TickDirection::OutSide)
           .axis_position(0.5)
           .tick_values(vec![
               0.5 * std::f64::consts::PI,
               std::f64::consts::PI,
               1.5 * std::f64::consts::PI,
               2.0 * std::f64::consts::PI,
           ])
           .tick_labels(vec!["π/2", "π", "3π/2", "2π"])
    )
    .y_axis(
       &Axis::new()
           .tick_direction(TickDirection::OutSide)
           .clone()
           .tick_values(vec![-1.0, 0.0, 1.0])
           .tick_labels(vec!["-1", "0", "1"])
    )
    .legend_title(
        Text::from("series")
            .font("Arial")
            .size(15)
    )
    .build()
    .plot();

Trait Implementations

impl Plot for LinePlot

fn get_layout(&self) -> &Layout

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

fn plot(self)

where Self: Sized,

fn write_html(self, path: impl Into<String>)

where Self: Sized,