diff --git a/doc/source/modules/gui/plot/items.rst b/doc/source/modules/gui/plot/items.rst index 43eb77e0b5..2b2985b13b 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/src/silx/gui/plot/items/_roi_base.py b/src/silx/gui/plot/items/_roi_base.py index c0c58fc4ed..2698c9c07a 100644 --- a/src/silx/gui/plot/items/_roi_base.py +++ b/src/silx/gui/plot/items/_roi_base.py @@ -118,10 +118,12 @@ def __init__(self, label, description=None): @property def label(self): + """Short name""" return self._label @property def description(self): + """Longer description of the interaction mode""" return self._description