diff options
Diffstat (limited to 'doc/source/modules/gui/plot')
-rw-r--r-- | doc/source/modules/gui/plot/getting_started.rst | 6 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/img/BasicGridStatsWidget.png | bin | 20668 -> 13381 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/img/BasicStatsWidget.png | bin | 8699 -> 9452 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/img/LimitsToolBar.png | bin | 21679 -> 21920 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/img/ROIStatsWidget.png | bin | 9659 -> 7176 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/img/logColorbar.png | bin | 12390 -> 7855 bytes | |||
-rw-r--r-- | doc/source/modules/gui/plot/items.rst | 31 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/plotsignal.rst | 1 | ||||
-rw-r--r-- | doc/source/modules/gui/plot/plotwidget.rst | 1 |
9 files changed, 35 insertions, 4 deletions
diff --git a/doc/source/modules/gui/plot/getting_started.rst b/doc/source/modules/gui/plot/getting_started.rst index c105395..ead9e43 100644 --- a/doc/source/modules/gui/plot/getting_started.rst +++ b/doc/source/modules/gui/plot/getting_started.rst @@ -20,8 +20,6 @@ For a complete description of the API, see :mod:`silx.gui.plot`. Use :mod:`silx.gui.plot` from (I)Python console ----------------------------------------------- -We recommend to use (I)Python >=3.5 and PyQt5. - From a Python or IPython interpreter, the simplest way is to import the :mod:`silx.sx` module: >>> from silx import sx @@ -87,9 +85,9 @@ A Qt GUI script must have a QApplication initialised before creating widgets: if __name__ == '__main__': [...] - qapp.exec_() + qapp.exec() -Unless a Qt binding has already been loaded, :mod:`silx.gui.qt` uses one of the supported Qt bindings (PyQt5, PyQt4, PySide2). +Unless a Qt binding has already been loaded, :mod:`silx.gui.qt` uses one of the supported Qt bindings (PyQt5, PySide6, PyQt6). If you prefer to choose the Qt binding yourself, import it before importing a module from :mod:`silx.gui`: diff --git a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png Binary files differindex 261909a..a468cc1 100644 --- a/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png +++ b/doc/source/modules/gui/plot/img/BasicGridStatsWidget.png diff --git a/doc/source/modules/gui/plot/img/BasicStatsWidget.png b/doc/source/modules/gui/plot/img/BasicStatsWidget.png Binary files differindex b0d815d..6dbdd30 100644 --- a/doc/source/modules/gui/plot/img/BasicStatsWidget.png +++ b/doc/source/modules/gui/plot/img/BasicStatsWidget.png diff --git a/doc/source/modules/gui/plot/img/LimitsToolBar.png b/doc/source/modules/gui/plot/img/LimitsToolBar.png Binary files differindex b360fe0..2d96458 100644 --- a/doc/source/modules/gui/plot/img/LimitsToolBar.png +++ b/doc/source/modules/gui/plot/img/LimitsToolBar.png diff --git a/doc/source/modules/gui/plot/img/ROIStatsWidget.png b/doc/source/modules/gui/plot/img/ROIStatsWidget.png Binary files differindex 7a634fe..fae9d62 100644 --- a/doc/source/modules/gui/plot/img/ROIStatsWidget.png +++ b/doc/source/modules/gui/plot/img/ROIStatsWidget.png diff --git a/doc/source/modules/gui/plot/img/logColorbar.png b/doc/source/modules/gui/plot/img/logColorbar.png Binary files differindex 49282e7..31594e0 100644 --- a/doc/source/modules/gui/plot/img/logColorbar.png +++ b/doc/source/modules/gui/plot/img/logColorbar.png diff --git a/doc/source/modules/gui/plot/items.rst b/doc/source/modules/gui/plot/items.rst index 43eb77e..2b2985b 100644 --- a/doc/source/modules/gui/plot/items.rst +++ b/doc/source/modules/gui/plot/items.rst @@ -118,3 +118,34 @@ Axis .. automodule:: silx.gui.plot.items.roi :members: + :show-inheritance: + + .. autoclass:: silx.gui.plot.items.roi.ArcROI + :members: + :show-inheritance: + + .. autoclass:: silx.gui.plot.items.roi.BandROI + :members: + :show-inheritance: + + +Base class for regions of interest +++++++++++++++++++++++++++++++++++ + +.. autoclass:: silx.gui.plot.items._roi_base._RegionOfInterestBase + :members: + :show-inheritance: + +.. autoclass:: silx.gui.plot.items.roi.RegionOfInterest + :members: + :show-inheritance: + +.. autoclass:: silx.gui.plot.items.roi.HandleBasedROI + :members: + :show-inheritance: + +.. autoclass:: silx.gui.plot.items.roi.InteractionModeMixIn + :members: + +.. autoclass:: silx.gui.plot.items.roi.RoiInteractionMode + :members: diff --git a/doc/source/modules/gui/plot/plotsignal.rst b/doc/source/modules/gui/plot/plotsignal.rst index 091f481..641b0ef 100644 --- a/doc/source/modules/gui/plot/plotsignal.rst +++ b/doc/source/modules/gui/plot/plotsignal.rst @@ -91,6 +91,7 @@ Both share the following keys: - 'event': 'curveClicked' or 'imageClicked' - 'button': the mouse button that was pressed in 'left', 'middle', 'right' +- 'item': The plot item object that was clicked - 'label': The legend associated with the clicked image or curve - 'type': The type of item in 'curve', 'image' - 'x' and 'y': The clicked position in data coordinates diff --git a/doc/source/modules/gui/plot/plotwidget.rst b/doc/source/modules/gui/plot/plotwidget.rst index d16c4ab..05dd77c 100644 --- a/doc/source/modules/gui/plot/plotwidget.rst +++ b/doc/source/modules/gui/plot/plotwidget.rst @@ -115,6 +115,7 @@ Interaction Those methods allow to change the interaction mode (e.g., drawing mode) of the plot and to toggle the use of a crosshair cursor: +.. automethod:: PlotWidget.interaction .. automethod:: PlotWidget.getInteractiveMode .. automethod:: PlotWidget.setInteractiveMode |