Merge pull request #16652 from anntzer/locaxispanzoom

anntzer · web-flow · commit 11431434737a · 2020-03-11T15:46:47.000+01:00
Deprecate {Locator,Axis}.{pan,zoom}.
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -311,3 +311,9 @@ Such options should now be directly passed to Pillow using
 ``dviread.Encoding``
 ~~~~~~~~~~~~~~~~~~~~
 This class was (mostly) broken and is deprecated.
+
+Axis and Locator ``pan`` and ``zoom``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The unused ``pan`` and ``zoom`` methods of `~.axis.Axis` and `~.ticker.Locator`
+are deprecated.  Panning and zooming are now implemented using the
+``start_pan``, ``drag_pan``, and ``end_pan`` methods of `~.axes.Axes`.
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1708,10 +1708,12 @@ def _update_offset_text_position(self, bboxes, bboxes2):
         """
         raise NotImplementedError('Derived must override')
 
+    @cbook.deprecated("3.3")
     def pan(self, numsteps):
         """Pan by *numsteps* (can be positive or negative)."""
         self.major.locator.pan(numsteps)
 
+    @cbook.deprecated("3.3")
     def zoom(self, direction):
         """Zoom in/out on axis; if *direction* is >0 zoom in, else zoom out."""
         self.major.locator.zoom(direction)
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -203,6 +203,7 @@ def __call__(self):
     def autoscale(self):
         return self.base.autoscale()
 
+    @cbook.deprecated("3.3")
     def pan(self, numsteps):
         return self.base.pan(numsteps)
 
@@ -214,6 +215,7 @@ def view_limits(self, vmin, vmax):
         vmin, vmax = np.rad2deg((vmin, vmax))
         return np.deg2rad(self.base.view_limits(vmin, vmax))
 
+    @cbook.deprecated("3.3")
     def zoom(self, direction):
         return self.base.zoom(direction)
 
@@ -387,9 +389,11 @@ def __call__(self):
     def autoscale(self):
         return self.base.autoscale()
 
+    @cbook.deprecated("3.3")
     def pan(self, numsteps):
         return self.base.pan(numsteps)
 
+    @cbook.deprecated("3.3")
     def zoom(self, direction):
         return self.base.zoom(direction)
 
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -1644,6 +1644,7 @@ def autoscale(self):
         """Autoscale the view limits."""
         return self.view_limits(*self.axis.get_view_interval())
 
+    @cbook.deprecated("3.3")
     def pan(self, numsteps):
         """Pan numticks (can be positive or negative)"""
         ticks = self()
@@ -1661,6 +1662,7 @@ def pan(self, numsteps):
         vmax += step
         self.axis.set_view_interval(vmin, vmax, ignore=True)
 
+    @cbook.deprecated("3.3")
     def zoom(self, direction):
         """Zoom in/out on axis; if direction is >0 zoom in, else zoom out."""
 
