Skip to content

Commit

Permalink
DOC: Add documentation for the plot curve editor.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hugo Slepicka committed Nov 13, 2019
1 parent 645c6e5 commit 0a16c65
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/source/widgets/curve_editor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#######################
Plot Curve Editor
#######################

PyDM plot widgets keep the inventory of curves in the ``curves`` property which
is a list of JSON strings containing the definition of parameters for each of
the curves in a plot.

Since editing a list of JSON strings via Qt Designer is very unfriendly and
error prone, PyDM offers the Plot Curve Editor extension which can be invoked
via a Right-click and selecting the "Edit Curves..." item in the context menu
that pops-up.

.. figure:: /_static/widgets/curve_editor/curve_editor.gif
:scale: 100 %
:align: center
:alt: Curve Editor in Action

This animation demonstrates how to use the Curve Editor that is common to
all the PyDM plot widgets.


.. Note::
This is not applicable for users interacting with widgets via Python code.
In this case you will need to serialize the list of JSON strings and use the
``setCurves`` property to configure the plot properly.
1 change: 1 addition & 0 deletions docs/source/widgets/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Plot Widgets
.. toctree::
:maxdepth: 1

curve_editor.rst
scatterplot.rst
timeplot.rst
waveformplot.rst
Expand Down

0 comments on commit 0a16c65

Please sign in to comment.