Multifigure toolbar

doc/devel/MEP/MEP27.rst

@@ -8,14 +8,16 @@
 
 Status
 ======
-**Discussion**
+**Progress**
 
 Branches and Pull requests
 ==========================
 Main PR (including GTK3):
+
 + https://github.com/matplotlib/matplotlib/pull/4143
 
 Backend specific branch diffs:
+
 + https://github.com/OceanWolf/matplotlib/compare/backend-refactor...OceanWolf:backend-refactor-tkagg
 + https://github.com/OceanWolf/matplotlib/compare/backend-refactor...OceanWolf:backend-refactor-qt
 + https://github.com/OceanWolf/matplotlib/compare/backend-refactor...backend-refactor-wx
@@ -79,7 +81,7 @@ The description of this MEP gives us most of the solution:
 1. To remove the windowing aspect out of ``FigureManagerBase`` letting
    it simply wrap this new class along with the other backend classes.
    Create a new ``WindowBase`` class that can handle this
-   functionality, with pass-through methods (:arrow_right:) to
+   functionality, with pass-through methods (->) to
    ``WindowBase``.  Classes that subclass ``WindowBase`` should also
    subclass the GUI specific window class to ensure backward
    compatibility (``manager.window == manager.window``).
@@ -103,30 +105,30 @@ The description of this MEP gives us most of the solution:
 |FigureManagerBase(canvas, num)        |FigureManager(figure, num)    |``WindowBase(title)``|Notes                           |
 |                                      |                              |                     |                                |
 +======================================+==============================+=====================+================================+
-|show                                  |                              |show                 |                                |
+|show                                  |->                            |show                 |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
 |destroy                               |calls destroy on all          |destroy              |                                |
 |                                      |components                    |                     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
 |full_screen_toggle                    |handles logic                 |set_fullscreen       |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|resize                                |                              |resize               |                                |
+|resize                                |->                            |resize               |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|key_press                             |key_press                     |                     |                                |
+|key_press                             |key_press                     |X                    |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|show_popup                            |show_poup                     |                     |Not used anywhere in mpl, and   |
+|show_popup                            |show_poup                     |X                    |Not used anywhere in mpl, and   |
 |                                      |                              |                     |does nothing.                   |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|get_window_title                      |                              |get_window_title     |                                |
+|get_window_title                      |->                            |get_window_title     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|set_window_title                      |                              |set_window_title     |                                |
+|set_window_title                      |->                            |set_window_title     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|                                      |_get_toolbar                  |                     |A common method to all          |
+|X                                     |_get_toolbar                  |X                    |A common method to all          |
 |                                      |                              |                     |subclasses of FigureManagerBase |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|                                      |                              |set_default_size     |                                |
+|X                                     |X                             |set_default_size     |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
-|                                      |                              |add_element_to_window|                                |
+|X                                     |X                             |add_element          |                                |
 +--------------------------------------+------------------------------+---------------------+--------------------------------+
 
 
@@ -135,14 +137,14 @@ The description of this MEP gives us most of the solution:
 +==========+============+=============+
 |mainloop  |begin       |             |
 +----------+------------+-------------+
-|          |end         |Gets called  |
+|X         |end         |Gets called  |
 |          |            |automagically|
 |          |            |when no more |
 |          |            |instances of |
 |          |            |the subclass |
 |          |            |exist        |
 +----------+------------+-------------+
-|__call__  |            |Method moved |
+|__call__  |X           |Method moved |
 |          |            |to           |
 |          |            |Gcf.show_all |
 +----------+------------+-------------+
@@ -191,6 +193,8 @@ in the same manner as everything else.
 |                         |                         |window, so this also     |
 |                         |                         |breaks BC.               |
 +-------------------------+-------------------------+-------------------------+
+|WebAgg                   |canvas                   |                         |
++-------------------------+-------------------------+-------------------------+
 
 
 Alternatives

doc/users/whats_new/plotting.rst

@@ -1,3 +1,11 @@
+Plot bar and barh with labels
+`````````````````````````````
+
+Added kwarg "tick_label" to bar and barh to support plotting bar graphs with a
+text label for each bar.
+Example:
+	bar([1, 2], [1, 1], tick_label=['bar1', 'bar2'])
+
 Added center and frame kwargs to pie
 ````````````````````````````````````
 

doc/users/whats_new/updated_figimage.rst

@@ -0,0 +1,8 @@
+updated figimage to take optional resize parameter
+----------------------------------------------------
+Added the ability to plot simple 2D-Array using plt.figimage(X, resize=True).
+This is useful for plotting simple 2D-Array without the Axes or whitespacing
+around the image.
+Example:
+	data = np.random.random( [500, 500] )
+	plt.figimage(data, resize=True)

doc/users/whats_new/updated_figure.rst

@@ -0,0 +1,9 @@
+Updated Figure.savefig()
+------------------------
+
+Added support to save the figure with the same dpi as the figure on the screen using dpi='figure'
+
+Example:
+	f = plt.figure(dpi=25)				# dpi set to 25
+	S = plt.scatter([1,2,3],[4,5,6])
+	f.savefig('output.png', dpi='figure')	# output savefig dpi set to 25 (same as figure)

doc/users/whats_new/updated_widgets.rst

@@ -0,0 +1,10 @@
+Moved ``ignore``, ``set_active``, and ``get_active`` methods to base class ``Widget``
+`````````````````````````````````````````````````````````````````````````````````
+Pushes up duplicate methods in child class to parent class to avoid duplication of code.
+
+
+Adds enable/disable feature to MultiCursor
+``````````````````````````````````````````
+A MultiCursor object can be disabled (and enabled) after it has been created without destroying the object. 
+Example:
+        multi_cursor.active = False

examples/user_interfaces/embedding_in_qt4.py

@@ -13,8 +13,8 @@
 import sys
 import os
 import random
-from matplotlib.backends import qt4_compat
-use_pyside = qt4_compat.QT_API == qt4_compat.QT_API_PYSIDE
+from matplotlib.backends import qt_compat
+use_pyside = qt_compat.QT_API == qt_compat.QT_API_PYSIDE
 if use_pyside:
     from PySide import QtGui, QtCore
 else:

examples/user_interfaces/embedding_in_qt5.py

@@ -0,0 +1,141 @@
+#!/usr/bin/env python
+
+# embedding_in_qt5.py --- Simple Qt5 application embedding matplotlib canvases
+#
+# Copyright (C) 2005 Florent Rougon
+#               2006 Darren Dale
+#               2015 Jens H Nielsen
+#
+# This file is an example program for matplotlib. It may be used and
+# modified with no restriction; raw copies as well as modified versions
+# may be distributed without limitation.
+
+from __future__ import unicode_literals
+import sys
+import os
+import random
+import matplotlib
+# Make sure that we are using QT5
+matplotlib.use('Qt5Agg')
+from PyQt5 import QtGui, QtCore, QtWidgets
+
+from numpy import arange, sin, pi
+from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg as FigureCanvas
+from matplotlib.figure import Figure
+
+progname = os.path.basename(sys.argv[0])
+progversion = "0.1"
+
+
+class MyMplCanvas(FigureCanvas):
+    """Ultimately, this is a QWidget (as well as a FigureCanvasAgg, etc.)."""
+
+    def __init__(self, parent=None, width=5, height=4, dpi=100):
+        fig = Figure(figsize=(width, height), dpi=dpi)
+        self.axes = fig.add_subplot(111)
+        # We want the axes cleared every time plot() is called
+        self.axes.hold(False)
+
+        self.compute_initial_figure()
+
+        #
+        FigureCanvas.__init__(self, fig)
+        self.setParent(parent)
+
+        FigureCanvas.setSizePolicy(self,
+                                   QtWidgets.QSizePolicy.Expanding,
+                                   QtWidgets.QSizePolicy.Expanding)
+        FigureCanvas.updateGeometry(self)
+
+    def compute_initial_figure(self):
+        pass
+
+
+class MyStaticMplCanvas(MyMplCanvas):
+    """Simple canvas with a sine plot."""
+
+    def compute_initial_figure(self):
+        t = arange(0.0, 3.0, 0.01)
+        s = sin(2*pi*t)
+        self.axes.plot(t, s)
+
+
+class MyDynamicMplCanvas(MyMplCanvas):
+    """A canvas that updates itself every second with a new plot."""
+
+    def __init__(self, *args, **kwargs):
+        MyMplCanvas.__init__(self, *args, **kwargs)
+        timer = QtCore.QTimer(self)
+        timer.timeout.connect(self.update_figure)
+        timer.start(1000)
+
+    def compute_initial_figure(self):
+        self.axes.plot([0, 1, 2, 3], [1, 2, 0, 4], 'r')
+
+    def update_figure(self):
+        # Build a list of 4 random integers between 0 and 10 (both inclusive)
+        l = [random.randint(0, 10) for i in range(4)]
+
+        self.axes.plot([0, 1, 2, 3], l, 'r')
+        self.draw()
+
+
+class ApplicationWindow(QtWidgets.QMainWindow):
+    def __init__(self):
+        QtWidgets.QMainWindow.__init__(self)
+        self.setAttribute(QtCore.Qt.WA_DeleteOnClose)
+        self.setWindowTitle("application main window")
+
+        self.file_menu = QtWidgets.QMenu('&File', self)
+        self.file_menu.addAction('&Quit', self.fileQuit,
+                                 QtCore.Qt.CTRL + QtCore.Qt.Key_Q)
+        self.menuBar().addMenu(self.file_menu)
+
+        self.help_menu = QtWidgets.QMenu('&Help', self)
+        self.menuBar().addSeparator()
+        self.menuBar().addMenu(self.help_menu)
+
+        self.help_menu.addAction('&About', self.about)
+
+        self.main_widget = QtWidgets.QWidget(self)
+
+        l = QtWidgets.QVBoxLayout(self.main_widget)
+        sc = MyStaticMplCanvas(self.main_widget, width=5, height=4, dpi=100)
+        dc = MyDynamicMplCanvas(self.main_widget, width=5, height=4, dpi=100)
+        l.addWidget(sc)
+        l.addWidget(dc)
+
+        self.main_widget.setFocus()
+        self.setCentralWidget(self.main_widget)
+
+        self.statusBar().showMessage("All hail matplotlib!", 2000)
+
+    def fileQuit(self):
+        self.close()
+
+    def closeEvent(self, ce):
+        self.fileQuit()
+
+    def about(self):
+        QtGui.QMessageBox.about(self, "About",
+                                """embedding_in_qt5.py example
+Copyright 2005 Florent Rougon, 2006 Darren Dale, 2015 Jens H Nielsen
+
+This program is a simple example of a Qt5 application embedding matplotlib
+canvases.
+
+It may be used and modified with no restriction; raw copies as well as
+modified versions may be distributed without limitation.
+
+This is modified from the embedding in qt4 example to show the difference
+between qt4 and qt5"""
+                                )
+
+
+qApp = QtWidgets.QApplication(sys.argv)
+
+aw = ApplicationWindow()
+aw.setWindowTitle("%s" % progname)
+aw.show()
+sys.exit(qApp.exec_())
+#qApp.exec_()

examples/user_interfaces/multifigure.py

@@ -0,0 +1,60 @@
+# from __future__ import print_function
+import matplotlib
+matplotlib.use('GTK3AGG')
+# matplotlib.rcParams['backend.multifigure'] = False
+matplotlib.rcParams['toolbar'] = 'toolmanager'
+from matplotlib.backend_tools import ToolToggleBase
+
+
+from matplotlib.figure import Figure
+from matplotlib.backend_managers import FigureManager
+
+
+class t1(ToolToggleBase):
+    radio_group = 'multifigure'
+    description = "change canvas"
+    def __init__(self, *args, **kwargs):
+        self.mfigure = kwargs.pop('figure')
+        ToolToggleBase.__init__(self, *args, **kwargs)
+
+    def enable(self, *args, **kwargs):
+        self.toolmanager.manager.figure = self.mfigure
+
+
+manager = FigureManager(None, 1)
+backend = manager._backend
+
+fig1 = Figure()
+canvas1 = backend.FigureCanvas(fig1)
+ax1 = fig1.add_subplot(111)
+ax1.plot([1, 2, 3])
+
+manager.figure = fig1
+
+fig2 = Figure()
+canvas2 = backend.FigureCanvas(fig2)
+ax2 = fig2.add_subplot(111)
+ax2.plot([3, 2, 1])
+
+fig3 = Figure()
+canvas3 = backend.FigureCanvas(fig3)
+ax3 = fig3.add_subplot(111)
+ax3.plot([1, 1, 1])
+
+sidebar = manager._get_toolbar()
+sidebar.set_flow('vertical')
+
+
+manager.toolmanager.add_tool('f1', t1, figure=fig1)
+manager.toolmanager.add_tool('f2', t1, figure=fig2)
+manager.toolmanager.add_tool('f3', t1, figure=fig3)
+sidebar.add_tool('f1', 'foo')
+sidebar.add_tool('f2', 'foo')
+sidebar.add_tool('f3', 'foo')
+manager.window.add_element(sidebar, False, 'west')
+
+
+manager.show()
+manager.mpl_connect('window_destroy_event', manager.destroy)
+manager._mainloop()
+