You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/user_guide/guide.rst
+6-16
Original file line number
Diff line number
Diff line change
@@ -549,10 +549,15 @@ between imgui and ipywidgets, Qt, and wx is the imgui UI can be rendered directl
549
549
i.e. it will work in jupyter, Qt, glfw and wx windows! The programming model is different from Qt and ipywidgets, there
550
550
are no callbacks, but it is easy to learn if you see a few examples.
551
551
552
+
.. image:: ../_static/guide_imgui.png
553
+
552
554
We specifically use `imgui-bundle <https://github.com/pthom/imgui_bundle>`_ for the python bindings in fastplotlib.
553
555
There is large community and many resources out there on building UIs using imgui.
554
556
555
-
For examples on integrating imgui with a fastplotlib Figure please see the examples gallery.
557
+
To install ``fastplotlib`` with ``imgui`` use the ``imgui`` extras option, i.e. ``pip install fastplotlib[imgui]``, or ``pip install imgui_bundle`` if you've already installed fastplotlib.
558
+
559
+
Fastplotlib comes built-in with imgui UIs for subplot toolbars and a standard right-click menu with a number of options.
560
+
You can also make custom GUIs and embed them within the canvas, see the examples gallery for detailed examples.
556
561
557
562
**Some tips:**
558
563
@@ -662,21 +667,6 @@ There are several spaces to consider when using ``fastplotlib``:
662
667
663
668
For more information on the various spaces used by rendering engines please see this `article <https://learnopengl.com/Getting-started/Coordinate-Systems>`_
664
669
665
-
Imgui
666
-
-----
667
-
668
-
Fastplotlib uses `imgui_bundle <https://github.com/pthom/imgui_bundle>`_ to provide within-canvas UI elemenents if you
669
-
installed ``fastplotlib`` using the ``imgui`` toggle, i.e. ``fastplotlib[imgui]``, or installed ``imgui_bundle`` afterwards.
670
-
671
-
Fastplotlib comes built-in with imgui UIs for subplot toolbars and a standard right-click menu with a number of options.
672
-
You can also make custom GUIs and embed them within the canvas, see the examples gallery for detailed examples.
673
-
674
-
.. note::
675
-
Imgui is optional, you can use other GUI frameworks such at Qt or ipywidgets with fastplotlib. You can also of course
0 commit comments