Struct CandlestickPlot 

pub struct CandlestickPlot { /* private fields */ }

A structure representing a Candlestick financial chart.

The CandlestickPlot struct facilitates the creation and customization of candlestick charts commonly used for visualizing financial data such as stock prices. It supports custom styling for increasing/decreasing values, whisker width configuration, hover information, and comprehensive layout customization including range selectors and sliders for interactive time navigation.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• dates - A string slice specifying the column name for dates/timestamps.
• open - A string slice specifying the column name for opening values.
• high - A string slice specifying the column name for high values.
• low - A string slice specifying the column name for low values.
• close - A string slice specifying the column name for closing values.
• increasing - An optional reference to a Direction struct for customizing increasing candlesticks.
• decreasing - An optional reference to a Direction struct for customizing decreasing candlesticks.
• whisker_width - An optional f64 specifying the width of the whiskers (0-1 range).
• 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.

Examples

use plotlars::{Axis, CandlestickPlot, Direction, Plot, Rgb};
use polars::prelude::*;

let stock_data = LazyCsvReader::new(PlPath::new("data/stock_prices.csv"))
    .finish()
    .unwrap()
    .collect()
    .unwrap();

let increasing = Direction::new()
    .line_color(Rgb(0, 200, 100))
    .line_width(0.5);

let decreasing = Direction::new()
    .line_color(Rgb(200, 50, 50))
    .line_width(0.5);

CandlestickPlot::builder()
    .data(&stock_data)
    .dates("date")
    .open("open")
    .high("high")
    .low("low")
    .close("close")
    .increasing(&increasing)
    .decreasing(&decreasing)
    .whisker_width(0.1)
    .plot_title("Candlestick Plot")
    .y_title("Price ($)")
    .y_axis(
        &Axis::new()
            .show_axis(true)
            .show_grid(true)
    )
    .build()
    .plot();

Implementations

impl CandlestickPlot

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

Examples found in repository

examples/candlestick.rs (line 19)

fn main() {
    let stock_data = LazyCsvReader::new(PlPath::new("data/stock_prices.csv"))
        .finish()
        .unwrap()
        .collect()
        .unwrap();

    let increasing = Direction::new()
        .line_color(Rgb(0, 200, 100))
        .line_width(0.5);

    let decreasing = Direction::new()
        .line_color(Rgb(200, 50, 50))
        .line_width(0.5);

    CandlestickPlot::builder()
        .data(&stock_data)
        .dates("date")
        .open("open")
        .high("high")
        .low("low")
        .close("close")
        .increasing(&increasing)
        .decreasing(&decreasing)
        .whisker_width(0.1)
        .plot_title("Candlestick")
        .y_title("price ($)")
        .y_axis(&Axis::new().show_axis(true).show_grid(true))
        .build()
        .plot();
}

examples/subplot_grid.rs (line 191)

fn irregular_grid_example() {
    let dataset1 = LazyCsvReader::new(PlPath::new("data/penguins.csv"))
        .finish()
        .unwrap()
        .select([
            col("species"),
            col("sex").alias("gender"),
            col("flipper_length_mm").cast(DataType::Int16),
            col("body_mass_g").cast(DataType::Int16),
        ])
        .collect()
        .unwrap();

    let axis = Axis::new()
        .show_line(true)
        .show_grid(true)
        .value_thousands(true)
        .tick_direction(TickDirection::OutSide);

    let plot1 = Histogram::builder()
        .data(&dataset1)
        .x("body_mass_g")
        .group("species")
        .opacity(0.5)
        .colors(vec![Rgb(255, 165, 0), Rgb(147, 112, 219), Rgb(46, 139, 87)])
        .plot_title(Text::from("Histogram").x(0.0).y(1.35).size(14))
        .x_title(Text::from("body mass (g)").x(0.94).y(-0.35))
        .y_title(Text::from("count").x(-0.062).y(0.83))
        .x_axis(&axis)
        .y_axis(&axis)
        .legend_title(Text::from("species"))
        .legend(&Legend::new().x(0.87).y(1.2))
        .build();

    let dataset2 = LazyCsvReader::new(PlPath::new("data/stock_prices.csv"))
        .finish()
        .unwrap()
        .collect()
        .unwrap();

    let increasing = Direction::new()
        .line_color(Rgb(0, 200, 100))
        .line_width(0.5);

    let decreasing = Direction::new()
        .line_color(Rgb(200, 50, 50))
        .line_width(0.5);

    let plot2 = CandlestickPlot::builder()
        .data(&dataset2)
        .dates("date")
        .open("open")
        .high("high")
        .low("low")
        .close("close")
        .increasing(&increasing)
        .decreasing(&decreasing)
        .whisker_width(0.1)
        .plot_title(Text::from("Candlestick").x(0.0).y(1.35).size(14))
        .y_title(Text::from("price ($)").x(-0.06).y(0.76))
        .y_axis(&Axis::new().show_axis(true).show_grid(true))
        .build();

    let dataset3 = LazyCsvReader::new(PlPath::new("data/heatmap.csv"))
        .finish()
        .unwrap()
        .collect()
        .unwrap();

    let plot3 = HeatMap::builder()
        .data(&dataset3)
        .x("x")
        .y("y")
        .z("z")
        .color_bar(
            &ColorBar::new()
                .value_exponent(ValueExponent::None)
                .separate_thousands(true)
                .tick_length(5)
                .tick_step(5000.0),
        )
        .plot_title(Text::from("Heat Map").x(0.0).y(1.35).size(14))
        .color_scale(Palette::Viridis)
        .build();

    SubplotGrid::irregular()
        .plots(vec![
            (&plot1, 0, 0, 1, 1),
            (&plot2, 0, 1, 1, 1),
            (&plot3, 1, 0, 1, 2),
        ])
        .rows(2)
        .cols(2)
        .v_gap(0.35)
        .h_gap(0.05)
        .title(
            Text::from("Irregular Subplot Grid")
                .size(16)
                .font("Arial bold")
                .y(0.95),
        )
        .build()
        .plot();
}

Trait Implementations

impl Clone for CandlestickPlot

fn clone(&self) -> CandlestickPlot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for CandlestickPlot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl PlotHelper for CandlestickPlot