1 files changed, 154 insertions, 0 deletions
diff --git a/examples/plotCurveLegendWidget.py b/examples/plotCurveLegendWidget.py
new file mode 100644
index 0000000..9209c58
--- /dev/null
+++ b/examples/plotCurveLegendWidget.py
@@ -0,0 +1,154 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""This example illustrates the use of :class:`CurveLegendsWidget`.
+
+:class:`CurveLegendsWidget` display curves style and legend currently visible
+in a :class:`~silx.gui.plot.PlotWidget`
+"""
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "20/07/2018"
+
+import functools
+
+import numpy
+
+from silx.gui import qt
+from silx.gui.plot import Plot1D
+from silx.gui.plot.tools.CurveLegendsWidget import CurveLegendsWidget
+from silx.gui.widgets.BoxLayoutDockWidget import BoxLayoutDockWidget
+
+
+class MyCurveLegendsWidget(CurveLegendsWidget):
+    """Extension of CurveLegendWidget.
+
+    This widget adds:
+    - Set a curve as active with a left click its the legend
+    - Adds a context menu with content specific to the hovered legend
+
+    :param QWidget parent: See QWidget
+    """
+
+    def __init__(self, parent=None):
+        super(MyCurveLegendsWidget, self).__init__(parent)
+
+        # Activate/Deactivate curve with left click on the legend widget
+        self.sigCurveClicked.connect(self._switchCurveActive)
+
+        # Add a custom context menu
+        self.setContextMenuPolicy(qt.Qt.CustomContextMenu)
+        self.customContextMenuRequested.connect(self._contextMenu)
+
+    def _switchCurveActive(self, curve):
+        """Set a curve as active.
+
+        This is called from the context menu and when a legend is clicked.
+
+        :param silx.gui.plot.items.Curve curve:
+        """
+        plot = curve.getPlot()
+        plot.setActiveCurve(
+            curve.getLegend() if curve != plot.getActiveCurve() else None)
+
+    def _switchCurveVisibility(self, curve):
+        """Toggle the visibility of a curve
+
+        :param silx.gui.plot.items.Curve curve:
+        """
+        curve.setVisible(not curve.isVisible())
+
+    def _switchCurveYAxis(self, curve):
+        """Change the Y axis a curve is attached to.
+
+        :param silx.gui.plot.items.Curve curve:
+        """
+        yaxis = curve.getYAxis()
+        curve.setYAxis('left' if yaxis is 'right' else 'right')
+
+    def _contextMenu(self, pos):
+        """Create a show the context menu.
+
+        :param QPoint pos: Position in this widget
+        """
+        curve = self.curveAt(pos)  # Retrieve curve from hovered legend
+        if curve is not None:
+            menu = qt.QMenu()  # Create the menu
+
+            # Add an action to activate the curve
+            activeCurve = curve.getPlot().getActiveCurve()
+            menu.addAction('Unselect' if curve == activeCurve else 'Select',
+                           functools.partial(self._switchCurveActive, curve))
+
+            # Add an action to switch the Y axis of a curve
+            yaxis = 'right' if curve.getYAxis() == 'left' else 'left'
+            menu.addAction('Map to %s' % yaxis,
+                           functools.partial(self._switchCurveYAxis, curve))
+
+            # Add an action to show/hide the curve
+            menu.addAction('Hide' if curve.isVisible() else 'Show',
+                           functools.partial(self._switchCurveVisibility, curve))
+
+            globalPosition = self.mapToGlobal(pos)
+            menu.exec_(globalPosition)
+
+
+# First create the QApplication
+app = qt.QApplication([])
+
+# Create a plot and add some curves
+window = Plot1D()
+window.setWindowTitle("CurveLegendWidgets demo")
+
+x = numpy.linspace(-numpy.pi, numpy.pi, 100)
+window.addCurve(x, 2. * numpy.random.random(100) - 1.,
+                legend='random',
+                symbol='s', linestyle='--',
+                color='red')
+window.addCurve(x, numpy.sin(x),
+                legend='sin',
+                symbol='o', linestyle=':',
+                color='blue')
+window.addCurve(x, numpy.cos(x),
+                legend='cos',
+                symbol='', linestyle='-',
+                color='blue')
+
+
+# Create a MyCurveLegendWidget associated to the plot
+curveLegendsWidget = MyCurveLegendsWidget()
+curveLegendsWidget.setPlotWidget(window)
+
+# Add the CurveLegendsWidget as a dock widget to the plot
+dock = BoxLayoutDockWidget()
+dock.setWindowTitle('Curve legends')
+dock.setWidget(curveLegendsWidget)
+window.addDockWidget(qt.Qt.RightDockWidgetArea, dock)
+
+# Show the plot and run the QApplication
+window.setAttribute(qt.Qt.WA_DeleteOnClose)
+window.show()
+
+app.exec_()