Struct egui::widgets::plot::Plot

pub struct Plot { /* fields omitted */ }

A 2D plot, e.g. a graph of a function.

Plot supports multiple curves.

use egui::plot::{Curve, Plot, Value};
let sin = (0..1000).map(|i| {
    let x = i as f64 * 0.01;
    Value::new(x, x.sin())
});
let curve = Curve::from_values_iter(sin);
ui.add(
    Plot::default().curve(curve).view_aspect(2.0)
);

Implementations

impl Plot

pub fn curve(self, curve: Curve) -> Self

Add a data curve. You can add multiple curves.

pub fn hline(self, hline: HLine) -> Self

Add a horizontal line. Can be useful e.g. to show min/max bounds or similar. Always fills the full width of the plot.

pub fn vline(self, vline: VLine) -> Self

Add a vertical line. Can be useful e.g. to show min/max bounds or similar. Always fills the full height of the plot.

pub fn include_x(self, x: impl Into<f64>) -> Self

Expand bounds to include the given x value.

pub fn include_y(self, y: impl Into<f64>) -> Self

Expand bounds to include the given y value. For instance, to always show the x axis, call plot.include_y(0.0).

pub fn symmetrical_x_bounds(self, symmetrical_x_bounds: bool) -> Self

If true, the x-bounds will be symmetrical, so that the x=0 zero line is always in the center.

pub fn symmetrical_y_bounds(self, symmetrical_y_bounds: bool) -> Self

If true, the y-bounds will be symmetrical, so that the y=0 zero line is always in the center.

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

width / height ratio of the data. For instance, it can be useful to set this to 1.0 for when the two axes show the same unit.

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

width / height ratio of the plot region. By default no fixed aspect ratio is set (and width/height will fill the ui it is in).

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

Width of plot. By default a plot will fill the ui it is in. If you set Self::view_aspect, the width can be calculated from the height.

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

Height of plot. By default a plot will fill the ui it is in. If you set Self::view_aspect, the height can be calculated from the width.

pub fn min_size(self, min_size: Vec2) -> Self

Minimum size of the plot view.

pub fn show_x(self, show_x: bool) -> Self

Show the x-value (e.g. when hovering). Default: true.

pub fn show_y(self, show_y: bool) -> Self

Show the y-value (e.g. when hovering). Default: true.

Trait Implementations

impl Clone for Plot

fn clone(&self) -> Plot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Plot

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Plot> for Plot

fn eq(&self, other: &Plot) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Plot) -> bool

This method tests for !=.

impl StructuralPartialEq for Plot

impl Widget for Plot

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.