add_imgui_window#

Subplot.add_imgui_window(window=None, *, location=None, size=None, title=None, window_flags=None)[source]#

Add an imgui window confined to this subplot. Can also be used as a decorator, see the Figure.add_imgui_window examples.

Edge windows (“left”, “right”, “top”, “bottom”) reserve space outboard of the subplot dock on that edge. The “toolbar” location replaces the subplot toolbar. An existing window at a location is replaced.

Parameters:

  • window (ImguiWindow | ImguiContainer, optional) – an ImguiWindow instance, such as a Legend, or an ImguiContainer such as an ImguiColorbar, which is given a window of its own. Omit when decorating.

  • location (str, "left" | "right" | "top" | "bottom" | "toolbar") – edge windows reserve canvas space, “toolbar” replaces the subplot toolbar

  • size (int) – edge or toolbar thickness in pixels, required for edge windows

  • title (str, optional) – window title, drawn as a title bar for edge windows. If None no title bar is drawn.

  • window_flags (imgui.WindowFlags_, optional) – imgui window flags, used when decorating, uses the ImguiWindow default flags if not provided