Struct PlotUi 

pub struct PlotUi<'ui> { /* private fields */ }

A temporary reference for building plots

This struct ensures that plots can only be created when both ImGui and ImPlot contexts are available and properly set up.

Implementations

impl<'ui> PlotUi<'ui>

pub fn begin_plot(&self, title: &str) -> Option<PlotToken<'_>>

Begin a new plot with the given title

Returns a PlotToken if the plot was successfully started. The plot will be automatically ended when the token is dropped.

pub fn begin_plot_with_size( &self, title: &str, size: [f32; 2], ) -> Option<PlotToken<'_>>

Begin a plot with custom size

pub fn plot_line(&self, label: &str, x_data: &[f64], y_data: &[f64])

Plot a line with the given label and data

This is a convenience method that can be called within a plot.

pub fn plot_scatter(&self, label: &str, x_data: &[f64], y_data: &[f64])

Plot a scatter plot with the given label and data

pub fn is_plot_hovered(&self) -> bool

Check if the plot area is hovered

pub fn get_plot_mouse_pos(&self, y_axis: Option<YAxisChoice>) -> ImPlotPoint

Get the mouse position in plot coordinates

pub fn get_plot_mouse_pos_axes( &self, x_axis: XAxis, y_axis: YAxis, ) -> ImPlotPoint

Get the mouse position in plot coordinates for specific axes

pub fn set_axes(&self, x_axis: XAxis, y_axis: YAxis)

Set current axes for subsequent plot submissions

pub fn setup_x_axis(&self, axis: XAxis, label: Option<&str>, flags: AxisFlags)

Setup a specific X axis

pub fn setup_y_axis(&self, axis: YAxis, label: Option<&str>, flags: AxisFlags)

Setup a specific Y axis

pub fn setup_x_axis_limits( &self, axis: XAxis, min: f64, max: f64, cond: PlotCond, )

Setup axis limits for a specific X axis

pub fn setup_y_axis_limits( &self, axis: YAxis, min: f64, max: f64, cond: PlotCond, )

Setup axis limits for a specific Y axis

pub fn setup_axis_links( &self, axis: i32, link_min: Option<&mut f64>, link_max: Option<&mut f64>, )

Link an axis to external min/max values (live binding)

pub fn setup_axes( &self, x_label: Option<&str>, y_label: Option<&str>, x_flags: AxisFlags, y_flags: AxisFlags, )

Setup both axes labels/flags at once

pub fn setup_axes_limits( &self, x_min: f64, x_max: f64, y_min: f64, y_max: f64, cond: PlotCond, )

Setup axes limits (both) at once

pub fn setup_finish(&self)

Call after axis setup to finalize configuration

pub fn set_next_x_axis_limits( &self, axis: XAxis, min: f64, max: f64, cond: PlotCond, )

Set next frame limits for a specific axis

pub fn set_next_y_axis_limits( &self, axis: YAxis, min: f64, max: f64, cond: PlotCond, )

Set next frame limits for a specific axis

pub fn set_next_axis_links( &self, axis: i32, link_min: Option<&mut f64>, link_max: Option<&mut f64>, )

Link an axis to external min/max for next frame

pub fn set_next_axes_limits( &self, x_min: f64, x_max: f64, y_min: f64, y_max: f64, cond: PlotCond, )

Set next frame limits for both axes

pub fn set_next_axes_to_fit(&self)

Fit next frame both axes

pub fn set_next_axis_to_fit(&self, axis: i32)

Fit next frame a specific axis (raw)

pub fn set_next_x_axis_to_fit(&self, axis: XAxis)

Fit next frame a specific X axis

pub fn set_next_y_axis_to_fit(&self, axis: YAxis)

Fit next frame a specific Y axis

pub fn setup_x_axis_ticks_positions( &self, axis: XAxis, values: &[f64], labels: Option<&[&str]>, keep_default: bool, )

Setup ticks with explicit positions and optional labels for an X axis

pub fn setup_y_axis_ticks_positions( &self, axis: YAxis, values: &[f64], labels: Option<&[&str]>, keep_default: bool, )

Setup ticks with explicit positions and optional labels for a Y axis

pub fn setup_x_axis_ticks_range( &self, axis: XAxis, v_min: f64, v_max: f64, n_ticks: i32, labels: Option<&[&str]>, keep_default: bool, )

Setup ticks on a range with tick count and optional labels for an X axis

pub fn setup_y_axis_ticks_range( &self, axis: YAxis, v_min: f64, v_max: f64, n_ticks: i32, labels: Option<&[&str]>, keep_default: bool, )

Setup ticks on a range with tick count and optional labels for a Y axis

pub fn setup_x_axis_format(&self, axis: XAxis, fmt: &str)

Setup tick label format string for a specific X axis

pub fn setup_y_axis_format(&self, axis: YAxis, fmt: &str)

Setup tick label format string for a specific Y axis

pub fn setup_x_axis_scale(&self, axis: XAxis, scale: ImPlotScale)

Setup scale for a specific X axis (pass sys::ImPlotScale variant)

pub fn setup_y_axis_scale(&self, axis: YAxis, scale: ImPlotScale)

Setup scale for a specific Y axis (pass sys::ImPlotScale variant)

pub fn setup_axis_limits_constraints(&self, axis: i32, v_min: f64, v_max: f64)

Setup axis limits constraints

pub fn setup_axis_zoom_constraints(&self, axis: i32, z_min: f64, z_max: f64)

Setup axis zoom constraints

pub fn setup_x_axis_format_closure<F>( &self, axis: XAxis, f: F, ) -> AxisFormatterToken

where F: Fn(f64) -> String + Send + Sync + 'static,

Setup tick label formatter using a Rust closure (lives until token drop)

pub fn setup_y_axis_format_closure<F>( &self, axis: YAxis, f: F, ) -> AxisFormatterToken

where F: Fn(f64) -> String + Send + Sync + 'static,

Setup tick label formatter using a Rust closure (lives until token drop)

pub fn setup_x_axis_transform_closure<FW, INV>( &self, axis: XAxis, forward: FW, inverse: INV, ) -> AxisTransformToken

where FW: Fn(f64) -> f64 + Send + Sync + 'static, INV: Fn(f64) -> f64 + Send + Sync + 'static,

Setup custom axis transform using Rust closures (forward/inverse) valid until token drop

pub fn setup_y_axis_transform_closure<FW, INV>( &self, axis: YAxis, forward: FW, inverse: INV, ) -> AxisTransformToken

where FW: Fn(f64) -> f64 + Send + Sync + 'static, INV: Fn(f64) -> f64 + Send + Sync + 'static,

Setup custom axis transform for Y axis using closures

impl<'ui> PlotUi<'ui>

Convenience functions for quick bar plotting

pub fn bar_plot(&self, label: &str, values: &[f64]) -> Result<(), PlotError>

Plot a bar chart with values (X will be indices)

pub fn bar_plot_with_width( &self, label: &str, values: &[f64], width: f64, ) -> Result<(), PlotError>

Plot a bar chart with custom bar width

pub fn positional_bar_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], ) -> Result<(), PlotError>

Plot a positional bar chart with explicit X and Y data

impl<'ui> PlotUi<'ui>

Convenience functions for quick error bars plotting

pub fn error_bars_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], err_data: &[f64], ) -> Result<(), PlotError>

Plot error bars with symmetric errors

pub fn asymmetric_error_bars_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], err_neg: &[f64], err_pos: &[f64], ) -> Result<(), PlotError>

Plot error bars with asymmetric errors

pub fn simple_error_bars_plot( &self, label: &str, values: &[f64], errors: &[f64], ) -> Result<(), PlotError>

Plot simple error bars with Y values only (X will be indices)

impl<'ui> PlotUi<'ui>

Convenience functions for quick heatmap plotting

pub fn heatmap_plot( &self, label: &str, values: &[f64], rows: usize, cols: usize, ) -> Result<(), PlotError>

Plot a heatmap with f64 data

pub fn heatmap_plot_f32( &self, label: &str, values: &[f32], rows: usize, cols: usize, ) -> Result<(), PlotError>

Plot a heatmap with f32 data

pub fn heatmap_plot_scaled( &self, label: &str, values: &[f64], rows: usize, cols: usize, scale_min: f64, scale_max: f64, bounds_min: ImPlotPoint, bounds_max: ImPlotPoint, ) -> Result<(), PlotError>

Plot a heatmap with custom scale and bounds

impl<'ui> PlotUi<'ui>

Convenience functions for quick histogram plotting

pub fn histogram_plot( &self, label: &str, values: &[f64], ) -> Result<(), PlotError>

Plot a 1D histogram with default settings

pub fn histogram_plot_with_bins( &self, label: &str, values: &[f64], bins: i32, ) -> Result<(), PlotError>

Plot a 1D histogram with custom bin count

pub fn histogram_2d_plot( &self, label: &str, x_values: &[f64], y_values: &[f64], ) -> Result<(), PlotError>

Plot a 2D histogram (bivariate histogram as heatmap)

pub fn histogram_2d_plot_with_bins( &self, label: &str, x_values: &[f64], y_values: &[f64], x_bins: i32, y_bins: i32, ) -> Result<(), PlotError>

Plot a 2D histogram with custom bin counts

impl<'ui> PlotUi<'ui>

Convenience methods on PlotUi

pub fn plot_image( &self, label: &str, tex_id: ImTextureID, bounds_min: ImPlotPoint, bounds_max: ImPlotPoint, ) -> Result<(), PlotError>

pub fn plot_image_with_imgui_texture( &self, label: &str, texture: TextureId, bounds_min: ImPlotPoint, bounds_max: ImPlotPoint, ) -> Result<(), PlotError>

Plot an image using ImGui’s TextureId wrapper (if available)

impl<'ui> PlotUi<'ui>

Convenience functions for quick inf-lines plotting

pub fn inf_lines_vertical( &self, label: &str, xs: &[f64], ) -> Result<(), PlotError>

Plot vertical infinite lines at given x positions

pub fn inf_lines_horizontal( &self, label: &str, ys: &[f64], ) -> Result<(), PlotError>

Plot horizontal infinite lines at given y positions

impl<'ui> PlotUi<'ui>

Convenience functions for quick line plotting

pub fn line_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], ) -> Result<(), PlotError>

Plot a line with X and Y data

pub fn simple_line_plot( &self, label: &str, values: &[f64], ) -> Result<(), PlotError>

Plot a simple line with Y values only (X will be indices)

impl<'ui> PlotUi<'ui>

Convenience functions for quick pie chart plotting

pub fn pie_chart_plot( &self, label_ids: Vec<&str>, values: &[f64], center_x: f64, center_y: f64, radius: f64, ) -> Result<(), PlotError>

Plot a pie chart with f64 data

pub fn pie_chart_plot_f32( &self, label_ids: Vec<&str>, values: &[f32], center_x: f64, center_y: f64, radius: f64, ) -> Result<(), PlotError>

Plot a pie chart with f32 data

pub fn centered_pie_chart( &self, label_ids: Vec<&str>, values: &[f64], ) -> Result<(), PlotError>

Plot a centered pie chart (center at 0.5, 0.5 with radius 0.4)

impl<'ui> PlotUi<'ui>

Convenience functions for quick scatter plotting

pub fn scatter_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], ) -> Result<(), PlotError>

Plot a scatter plot with X and Y data

pub fn simple_scatter_plot( &self, label: &str, values: &[f64], ) -> Result<(), PlotError>

Plot a simple scatter plot with Y values only (X will be indices)

impl<'ui> PlotUi<'ui>

Convenience functions for quick shaded plotting

pub fn shaded_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], ) -> Result<(), PlotError>

Plot a shaded area between a line and Y=0

pub fn shaded_plot_with_ref( &self, label: &str, x_data: &[f64], y_data: &[f64], y_ref: f64, ) -> Result<(), PlotError>

Plot a shaded area between a line and a reference Y value

pub fn shaded_between_plot( &self, label: &str, x_data: &[f64], y1_data: &[f64], y2_data: &[f64], ) -> Result<(), PlotError>

Plot a shaded area between two lines

pub fn simple_shaded_plot( &self, label: &str, values: &[f64], ) -> Result<(), PlotError>

Plot a simple shaded area with Y values only (X will be indices)

impl<'ui> PlotUi<'ui>

Convenience functions for quick stem plotting

pub fn stem_plot( &self, label: &str, x_data: &[f64], y_data: &[f64], ) -> Result<(), PlotError>

Plot a stem plot with X and Y data

pub fn stem_plot_with_ref( &self, label: &str, x_data: &[f64], y_data: &[f64], y_ref: f64, ) -> Result<(), PlotError>

Plot a stem plot with custom reference Y value

pub fn simple_stem_plot( &self, label: &str, values: &[f64], ) -> Result<(), PlotError>

Plot a simple stem plot with Y values only (X will be indices)

pub fn simple_stem_plot_with_ref( &self, label: &str, values: &[f64], y_ref: f64, ) -> Result<(), PlotError>

Plot a simple stem plot with custom reference Y value