ENH: add flag to disable locator 'de-confliction'

tacaswell · tacaswell · commit e3a83931ea42 · 2019-04-11T21:44:52.000-04:00
If Axis.remove_overlapping_locs is set to False the `Axis` object will not attempt to remove locations in the minor ticker that overlap with locations in the major ticker. This is a follow up to #13314 which un-conditionally removed the overlap. closes #13618
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -723,6 +723,8 @@ def __init__(self, axes, pickradius=15):
             `.Axis.contains`.
         """
         martist.Artist.__init__(self)
+        self._remove_overlapping_locs = True
+
         self.set_figure(axes.figure)
 
         self.isDefault_label = True
@@ -754,6 +756,17 @@ def __init__(self, axes, pickradius=15):
     majorTicks = _LazyTickList(major=True)
     minorTicks = _LazyTickList(major=False)
 
+    def get_remove_overlapping_locs(self):
+        return self._remove_overlapping_locs
+
+    def set_remove_overlapping_locs(self, val):
+        self._remove_overlapping_locs = bool(val)
+
+    remove_overlapping_locs = property(
+        get_remove_overlapping_locs, set_remove_overlapping_locs,
+        doc=('If minor ticker locations that overlap with major '
+             'ticker locations should be trimmed.'))
+
     def set_label_coords(self, x, y, transform=None):
         """
         Set the coordinates of the label.
@@ -1323,9 +1336,10 @@ def get_minorticklocs(self):
         # Use the transformed view limits as scale.  1e-5 is the default rtol
         # for np.isclose.
         tol = (hi - lo) * 1e-5
-        minor_locs = [
-            loc for loc, tr_loc in zip(minor_locs, tr_minor_locs)
-            if not np.isclose(tr_loc, tr_major_locs, atol=tol, rtol=0).any()]
+        if self.remove_overlapping_locs:
+            minor_locs = [
+                loc for loc, tr_loc in zip(minor_locs, tr_minor_locs)
+                if ~np.isclose(tr_loc, tr_major_locs, atol=tol, rtol=0).any()]
         return minor_locs
 
     def get_ticklocs(self, minor=False):
