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 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: Axis, link_min: Option<&mut f64>, link_max: Option<&mut f64>, )

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

pub unsafe fn setup_axis_links_unchecked( &self, axis: ImAxis, link_min: Option<&mut f64>, link_max: Option<&mut f64>, )

Link a raw axis to external min/max values (live binding).

Safety

axis must be a valid ImPlot ImAxis value for the active plot. Passing an out-of-range value lets ImPlot index internal axis arrays out of bounds.

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: Axis, link_min: Option<&mut f64>, link_max: Option<&mut f64>, )

Link an axis to external min/max for next frame

pub unsafe fn set_next_axis_links_unchecked( &self, axis: ImAxis, link_min: Option<&mut f64>, link_max: Option<&mut f64>, )

Link a raw axis to external min/max for the next frame.

Safety

axis must be a valid ImPlot ImAxis value. Passing an out-of-range value lets ImPlot index internal next-plot arrays out of bounds.

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: Axis)

Fit next frame a specific axis

pub unsafe fn set_next_axis_to_fit_unchecked(&self, axis: ImAxis)

Fit next frame a raw axis.

Safety

axis must be a valid ImPlot ImAxis value. Passing an out-of-range value lets ImPlot index internal next-plot arrays out of bounds.

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.

If labels is provided, it must have the same length as values.

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.

If labels is provided, it must have the same length as values.

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

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

If labels is provided, it must have length n_ticks.

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

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

If labels is provided, it must have length n_ticks.

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: Axis, v_min: f64, v_max: f64)

Setup axis limits constraints

pub unsafe fn setup_axis_limits_constraints_unchecked( &self, axis: ImAxis, v_min: f64, v_max: f64, )

Setup raw axis limits constraints.

Safety

axis must be a valid ImPlot ImAxis value for the active plot. Passing an out-of-range value lets ImPlot index internal axis arrays out of bounds.

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

Setup axis zoom constraints

pub unsafe fn setup_axis_zoom_constraints_unchecked( &self, axis: ImAxis, z_min: f64, z_max: f64, )

Setup raw axis zoom constraints.

Safety

axis must be a valid ImPlot ImAxis value for the active plot. Passing an out-of-range value lets ImPlot index internal axis arrays out of bounds.

impl<'ui> PlotUi<'ui>

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.

The closure is kept alive until the current plot ends.

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.

The closure is kept alive until the current plot ends.

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

The closures are kept alive until the current plot ends.

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>

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 plot_polygon(&self, label: &str, x_data: &[f64], y_data: &[f64])

Plot a polygon with the given label and vertex 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

impl<'ui> PlotUi<'ui>

pub fn with_next_plot_item_array_style<'a, R>( &self, style: PlotItemArrayStyle<'a>, f: impl FnOnce(&PlotUi<'ui>) -> R, ) -> R

Apply array-backed item styling to the next plot submission executed inside f.

This is closure-scoped so borrowed slices stay valid for the entire next plot call and are restored even if f panics before submitting an item.

pub fn push_style_var_f32(&self, var: StyleVar, value: f32) -> StyleVarToken<'_>

Push a float style variable to this ImPlot context’s stack.

pub fn push_style_var_vec2( &self, var: StyleVar, value: [f32; 2], ) -> StyleVarToken<'_>

Push a Vec2 style variable to this ImPlot context’s stack.

pub fn push_style_color( &self, element: PlotColorElement, color: [f32; 4], ) -> StyleColorToken<'_>

Push a style color to this ImPlot context’s stack.

pub fn push_colormap(&self, cmap: impl Into<ColormapIndex>) -> ColormapToken<'_>

Push a colormap to this ImPlot context’s stack.

pub fn push_colormap_name(&self, name: &str) -> ColormapToken<'_>

Push a colormap by name to this ImPlot context’s stack.

impl PlotUi<'_>

pub fn show_style_editor(&self)

Show the ImPlot style editor window for this context.

pub fn show_style_selector(&self, label: &str) -> bool

Show the ImPlot style selector combo; returns true if selection changed.

pub fn show_colormap_selector(&self, label: &str) -> bool

Show the ImPlot colormap selector combo; returns true if selection changed.

pub fn show_input_map_selector(&self, label: &str) -> bool

Show the ImPlot input-map selector combo; returns true if selection changed.

pub fn colormap_scale( &self, label: &str, scale_min: f64, scale_max: f64, height: f32, cmap: impl Into<ColormapSelection>, )

Draw a colormap scale widget.

pub fn colormap_slider( &self, label: &str, t: &mut f32, out_color: Option<&mut [f32; 4]>, format: Option<&str>, cmap: impl Into<ColormapSelection>, ) -> bool

Draw a colormap slider; returns true if selection changed.

pub fn colormap_button( &self, label: &str, size: [f32; 2], cmap: impl Into<ColormapSelection>, ) -> bool

Draw a colormap picker button; returns true if clicked.

impl PlotUi<'_>

pub fn is_subplots_hovered(&self) -> bool

Check if any subplots area is hovered.

pub fn is_legend_entry_hovered(&self, label: &str) -> bool

Check if a legend entry is hovered.

pub fn plot_mouse_position( &self, y_axis_choice: Option<YAxisChoice>, ) -> ImPlotPoint

Get the mouse position in plot coordinates.

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

Get the mouse position in plot coordinates for specific axes.

pub fn pixels_to_plot( &self, pixel_position: [f32; 2], y_axis_choice: Option<YAxisChoice>, ) -> ImPlotPoint

Convert pixels to plot coordinates.

pub fn pixels_to_plot_axes( &self, pixel_position: [f32; 2], x_axis: XAxis, y_axis: YAxis, ) -> ImPlotPoint

Convert pixels to plot coordinates for specific axes.

pub fn plot_to_pixels( &self, plot_position: ImPlotPoint, y_axis_choice: Option<YAxisChoice>, ) -> [f32; 2]

Convert plot coordinates to pixels.

pub fn plot_to_pixels_axes( &self, plot_position: ImPlotPoint, x_axis: XAxis, y_axis: YAxis, ) -> [f32; 2]

Convert plot coordinates to pixels for specific axes.

pub fn plot_limits( &self, _x_axis_choice: Option<YAxisChoice>, y_axis_choice: Option<YAxisChoice>, ) -> ImPlotRect

Get the current plot limits.

pub fn is_plot_selected(&self) -> bool

Whether a plot has an active selection region.

pub fn plot_selection_axes( &self, x_axis: XAxis, y_axis: YAxis, ) -> Option<ImPlotRect>

Get the current plot selection rectangle for specific axes.

pub fn annotation_point( &self, x: f64, y: f64, color: [f32; 4], pixel_offset: [f32; 2], clamp: bool, round: bool, )

Draw a simple round annotation marker at (x,y).

pub fn annotation_text( &self, x: f64, y: f64, color: [f32; 4], pixel_offset: [f32; 2], clamp: bool, text: &str, )

Draw a text annotation at (x,y) using the non-variadic ImPlot_Annotation_Str0 API.

This avoids calling the C variadic (...) entrypoint, which is not supported on some targets (e.g. wasm32 via import-style bindings).

pub fn tag_x(&self, x: f64, color: [f32; 4], round: bool)

Tag the X axis at position x with a tick-like mark.

pub fn tag_x_text(&self, x: f64, color: [f32; 4], text: &str)

Tag the X axis at position x with a text label using the non-variadic ImPlot_TagX_Str0 API.

pub fn tag_y(&self, y: f64, color: [f32; 4], round: bool)

Tag the Y axis at position y with a tick-like mark.

pub fn tag_y_text(&self, y: f64, color: [f32; 4], text: &str)

Tag the Y axis at position y with a text label using the non-variadic ImPlot_TagY_Str0 API.

pub fn plot_limits_axes(&self, x_axis: XAxis, y_axis: YAxis) -> ImPlotRect

Get the current plot limits for specific axes.

pub fn is_axis_hovered(&self, axis: Axis) -> bool

Check if an axis is hovered.

pub unsafe fn is_axis_hovered_unchecked(&self, axis: ImAxis) -> bool

Check if a raw axis is hovered.

Safety

axis must be a valid ImPlot ImAxis value for the current plot. Passing an out-of-range value lets ImPlot index internal axis arrays out of bounds.

pub fn is_plot_x_axis_hovered(&self) -> bool

Check if the X axis is hovered.

pub fn is_plot_x_axis_hovered_axis(&self, x_axis: XAxis) -> bool

Check if a specific X axis is hovered.

pub fn is_plot_y_axis_hovered(&self, y_axis_choice: Option<YAxisChoice>) -> bool

Check if a Y axis is hovered.

pub fn is_plot_y_axis_hovered_axis(&self, y_axis: YAxis) -> bool

Check if a specific Y axis is hovered.

pub fn show_demo_window(&self, _show: &mut bool)

Stub when demo feature is disabled.

pub fn show_user_guide(&self)

Show the built-in user guide for ImPlot.

pub fn show_metrics_window(&self, open: &mut bool)

Show the metrics window.

pub fn plot_pos(&self) -> [f32; 2]

Get current plot position (top-left) in pixels.

pub fn plot_size(&self) -> [f32; 2]

Get current plot size in pixels.

impl PlotUi<'_>

pub fn drag_point( &self, id: DragToolId, x: &mut f64, y: &mut f64, color: [f32; 4], size: f32, flags: DragToolFlags, ) -> DragResult

Draggable point with result flags.

pub fn drag_line_x( &self, id: DragToolId, x: &mut f64, color: [f32; 4], thickness: f32, flags: DragToolFlags, ) -> DragResult

Draggable vertical line at x.

pub fn drag_line_y( &self, id: DragToolId, y: &mut f64, color: [f32; 4], thickness: f32, flags: DragToolFlags, ) -> DragResult

Draggable horizontal line at y.

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: impl Into<HistogramBins>, ) -> 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: impl Into<HistogramBins>, y_bins: impl Into<HistogramBins>, ) -> Result<(), PlotError>

Plot a 2D histogram with custom bin counts

impl<'ui> PlotUi<'ui>

Convenience methods on PlotUi

pub fn plot_image<'tex>( &self, label: &str, texture: impl Into<TextureRef<'tex>>, 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 polygon plotting.

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

Plot a polygon with X and Y vertex data.

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