Struct OhlcPlot 

pub struct OhlcPlot { /* private fields */ }

A structure representing an OHLC (Open-High-Low-Close) financial chart.

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

Backend Support

Backend	Supported
Plotly	Yes
Plotters	–

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.
• tick_width - An optional f64 specifying the width of the open/close ticks (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, OhlcPlot, Plot};
use polars::prelude::*;

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

OhlcPlot::builder()
    .data(&stock_data)
    .dates("date")
    .open("open")
    .high("high")
    .low("low")
    .close("close")
    .plot_title("OHLC Plot")
    .y_title("Price ($)")
    .y_axis(
        &Axis::new()
            .show_axis(true)
    )
    .build()
    .plot();

Implementations

impl OhlcPlot

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

impl OhlcPlot

pub fn try_new( data: &DataFrame, dates: &str, open: &str, high: &str, low: &str, close: &str, tick_width: Option<f64>, plot_title: Option<Text>, x_title: Option<Text>, y_title: Option<Text>, x_axis: Option<&Axis>, y_axis: Option<&Axis>, ) -> Result<Self, PlotlarsError>

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

Trait Implementations

impl Clone for OhlcPlot

fn clone(&self) -> OhlcPlot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Plot for OhlcPlot

fn ir_traces(&self) -> &[TraceIR]

fn ir_layout(&self) -> &LayoutIR