velociplot 0.1.0

Fast, publication-quality scientific plotting library - Quick, precise, and deadly effective
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Legend below graph example - Publication standard
//!
//! Demonstrates placing the legend below the graph area, which is the
//! standard format for scientific publications and manuscripts.

use velociplot::prelude::*;

fn main() -> Result<()> {
    println!("🦖 velociplot - Legend below graph example");

    // Create sample data
    let data1 = Series::from_function(0.0, 10.0, 50, |x| x.powi(2) * 0.1);
    let data2 = Series::from_function(0.0, 10.0, 50, |x| x * 1.5);
    let data3 = Series::from_function(0.0, 10.0, 50, |x| (x * 0.5).sin() * 3.0 + 5.0);

    // Create line plots
    let line1 = LinePlot::new(data1)
        .color(Color::from_hex("#3498db").unwrap())
        .line_width(2.5)
        .label("Quadratic");

    let line2 = LinePlot::new(data2)
        .color(Color::from_hex("#e74c3c").unwrap())
        .line_width(2.5)
        .label("Linear");

    let line3 = LinePlot::new(data3)
        .color(Color::from_hex("#2ecc71").unwrap())
        .line_width(2.5)
        .label("Sinusoidal");

    // Calculate bounds
    let bounds1 = line1.bounds().unwrap();
    let bounds2 = line2.bounds().unwrap();
    let bounds3 = line3.bounds().unwrap();
    let bounds = bounds1.union(&bounds2).union(&bounds3).with_padding(0.1);

    // Create canvas with extra height for legend below
    // Standard size (800x600) + ~120px for axis labels, spacing, and legend
    // The legend will be positioned in this extra space below the plot area
    let mut canvas = SkiaCanvas::new(800, 720, bounds)?;
    canvas.fill_background(&Color::WHITE.to_rgba())?;

    // Draw axes
    let x_axis = Axis::new(AxisPosition::Bottom)
        .label("X Axis")
        .tick_count(6)
        .show_grid(true);

    let y_axis = Axis::new(AxisPosition::Left)
        .label("Y Axis")
        .tick_count(8)
        .show_grid(true);

    x_axis.draw(&mut canvas)?;
    y_axis.draw(&mut canvas)?;

    // Draw plots
    line1.draw(&mut canvas)?;
    line2.draw(&mut canvas)?;
    line3.draw(&mut canvas)?;

    // Add legend - default position is Below(Center)
    // You can also use Below(HorizontalAlignment::Start) or Below(HorizontalAlignment::End)
    let mut legend = Legend::new(); // Uses LegendPosition::Below(HorizontalAlignment::Center) by default

    for line in [&line1, &line2, &line3] {
        if let Some(entry) = line.legend_entry() {
            legend = legend.add_entry(entry);
        }
    }

    legend.draw(&mut canvas)?;

    canvas.save_png("examples/images/legend_below.png")?;

    println!("✓ Plot saved to examples/images/legend_below.png");
    println!("\nLegend placement:");
    println!("  • Default: Below(Center) - centered below graph (publication standard)");
    println!("  • Canvas expanded vertically to accommodate legend");
    println!("  • Legend doesn't obscure data");
    println!("\nAlignment options for Below:");
    println!("  • Below(HorizontalAlignment::Start) - Left-aligned");
    println!("  • Below(HorizontalAlignment::Center) - Centered (default)");
    println!("  • Below(HorizontalAlignment::End) - Right-aligned");
    println!("\nOther positions available:");
    println!("  • LegendPosition::UpperRight - Corner placement");
    println!("  • LegendPosition::Auto - Smart auto-positioning");
    println!("  • LegendPosition::Custom(x, y) - Manual placement");

    Ok(())
}