ImguiFigure#

ImguiFigure#

Constructor#

ImguiFigure([shape, rects, extents, ...])

Create a Figure containing Subplots.

Properties#

ImguiFigure.animations

Returns a dictionary of 'pre' and 'post' animation functions.

ImguiFigure.cameras

cameras, read-only array, access individual subplots to change a camera

ImguiFigure.canvas

The canvas this Figure is drawn onto

ImguiFigure.controllers

controllers, read-only array, access individual subplots to change a controller

ImguiFigure.default_imgui_font

ImguiFigure.imgui_renderer

imgui renderer

ImguiFigure.imgui_right_click

The imgui popup that is opened by a right-click within a subplot, a StandardRightClickMenu by default.

ImguiFigure.imgui_windows

edge imgui windows added to the Figure, keyed by location

ImguiFigure.layout

Layout engine

ImguiFigure.names

subplot names, read-only array, access individual subplots to change a name

ImguiFigure.renderer

The renderer that renders this Figure

ImguiFigure.shape

[n_rows, n_cols]

Methods#

ImguiFigure.add_animations(*funcs[, ...])

Add function(s) that are called on every render cycle.

ImguiFigure.add_imgui_window([window, ...])

Add an imgui window to the Figure.

ImguiFigure.add_subplot([rect, extent, ...])

ImguiFigure.append_imgui_right_click([gui])

Append imgui elements to the Figure's right-click popup, the standard right-click menu by default.

ImguiFigure.append_imgui_window([gui, location])

Append imgui elements to an existing edge window.

ImguiFigure.clear()

Clear all Subplots

ImguiFigure.clear_animations([removal])

Remove animation functions.

ImguiFigure.close()

ImguiFigure.export(uri, **kwargs)

Use imageio to export the current Figure to a file, or return a byte string.

ImguiFigure.export_numpy([rgb])

Export a snapshot of the Figure as numpy array.

ImguiFigure.get_pygfx_render_area(*args)

Get rect for the portion of the canvas that the pygfx renderer draws to, i.e. non-imgui, part of canvas.

ImguiFigure.remove_animation(func)

Removes the passed animation function from both pre and post render.

ImguiFigure.remove_imgui_right_click()

Remove and return the Figure's right-click popup

ImguiFigure.remove_imgui_window(location)

Remove and return the edge imgui window at the given location

ImguiFigure.remove_subplot(subplot)

ImguiFigure.set_imgui_right_click([popup, ...])

Set the imgui popup that is opened by a right-click within a subplot, replaces the standard right-click menu.

ImguiFigure.show([autoscale, ...])

Begins the rendering event loop and shows the Figure, returns the canvas