Struct Plot

Source

pub struct Plot { /* private fields */ }

Expand description

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§

Source §

impl Plot

Source

pub fn new() -> Self

Create a plot with default configuration.

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

Source

pub fn builder() -> PlotBuilder

Start building a plot with custom configuration.

Examples found in repository ?

examples/basic.rs (line 36)

7fn main() {
8    Application::new().run(|cx| {
9        let options = WindowOptions {
10            window_bounds: Some(WindowBounds::Windowed(Bounds::centered(
11                None,
12                size(px(720.0), px(480.0)),
13                cx,
14            ))),
15            ..Default::default()
16        };
17
18        cx.open_window(options, |_window, cx| {
19            let series = Series::from_iter_y(
20                "signal",
21                (0..400).map(|i| {
22                    let x = i as f64 * 0.03;
23                    x.sin()
24                }),
25                SeriesKind::Line(LineStyle {
26                    color: Rgba {
27                        r: 0.2,
28                        g: 0.75,
29                        b: 0.95,
30                        a: 1.0,
31                    },
32                    width: 2.0,
33                }),
34            );
35
36            let mut plot = Plot::builder()
37                .theme(Theme::dark())
38                .x_axis(AxisConfig::builder().title("Sample").build())
39                .y_axis(AxisConfig::builder().title("Amplitude").build())
40                .build();
41            plot.add_series(&series);
42
43            let config = PlotViewConfig {
44                show_legend: true,
45                show_hover: true,
46                ..Default::default()
47            };
48
49            let view = PlotView::with_config(plot, config);
50            cx.new(|_| view)
51        })
52        .unwrap();
53    });
54}

More examples

Hide additional examples

examples/advanced.rs (line 102)

34fn build_views(
35    cx: &mut gpui::App,
36) -> (
37    gpui::Entity<PlotView>,
38    gpui::Entity<PlotView>,
39    Series,
40    Series,
41) {
42    let mut stream_a = Series::line("stream-A").with_kind(SeriesKind::Line(LineStyle {
43        color: Rgba {
44            r: 0.2,
45            g: 0.82,
46            b: 0.95,
47            a: 1.0,
48        },
49        width: 2.0,
50    }));
51    let mut stream_b = Series::line("stream-B").with_kind(SeriesKind::Line(LineStyle {
52        color: Rgba {
53            r: 0.95,
54            g: 0.64,
55            b: 0.28,
56            a: 1.0,
57        },
58        width: 2.0,
59    }));
60
61    for i in 0..1_000 {
62        let phase = i as f64 * 0.02;
63        let _ = stream_a.push_y((phase * 0.9).sin() + 0.2 * (phase * 0.13).cos());
64        let _ = stream_b.push_y((phase * 0.45).cos() * 1.15 + 0.15 * (phase * 0.09).sin());
65    }
66
67    let events = Series::from_iter_points(
68        "events(scatter)",
69        (0..200).map(|i| {
70            let x = i as f64 * 80.0 + 40.0;
71            let y = (x * 0.02).sin() * 0.9;
72            gpui_liveplot::Point::new(x, y)
73        }),
74        SeriesKind::Scatter(MarkerStyle {
75            color: Rgba {
76                r: 0.95,
77                g: 0.25,
78                b: 0.55,
79                a: 1.0,
80            },
81            size: 5.0,
82            shape: MarkerShape::Circle,
83        }),
84    );
85
86    let baseline = Series::from_explicit_callback(
87        "baseline(callback)",
88        |x| (x * 0.015).sin() * 0.4,
89        Range::new(0.0, 25_000.0),
90        5_000,
91        SeriesKind::Line(LineStyle {
92            color: Rgba {
93                r: 0.45,
94                g: 0.45,
95                b: 0.5,
96                a: 0.8,
97            },
98            width: 1.0,
99        }),
100    );
101
102    let mut top_plot = Plot::builder()
103        .theme(Theme::dark())
104        .x_axis(AxisConfig::builder().title("Sample").build())
105        .y_axis(AxisConfig::builder().title("Top: stream + events").build())
106        .view(View::FollowLastN { points: 2_000 })
107        .build();
108    top_plot.add_series(&stream_a);
109    top_plot.add_series(&events);
110
111    let mut bottom_plot = Plot::builder()
112        .theme(Theme::dark())
113        .x_axis(AxisConfig::builder().title("Sample").build())
114        .y_axis(
115            AxisConfig::builder()
116                .title("Bottom: stream + baseline")
117                .build(),
118        )
119        .view(View::FollowLastNXY { points: 2_000 })
120        .build();
121    bottom_plot.add_series(&stream_b);
122    bottom_plot.add_series(&baseline);
123
124    let config = PlotViewConfig {
125        show_legend: true,
126        show_hover: true,
127        ..Default::default()
128    };
129
130    let link_group = PlotLinkGroup::new();
131    let options = PlotLinkOptions {
132        link_x: true,
133        link_y: false,
134        link_cursor: true,
135        link_brush: true,
136        link_reset: true,
137    };
138
139    let top = cx.new(|_| {
140        PlotView::with_config(top_plot, config.clone()).with_link_group(link_group.clone(), options)
141    });
142    let bottom =
143        cx.new(|_| PlotView::with_config(bottom_plot, config).with_link_group(link_group, options));
144
145    (top, bottom, stream_a, stream_b)
146}

Source

pub fn theme(&self) -> &Theme

Access the current theme.

Source

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

Set the plot theme.

Source

pub fn x_axis(&self) -> &AxisConfig

Access the X axis configuration.

Source

pub fn y_axis(&self) -> &AxisConfig

Access the Y axis configuration.

Source

pub fn view(&self) -> View

Access the active view mode.

Source

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

Access the current viewport.

The viewport is computed by Plot::refresh_viewport.

Source

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

Access all series.

Source

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.

Source

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 41)

7fn main() {
8    Application::new().run(|cx| {
9        let options = WindowOptions {
10            window_bounds: Some(WindowBounds::Windowed(Bounds::centered(
11                None,
12                size(px(720.0), px(480.0)),
13                cx,
14            ))),
15            ..Default::default()
16        };
17
18        cx.open_window(options, |_window, cx| {
19            let series = Series::from_iter_y(
20                "signal",
21                (0..400).map(|i| {
22                    let x = i as f64 * 0.03;
23                    x.sin()
24                }),
25                SeriesKind::Line(LineStyle {
26                    color: Rgba {
27                        r: 0.2,
28                        g: 0.75,
29                        b: 0.95,
30                        a: 1.0,
31                    },
32                    width: 2.0,
33                }),
34            );
35
36            let mut plot = Plot::builder()
37                .theme(Theme::dark())
38                .x_axis(AxisConfig::builder().title("Sample").build())
39                .y_axis(AxisConfig::builder().title("Amplitude").build())
40                .build();
41            plot.add_series(&series);
42
43            let config = PlotViewConfig {
44                show_legend: true,
45                show_hover: true,
46                ..Default::default()
47            };
48
49            let view = PlotView::with_config(plot, config);
50            cx.new(|_| view)
51        })
52        .unwrap();
53    });
54}

More examples

Hide additional examples

examples/advanced.rs (line 108)

34fn build_views(
35    cx: &mut gpui::App,
36) -> (
37    gpui::Entity<PlotView>,
38    gpui::Entity<PlotView>,
39    Series,
40    Series,
41) {
42    let mut stream_a = Series::line("stream-A").with_kind(SeriesKind::Line(LineStyle {
43        color: Rgba {
44            r: 0.2,
45            g: 0.82,
46            b: 0.95,
47            a: 1.0,
48        },
49        width: 2.0,
50    }));
51    let mut stream_b = Series::line("stream-B").with_kind(SeriesKind::Line(LineStyle {
52        color: Rgba {
53            r: 0.95,
54            g: 0.64,
55            b: 0.28,
56            a: 1.0,
57        },
58        width: 2.0,
59    }));
60
61    for i in 0..1_000 {
62        let phase = i as f64 * 0.02;
63        let _ = stream_a.push_y((phase * 0.9).sin() + 0.2 * (phase * 0.13).cos());
64        let _ = stream_b.push_y((phase * 0.45).cos() * 1.15 + 0.15 * (phase * 0.09).sin());
65    }
66
67    let events = Series::from_iter_points(
68        "events(scatter)",
69        (0..200).map(|i| {
70            let x = i as f64 * 80.0 + 40.0;
71            let y = (x * 0.02).sin() * 0.9;
72            gpui_liveplot::Point::new(x, y)
73        }),
74        SeriesKind::Scatter(MarkerStyle {
75            color: Rgba {
76                r: 0.95,
77                g: 0.25,
78                b: 0.55,
79                a: 1.0,
80            },
81            size: 5.0,
82            shape: MarkerShape::Circle,
83        }),
84    );
85
86    let baseline = Series::from_explicit_callback(
87        "baseline(callback)",
88        |x| (x * 0.015).sin() * 0.4,
89        Range::new(0.0, 25_000.0),
90        5_000,
91        SeriesKind::Line(LineStyle {
92            color: Rgba {
93                r: 0.45,
94                g: 0.45,
95                b: 0.5,
96                a: 0.8,
97            },
98            width: 1.0,
99        }),
100    );
101
102    let mut top_plot = Plot::builder()
103        .theme(Theme::dark())
104        .x_axis(AxisConfig::builder().title("Sample").build())
105        .y_axis(AxisConfig::builder().title("Top: stream + events").build())
106        .view(View::FollowLastN { points: 2_000 })
107        .build();
108    top_plot.add_series(&stream_a);
109    top_plot.add_series(&events);
110
111    let mut bottom_plot = Plot::builder()
112        .theme(Theme::dark())
113        .x_axis(AxisConfig::builder().title("Sample").build())
114        .y_axis(
115            AxisConfig::builder()
116                .title("Bottom: stream + baseline")
117                .build(),
118        )
119        .view(View::FollowLastNXY { points: 2_000 })
120        .build();
121    bottom_plot.add_series(&stream_b);
122    bottom_plot.add_series(&baseline);
123
124    let config = PlotViewConfig {
125        show_legend: true,
126        show_hover: true,
127        ..Default::default()
128    };
129
130    let link_group = PlotLinkGroup::new();
131    let options = PlotLinkOptions {
132        link_x: true,
133        link_y: false,
134        link_cursor: true,
135        link_brush: true,
136        link_reset: true,
137    };
138
139    let top = cx.new(|_| {
140        PlotView::with_config(top_plot, config.clone()).with_link_group(link_group.clone(), options)
141    });
142    let bottom =
143        cx.new(|_| PlotView::with_config(bottom_plot, config).with_link_group(link_group, options));
144
145    (top, bottom, stream_a, stream_b)
146}

Source

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

Access the pinned points.

Source

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

Access the pinned points mutably.

Source

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

Compute bounds across all visible series.

Source

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

Enter manual view with the given viewport.

Source

pub fn reset_view(&mut self)

Reset to automatic view.

Source

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§

Source §

impl Clone for Plot

Source §

fn clone(&self) -> Plot

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Plot

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Plot

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for Plot

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §

impl<T> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §