Struct Histogram

pub struct Histogram {
    pub title: String,
    pub x_label: String,
    pub y_label: String,
    pub bins: usize,
    pub data: Vec<f64>,
    pub color: [u8; 3],
    pub min: f64,
    pub max: f64,
    pub bin_counts: Vec<f64>,
    pub bin_width: f64,
    pub config: FigureConfig,
}

Represents a histogram, including title, axis labels, bin configuration, and cached data.

Fields

title: String

Title of the histogram.

x_label: String

Label for the X-axis.

y_label: String

Label for the Y-axis.

bins: usize

Number of bins in the histogram.

data: Vec<f64>

Raw data values to be represented in the histogram.

color: [u8; 3]

Color of the histogram bars in RGB format.

min: f64

Cached minimum value in the dataset.

max: f64

Cached maximum value in the dataset.

bin_counts: Vec<f64>

Cached frequencies for each bin.

bin_width: f64

Cached width of each bin.

config: FigureConfig

Configuration settings for rendering the histogram.

Implementations

impl Histogram

pub fn new( title: &str, x_label: &str, y_label: &str, bins: usize, color: [u8; 3], config: FigureConfig, ) -> Self

Creates a new Histogram instance with the specified configuration.

Parameters

• title: The title of the histogram.
• x_label: The label for the X-axis.
• y_label: The label for the Y-axis.
• bins: The number of bins in the histogram.
• color: The RGB color of the histogram bars.
• config: The FigureConfig containing appearance and behavior settings.

Returns

A new Histogram instance with empty data and initialized bins.

Example

use crate::figure::configuration::figureconfig::FigureConfig;
use crate::figure::histogram::Histogram;

let config = FigureConfig::default();
let histogram = Histogram::new("Data Distribution", "Values", "Frequency", 10, [255, 0, 0], config);

pub fn add_data_vec(&mut self, values: Vec<f64>)

Adds multiple data values to the histogram.

Parameters

• values: A vector of f64 values to be added to the histogram.

Example

histogram.add_data_vec(vec![1.2, 2.5, 3.1, 4.8]);

pub fn add_data(&mut self, value: f64)

Adds a single data value to the histogram.

Parameters

• value: An f64 value to be added to the histogram.

Details

• Updates the cached minimum and maximum values.
• Recalculates the bin width.
• Updates the appropriate bin count based on the value.

Example

histogram.add_data(3.5);

pub fn calculate_bins(&self) -> Vec<(f64, f64)>

Calculates the bin ranges and frequencies for the histogram.

Returns

A vector of tuples where each tuple contains:

• The starting value of the bin.
• The frequency count for that bin.

Example

let bins = histogram.calculate_bins();
for (start, count) in bins {
    println!("Bin starts at {}, count is {}", start, count);
}

Trait Implementations

impl Drawer for Histogram

fn draw_svg(&mut self, svg_canvas: &mut SvgCanvas)

Draws the plot content on an SvgCanvas.

fn draw(&mut self, canvas: &mut PixelCanvas)

Draws the main content of the plot on a PixelCanvas.

fn draw_legend(&self, _canvas: &mut PixelCanvas)

Draws the legend for the plot on a PixelCanvas.

fn draw_grid(&self, canvas: &mut PixelCanvas, config: &FigureConfig)

Draws the grid for the plot based on the provided configuration.

fn draw_axis( &self, canvas: &mut PixelCanvas, config: &FigureConfig, x1: i32, y1: i32, x2: i32, y2: i32, )

Draws an axis line on the canvas.

fn draw_label( &self, canvas: &mut PixelCanvas, config: &FigureConfig, x: u32, y: u32, text: &str, )

Draws a text label on the canvas.

fn draw_title( &self, canvas: &mut PixelCanvas, config: &FigureConfig, x: u32, y: u32, text: &str, )

Draws the plot title on the canvas.

fn draw_axis_value( &self, canvas: &mut PixelCanvas, config: &FigureConfig, x: u32, y: u32, text: &str, axis: AxisType, )

Draws a value on the axis (tick label) based on its type.

impl Hover for Histogram

fn handle_hover( &self, mouse_x: u32, mouse_y: u32, canvas: &PixelCanvas, ) -> Option<Vec<u32>>

Handle hover functionality and return updated buffer if applicable

fn find_closest_point( &self, mouse_x: u32, _mouse_y: u32, canvas: &PixelCanvas, ) -> Option<((f64, f64), f64)>

Finds the closest point to the mouse position on the plot.

fn to_canvas_coordinates( &self, x: f64, y: f64, canvas: &PixelCanvas, ) -> (u32, u32)

Converts plot coordinates into canvas pixel coordinates.

fn get_font<'a>(&self, font_data: &'a [u8]) -> FontRef<'a>

Retrieves the font used for hover text rendering.