Add keymap (default: G) to toggle minor grid.

anntzer · anntzer · commit e8de04c4a238 · 2016-08-01T01:15:28.000-07:00
If either minor grid is on, turn both of them off.  Otherwise, turn all
major and minor grids on (it usually doesn't make sense to have the
minor grids only).

Also change the behavior of `keymap.grid` ("g") to synchronize the grid
state of both axes.  Otherwise, if starting from only grids in one
direction (`plt.plot(); plt.grid(axis="x")`), "g" switches between only
`x` grid and only `y` grid, which is unlikely to be the expected
behavior.
diff --git a/doc/users/navigation_toolbar.rst b/doc/users/navigation_toolbar.rst
@@ -99,7 +99,8 @@ Close all plots                    **shift** + **w**
 Constrain pan/zoom to x axis       hold **x** when panning/zooming with mouse
 Constrain pan/zoom to y axis       hold **y** when panning/zooming with mouse
 Preserve aspect ratio              hold **CONTROL** when panning/zooming with mouse
-Toggle grid                        **g** when mouse is over an axes
+Toggle major grid                  **g** when mouse is over an axes
+Toggle major and minor grid        **G** when mouse is over an axes
 Toggle x axis scale (log/linear)   **L** or **k**  when mouse is over an axes
 Toggle y axis scale (log/linear)   **l** when mouse is over an axes
 ================================== =================================================
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2482,6 +2482,7 @@ def key_press_handler(event, canvas, toolbar=None):
     save_keys = rcParams['keymap.save']
     quit_keys = rcParams['keymap.quit']
     grid_keys = rcParams['keymap.grid']
+    grid_minor_keys = rcParams['keymap.grid_minor']
     toggle_yscale_keys = rcParams['keymap.yscale']
     toggle_xscale_keys = rcParams['keymap.xscale']
     all = rcParams['keymap.all_axes']
@@ -2525,13 +2526,28 @@ def key_press_handler(event, canvas, toolbar=None):
 
     # these bindings require the mouse to be over an axes to trigger
 
+    ax = event.inaxes
     # switching on/off a grid in current axes (default key 'g')
     if event.key in grid_keys:
-        event.inaxes.grid()
+        # If either major grid is on, turn all major and minor grids off.
+        if any(tick.gridOn
+               for tick in ax.xaxis.majorTicks + ax.yaxis.majorTicks):
+            ax.grid(False, which="both")
+        # Otherwise, turn the major grids on.
+        else:
+            ax.grid(True)
+        canvas.draw()
+    if event.key in grid_minor_keys:
+        # If either minor grid is on, turn all minor grids off.
+        if any(tick.gridOn
+               for tick in ax.xaxis.minorTicks + ax.yaxis.minorTicks):
+            ax.grid(False, which="minor")
+        # Otherwise, turn all major and minor grids on.
+        else:
+            ax.grid(True, which="both")
         canvas.draw()
     # toggle scaling of y-axes between 'log and 'linear' (default key 'l')
     elif event.key in toggle_yscale_keys:
-        ax = event.inaxes
         scale = ax.get_yscale()
         if scale == 'log':
             ax.set_yscale('linear')
@@ -2541,7 +2557,6 @@ def key_press_handler(event, canvas, toolbar=None):
             ax.figure.canvas.draw()
     # toggle scaling of x-axes between 'log and 'linear' (default key 'k')
     elif event.key in toggle_xscale_keys:
-        ax = event.inaxes
         scalex = ax.get_xscale()
         if scalex == 'log':
             ax.set_xscale('linear')
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1313,6 +1313,7 @@ def validate_animation_writer_path(p):
     'keymap.quit':         [['ctrl+w', 'cmd+w', 'q'], validate_stringlist],
     'keymap.quit_all':     [['W', 'cmd+W', 'Q'], validate_stringlist],
     'keymap.grid':         [['g'], validate_stringlist],
+    'keymap.grid_minor':   [['G'], validate_stringlist],
     'keymap.yscale':       [['l'], validate_stringlist],
     'keymap.xscale':       [['k', 'L'], validate_stringlist],
     'keymap.all_axes':     [['a'], validate_stringlist],
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -585,6 +585,7 @@ backend      : $TEMPLATE_BACKEND
 #keymap.save : s                     # saving current figure
 #keymap.quit : ctrl+w, cmd+w         # close the current figure
 #keymap.grid : g                     # switching on/off a grid in current axes
+#keymap.grid_minor : G               # switching on/off a grid in current axes
 #keymap.yscale : l                   # toggle scaling of y-axes ('log'/'linear')
 #keymap.xscale : L, k                # toggle scaling of x-axes ('log'/'linear')
 #keymap.all_axes : a                 # enable all axes
