Struct ChartBuilder 

pub struct ChartBuilder { /* private fields */ }

Builder for creating charts.

Implementations

impl ChartBuilder

pub fn new() -> Self

Create a new chart builder.

pub fn line() -> Self

Create a line chart builder.

pub fn bar() -> Self

Create a bar chart builder.

pub fn scatter() -> Self

Create a scatter plot builder.

pub fn area() -> Self

Create an area chart builder.

pub fn title(self, title: impl Into<String>) -> Self

Set the chart title.

pub fn title_config(self, title: ChartTitle) -> Self

Set the chart title with full configuration.

pub fn subtitle(self, subtitle: impl Into<String>) -> Self

Set the chart subtitle.

pub fn x_label(self, label: impl Into<String>) -> Self

Set the X axis label.

pub fn y_label(self, label: impl Into<String>) -> Self

Set the Y axis label.

pub fn x_axis_config(self, axis: Axis) -> Self

Configure the primary X axis.

pub fn y_axis_config(self, axis: Axis) -> Self

Configure the primary Y axis.

pub fn secondary_y_axis(self, axis: Axis) -> Self

Add a secondary Y axis (right side).

pub fn secondary_x_axis(self, axis: Axis) -> Self

Add a secondary X axis (top).

pub fn add_axis(self, axis: Axis) -> Self

Add a custom axis.

pub fn x_range(self, min: f64, max: f64) -> Self

Set the X axis range.

pub fn y_range(self, min: f64, max: f64) -> Self

Set the Y axis range.

pub fn secondary_y_range(self, min: f64, max: f64) -> Self

Set the secondary Y axis range.

pub fn add_series<T: Into<DataPoint> + Copy>( self, name: impl Into<String>, data: &[T], ) -> Self

Add a data series.

pub fn add_series_styled<T: Into<DataPoint> + Copy>( self, name: impl Into<String>, data: &[T], style: SeriesStyle, ) -> Self

Add a data series with custom style.

pub fn add_series_secondary_y<T: Into<DataPoint> + Copy>( self, name: impl Into<String>, data: &[T], ) -> Self

Add a data series on the secondary Y axis.

pub fn add_series_with_axes<T: Into<DataPoint> + Copy>( self, name: impl Into<String>, data: &[T], x_axis: AxisId, y_axis: AxisId, ) -> Self

Add a data series with custom axes.

pub fn plot_function<F>( self, name: impl Into<String>, f: F, x_min: f64, x_max: f64, samples: usize, ) -> Self

where F: Fn(f64) -> f64,

Plot a mathematical function.

pub fn add_text_annotation(self, annotation: TextAnnotation) -> Self

Add a text annotation.

pub fn add_text_at(self, text: impl Into<String>, x: f64, y: f64) -> Self

Add a text at data coordinates.

pub fn add_line_annotation(self, annotation: LineAnnotation) -> Self

Add a line annotation.

pub fn add_horizontal_line(self, y: f64, color: Color) -> Self

Add a horizontal reference line.

pub fn add_vertical_line(self, x: f64, color: Color) -> Self

Add a vertical reference line.

pub fn add_fill_region(self, region: FillRegion) -> Self

Add a fill region.

pub fn add_horizontal_band(self, y_min: f64, y_max: f64, color: Color) -> Self

Add a horizontal band fill.

pub fn add_vertical_band(self, x_min: f64, x_max: f64, color: Color) -> Self

Add a vertical band fill.

pub fn fill_below_series( self, series_index: usize, baseline: f64, color: Color, ) -> Self

Add fill below a series.

pub fn fill_between_series( self, series1: usize, series2: usize, color: Color, ) -> Self

Add fill between two series.

pub fn with_grid(self) -> Self

Enable grid lines.

pub fn without_grid(self) -> Self

Disable grid lines.

pub fn with_legend(self, position: LegendPosition) -> Self

Set legend position.

pub fn without_legend(self) -> Self

Disable legend.

pub fn background(self, color: Color) -> Self

Set background color.

pub fn padding(self, padding: f32) -> Self

Set padding around the chart area.

pub fn bar_config(self, config: BarConfig) -> Self

Set bar chart configuration.

pub fn interactive(self, enabled: bool) -> Self

Enable interactivity (pan and zoom).

pub fn with_crosshair(self) -> Self

Enable crosshair on hover.

pub fn with_tooltips(self) -> Self

Enable tooltips on hover.

pub fn without_tooltips(self) -> Self

Disable tooltips.

pub fn zoom_limits(self, min: f32, max: f32) -> Self

Set zoom limits.

pub fn build(self) -> Chart

Build the chart.

pub fn x_axis<F>(self, f: F) -> Self

where F: FnOnce(AxisBuilder) -> AxisBuilder,

Configure the primary X axis using a closure.

Example

chart.x_axis(|a| a
    .label("Time (s)")
    .range(0.0, 100.0)
    .grid(|g| g.major(|m| m.thickness(1.0)))
);

pub fn y_axis<F>(self, f: F) -> Self

where F: FnOnce(AxisBuilder) -> AxisBuilder,

Configure the primary Y axis using a closure.

pub fn add_custom_axis<F>(self, name: &str, f: F) -> Self

where F: FnOnce(AxisBuilder) -> AxisBuilder,

Add a custom axis using a closure.

Example

chart.add_custom_axis("pressure", |a| a
    .orientation(AxisOrientation::Vertical)
    .position(AxisPosition::Right)
    .label("Pressure (kPa)")
    .range(0.0, 200.0)
);

pub fn add_series_with<F>(self, name: impl Into<String>, f: F) -> Self

where F: FnOnce(SeriesBuilder) -> SeriesBuilder,

Add a series using a closure for configuration.

Example

chart.add_series_with("Temperature", |s| s
    .data(&data)
    .color(Color::RED)
    .dashed(5.0, 3.0)
    .markers(|m| m.circle().size(4.0))
);

pub fn streaming_series<F>( self, name: impl Into<String>, capacity: usize, f: F, ) -> Self

where F: FnOnce(SeriesBuilder) -> SeriesBuilder,

Create a streaming series with a ring buffer.

The series is created with an empty ring buffer of the specified capacity.

Example

chart.streaming_series("Live Sensor", 10_000, |s| s
    .color(Color::BLUE)
    .fill_to_baseline(Color::rgba(0.0, 0.0, 1.0, 0.1))
);

Trait Implementations

impl Debug for ChartBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ChartBuilder

fn default() -> Self

Returns the “default value” for a type.