Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a table with the intended use case of each widget category to the documentation #2793

Merged
merged 1 commit into from
Aug 30, 2023
Merged

Add a table with the intended use case of each widget category to the documentation #2793

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion app/display/editor/doc/widgets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,38 @@ Widgets
=======

The Display Builder application supports a set of widgets which can be used to create control GUIs. The widgets are
organized based on functionality as shown below
organized according to the categories *Graphics*, *Monitors*, *Controls*, *Plots*, *Structure*, and *Miscellaneous*:

.. image:: images/widgets.png
:align: center

Each category corresponds to an intended use case of the widgets belonging to the category:

.. list-table::
:widths: 30 70
:header-rows: 1
:align: center

* - Widget Category
- Intended Use Case

* - `Graphics`
- Static graphical elements

* - `Monitors`
- Displaying values from PVs

* - `Controls`
- Writing values to PVs

* - `Plots`
- Plotting PV values

* - `Structure`
- Grouping widgets and embedding displays

* - `Miscellaneous`
- 3D Viewer, Web Browser

.. toctree::
:maxdepth: 1
Expand Down
Loading