Struct Plot 

pub struct Plot { /* private fields */ }

Main plot widget container.

A plot is backend-agnostic and focuses on data, view state, and styling. Render backends (such as the GPUI backend) drive viewport refreshes and interaction state.

Implementations

impl Plot

pub fn new() -> Self

Create a plot with default configuration.

Equivalent to PlotBuilder::default().build().

pub fn builder() -> PlotBuilder

Start building a plot with custom configuration.

Examples found in repository

examples/basic.rs (line 31)

fn main() {
    Application::new().run(|cx| {
        let options = WindowOptions {
            window_bounds: Some(WindowBounds::Windowed(Bounds::centered(
                None,
                size(px(720.0), px(480.0)),
                cx,
            ))),
            ..Default::default()
        };

        cx.open_window(options, |_window, cx| {
            let series = Series::from_iter_y(
                "signal",
                (0..400).map(|i| {
                    let x = i as f64 * 0.03;
                    x.sin()
                }),
                SeriesKind::Line(LineStyle {
                    color: Color::new(0.2, 0.75, 0.95, 1.0),
                    width: 2.0,
                }),
            );

            let mut plot = Plot::builder()
                .theme(Theme::dark())
                .x_axis(AxisConfig::builder().title("Sample").build())
                .y_axis(AxisConfig::builder().title("Amplitude").build())
                .build();
            plot.add_series(&series);

            let config = PlotViewConfig {
                show_legend: true,
                show_hover: true,
                ..Default::default()
            };

            let view = GpuiPlotView::with_config(plot, config);
            cx.new(|_| view)
        })
        .unwrap();
    });
}

examples/advanced.rs (line 82)

fn build_views(
    cx: &mut gpui::App,
) -> (
    gpui::Entity<GpuiPlotView>,
    gpui::Entity<GpuiPlotView>,
    Series,
    Series,
) {
    let mut stream_a = Series::line("stream-A").with_kind(SeriesKind::Line(LineStyle {
        color: Color::new(0.2, 0.82, 0.95, 1.0),
        width: 2.0,
    }));
    let mut stream_b = Series::line("stream-B").with_kind(SeriesKind::Line(LineStyle {
        color: Color::new(0.95, 0.64, 0.28, 1.0),
        width: 2.0,
    }));

    for i in 0..1_000 {
        let phase = i as f64 * 0.02;
        let _ = stream_a.push_y((phase * 0.9).sin() + 0.2 * (phase * 0.13).cos());
        let _ = stream_b.push_y((phase * 0.45).cos() * 1.15 + 0.15 * (phase * 0.09).sin());
    }

    let events = Series::from_iter_points(
        "events(scatter)",
        (0..200).map(|i| {
            let x = i as f64 * 80.0 + 40.0;
            let y = (x * 0.02).sin() * 0.9;
            gpui_liveplot::Point::new(x, y)
        }),
        SeriesKind::Scatter(MarkerStyle {
            color: Color::new(0.95, 0.25, 0.55, 1.0),
            size: 5.0,
            shape: MarkerShape::Circle,
        }),
    );

    let baseline = Series::from_explicit_callback(
        "baseline(callback)",
        |x| (x * 0.015).sin() * 0.4,
        Range::new(0.0, 25_000.0),
        5_000,
        SeriesKind::Line(LineStyle {
            color: Color::new(0.45, 0.45, 0.5, 0.8),
            width: 1.0,
        }),
    );

    let mut top_plot = Plot::builder()
        .theme(Theme::dark())
        .x_axis(AxisConfig::builder().title("Sample").build())
        .y_axis(AxisConfig::builder().title("Top: stream + events").build())
        .view(View::FollowLastN { points: 2_000 })
        .build();
    top_plot.add_series(&stream_a);
    top_plot.add_series(&events);

    let mut bottom_plot = Plot::builder()
        .theme(Theme::dark())
        .x_axis(AxisConfig::builder().title("Sample").build())
        .y_axis(
            AxisConfig::builder()
                .title("Bottom: stream + baseline")
                .build(),
        )
        .view(View::FollowLastNXY { points: 2_000 })
        .build();
    bottom_plot.add_series(&stream_b);
    bottom_plot.add_series(&baseline);

    let config = PlotViewConfig {
        show_legend: true,
        show_hover: true,
        ..Default::default()
    };

    let link_group = PlotLinkGroup::new();
    let options = PlotLinkOptions {
        link_x: true,
        link_y: false,
        link_cursor: true,
        link_brush: true,
        link_reset: true,
    };

    let top = cx.new(|_| {
        GpuiPlotView::with_config(top_plot, config.clone())
            .with_link_group(link_group.clone(), options)
    });
    let bottom = cx.new(|_| {
        GpuiPlotView::with_config(bottom_plot, config).with_link_group(link_group, options)
    });

    (top, bottom, stream_a, stream_b)
}

pub fn theme(&self) -> &Theme

Access the current theme.

pub fn set_theme(&mut self, theme: Theme)

Set the plot theme.

pub fn x_axis(&self) -> &AxisConfig

Access the X axis configuration.

pub fn y_axis(&self) -> &AxisConfig

Access the Y axis configuration.

pub fn view(&self) -> View

Access the active view mode.

pub fn viewport(&self) -> Option<Viewport>

Access the current viewport.

The viewport is computed by Plot::refresh_viewport.

pub fn series(&self) -> &[Series]

Access all series.

pub fn series_mut(&mut self) -> &mut Vec<Series>

Access all series mutably.

Returning the backing vector allows callers to add, remove, and reorder series at runtime.

pub fn add_series(&mut self, series: &Series)

Add a series to the plot.

The plot stores a shared handle instead of taking unique ownership. Appends made through other shared handles are visible immediately.

Examples found in repository

examples/basic.rs (line 36)

fn main() {
    Application::new().run(|cx| {
        let options = WindowOptions {
            window_bounds: Some(WindowBounds::Windowed(Bounds::centered(
                None,
                size(px(720.0), px(480.0)),
                cx,
            ))),
            ..Default::default()
        };

        cx.open_window(options, |_window, cx| {
            let series = Series::from_iter_y(
                "signal",
                (0..400).map(|i| {
                    let x = i as f64 * 0.03;
                    x.sin()
                }),
                SeriesKind::Line(LineStyle {
                    color: Color::new(0.2, 0.75, 0.95, 1.0),
                    width: 2.0,
                }),
            );

            let mut plot = Plot::builder()
                .theme(Theme::dark())
                .x_axis(AxisConfig::builder().title("Sample").build())
                .y_axis(AxisConfig::builder().title("Amplitude").build())
                .build();
            plot.add_series(&series);

            let config = PlotViewConfig {
                show_legend: true,
                show_hover: true,
                ..Default::default()
            };

            let view = GpuiPlotView::with_config(plot, config);
            cx.new(|_| view)
        })
        .unwrap();
    });
}

examples/advanced.rs (line 88)

fn build_views(
    cx: &mut gpui::App,
) -> (
    gpui::Entity<GpuiPlotView>,
    gpui::Entity<GpuiPlotView>,
    Series,
    Series,
) {
    let mut stream_a = Series::line("stream-A").with_kind(SeriesKind::Line(LineStyle {
        color: Color::new(0.2, 0.82, 0.95, 1.0),
        width: 2.0,
    }));
    let mut stream_b = Series::line("stream-B").with_kind(SeriesKind::Line(LineStyle {
        color: Color::new(0.95, 0.64, 0.28, 1.0),
        width: 2.0,
    }));

    for i in 0..1_000 {
        let phase = i as f64 * 0.02;
        let _ = stream_a.push_y((phase * 0.9).sin() + 0.2 * (phase * 0.13).cos());
        let _ = stream_b.push_y((phase * 0.45).cos() * 1.15 + 0.15 * (phase * 0.09).sin());
    }

    let events = Series::from_iter_points(
        "events(scatter)",
        (0..200).map(|i| {
            let x = i as f64 * 80.0 + 40.0;
            let y = (x * 0.02).sin() * 0.9;
            gpui_liveplot::Point::new(x, y)
        }),
        SeriesKind::Scatter(MarkerStyle {
            color: Color::new(0.95, 0.25, 0.55, 1.0),
            size: 5.0,
            shape: MarkerShape::Circle,
        }),
    );

    let baseline = Series::from_explicit_callback(
        "baseline(callback)",
        |x| (x * 0.015).sin() * 0.4,
        Range::new(0.0, 25_000.0),
        5_000,
        SeriesKind::Line(LineStyle {
            color: Color::new(0.45, 0.45, 0.5, 0.8),
            width: 1.0,
        }),
    );

    let mut top_plot = Plot::builder()
        .theme(Theme::dark())
        .x_axis(AxisConfig::builder().title("Sample").build())
        .y_axis(AxisConfig::builder().title("Top: stream + events").build())
        .view(View::FollowLastN { points: 2_000 })
        .build();
    top_plot.add_series(&stream_a);
    top_plot.add_series(&events);

    let mut bottom_plot = Plot::builder()
        .theme(Theme::dark())
        .x_axis(AxisConfig::builder().title("Sample").build())
        .y_axis(
            AxisConfig::builder()
                .title("Bottom: stream + baseline")
                .build(),
        )
        .view(View::FollowLastNXY { points: 2_000 })
        .build();
    bottom_plot.add_series(&stream_b);
    bottom_plot.add_series(&baseline);

    let config = PlotViewConfig {
        show_legend: true,
        show_hover: true,
        ..Default::default()
    };

    let link_group = PlotLinkGroup::new();
    let options = PlotLinkOptions {
        link_x: true,
        link_y: false,
        link_cursor: true,
        link_brush: true,
        link_reset: true,
    };

    let top = cx.new(|_| {
        GpuiPlotView::with_config(top_plot, config.clone())
            .with_link_group(link_group.clone(), options)
    });
    let bottom = cx.new(|_| {
        GpuiPlotView::with_config(bottom_plot, config).with_link_group(link_group, options)
    });

    (top, bottom, stream_a, stream_b)
}

pub fn pins(&self) -> &[Pin]

Access the pinned points.

pub fn pins_mut(&mut self) -> &mut Vec<Pin>

Access the pinned points mutably.

pub fn data_bounds(&self) -> Option<Viewport>

Compute bounds across all visible series.

pub fn set_manual_view(&mut self, viewport: Viewport)

Enter manual view with the given viewport.

pub fn reset_view(&mut self)

Reset to automatic view.

pub fn refresh_viewport( &mut self, padding_frac: f64, min_padding: f64, ) -> Option<Viewport>

Refresh the viewport based on the current view mode and data.

This updates the cached viewport and applies padding to avoid tight bounds during auto-fit.

Trait Implementations

impl Clone for Plot

fn clone(&self) -> Plot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plot

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

Formats the value using the given formatter.

impl Default for Plot

fn default() -> Self

Returns the “default value” for a type.