Merge pull request #5310 from robertoffmoura/rm/fix-tick-marker-mirroring

Fix tick marker mirroring (matplotlib conversion)

Author: camdecoster

CHANGELOG.md

@@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## Unreleased
 
 ### Fixed
+- Fix `mpl_to_plotly` tick marker mirroring, axis positioning, and trace visibility for twinned and overlaid subplots (such as `twinx` and `twiny`) [[#5310](https://github.com/plotly/plotly.py/pull/5310)], with thanks to @robertoffmoura for the contribution!
 - Fix concurrent first access to lazily initialized graph object properties, which could raise `ValueError("Invalid value")` [[#5691](https://github.com/plotly/plotly.py/pull/5691)], with thanks to @hb1915 for the contribution!
 - Fix `mpl_to_plotly` crashing on touching bars (such as `plt.hist`) due to floating-point noise producing negative `bargap` values by clamping `bargap` to `[0, 1]` [[#5696](https://github.com/plotly/plotly.py/pull/5696)], with thanks to @robertoffmoura for the contribution!
 - Export tick label colors to the plotly tickfont in `mpl_to_plotly` [[#5716](https://github.com/plotly/plotly.py/pull/5716)], with thanks to @robertoffmoura for the contribution!

plotly/matplotlylib/mplexporter/utils.py

@@ -200,18 +200,36 @@ def get_text_style(text):
 def get_axis_properties(axis):
     """Return the property dictionary for a matplotlib.Axis instance"""
     props = {}
-    label1On = axis.get_tick_params().get("label1On", True)
+    tick_params = axis.get_tick_params()
 
     if isinstance(axis, matplotlib.axis.XAxis):
-        if label1On:
-            props["position"] = "bottom"
-        else:
+        if (
+            axis.get_ticks_position() == "top"
+            or axis.get_label_position() == "top"
+            or (
+                tick_params.get("labeltop", False)
+                and not tick_params.get("labelbottom", False)
+            )
+            or (tick_params.get("top", False) and not tick_params.get("bottom", False))
+            or not tick_params.get("label1On", True)
+        ):
             props["position"] = "top"
-    elif isinstance(axis, matplotlib.axis.YAxis):
-        if label1On:
-            props["position"] = "left"
         else:
+            props["position"] = "bottom"
+    elif isinstance(axis, matplotlib.axis.YAxis):
+        if (
+            axis.get_ticks_position() == "right"
+            or axis.get_label_position() == "right"
+            or (
+                tick_params.get("labelright", False)
+                and not tick_params.get("labelleft", False)
+            )
+            or (tick_params.get("right", False) and not tick_params.get("left", False))
+            or not tick_params.get("label1On", True)
+        ):
             props["position"] = "right"
+        else:
+            props["position"] = "left"
     else:
         raise ValueError("{0} should be an Axis instance".format(axis))
 

plotly/matplotlylib/mpltools.py

@@ -250,15 +250,12 @@ def get_axes_bounds(fig):
     return (x_min, x_max), (y_min, y_max)
 
 
-def get_axis_mirror(main_spine, mirror_spine):
-    if main_spine and mirror_spine:
+def get_axis_mirror(main_spine, mirror_spine, main_tick_markers, mirror_tick_markers):
+    if main_spine and mirror_spine and main_tick_markers and mirror_tick_markers:
         return "ticks"
-    elif main_spine and not mirror_spine:
-        return False
-    elif not main_spine and mirror_spine:
-        return False  # can't handle this case yet!
-    else:
-        return False  # nuttin'!
+    if main_spine and mirror_spine:
+        return True
+    return False
 
 
 def get_bar_gap(bar_starts, bar_ends, tol=1e-10):

plotly/matplotlylib/renderer.py

@@ -57,6 +57,7 @@ def __init__(self):
         self.msg = "Initialized PlotlyRenderer\n"
         self._processing_legend = False
         self._legend_visible = False
+        self.axes_list = []
 
     def _convert_x_dates(self, x):
         """Convert x values to date strings when the x-axis is a date axis."""
@@ -157,8 +158,8 @@ def open_axes(self, ax, props):
         ]
         self.current_bars = []
         self.axis_ct += 1
-        # update plot background with the axes background from mpl
-        self.plotly_fig["layout"].plot_bgcolor = _export_color(props["axesbg"])
+        if props.get("patch_visible", True):
+            self.plotly_fig["layout"].plot_bgcolor = _export_color(props["axesbg"])
         # set defaults in axes
         xaxis = go.layout.XAxis(
             anchor="y{0}".format(self.axis_ct), zeroline=False, ticks="inside"
@@ -176,10 +177,63 @@ def open_axes(self, ax, props):
         top_spine = mpltools.get_spine_visible(ax, "top")
         left_spine = mpltools.get_spine_visible(ax, "left")
         right_spine = mpltools.get_spine_visible(ax, "right")
-        xaxis["mirror"] = mpltools.get_axis_mirror(bottom_spine, top_spine)
-        yaxis["mirror"] = mpltools.get_axis_mirror(left_spine, right_spine)
-        xaxis["showline"] = bottom_spine
-        yaxis["showline"] = top_spine
+        x_tick_params = ax.xaxis.get_tick_params()
+        y_tick_params = ax.yaxis.get_tick_params()
+        bottom_tick_markers = x_tick_params.get(
+            "bottom", x_tick_params.get("left", True)
+        )
+        top_tick_markers = x_tick_params.get("top", x_tick_params.get("right", False))
+        left_tick_markers = y_tick_params.get("left", True)
+        right_tick_markers = y_tick_params.get("right", False)
+        if xaxis["side"] == "top":
+            x_main_spine, x_mirror_spine = top_spine, bottom_spine
+            x_main_ticks, x_mirror_ticks = top_tick_markers, bottom_tick_markers
+        else:
+            x_main_spine, x_mirror_spine = bottom_spine, top_spine
+            x_main_ticks, x_mirror_ticks = bottom_tick_markers, top_tick_markers
+
+        xaxis["mirror"] = mpltools.get_axis_mirror(
+            x_main_spine, x_mirror_spine, x_main_ticks, x_mirror_ticks
+        )
+        xaxis["showline"] = x_main_spine
+        # hide tick markers when the mpl main-side tick markers are hidden
+        if not x_main_ticks:
+            xaxis["ticks"] = ""
+
+        if yaxis["side"] == "right":
+            y_main_spine, y_mirror_spine = right_spine, left_spine
+            y_main_ticks, y_mirror_ticks = right_tick_markers, left_tick_markers
+        else:
+            y_main_spine, y_mirror_spine = left_spine, right_spine
+            y_main_ticks, y_mirror_ticks = left_tick_markers, right_tick_markers
+
+        yaxis["mirror"] = mpltools.get_axis_mirror(
+            y_main_spine, y_mirror_spine, y_main_ticks, y_mirror_ticks
+        )
+        yaxis["showline"] = y_main_spine
+        if not y_main_ticks:
+            yaxis["ticks"] = ""
+
+        overlay_ax_ct = None
+        for prev_ax, prev_ct in self.axes_list:
+            # Overlay only axes that cover the same area. Shared-axis subplots, such
+            # as the ones from plt.subplots(sharex=True), sit in different places.
+            if ax.get_position().bounds == prev_ax.get_position().bounds:
+                overlay_ax_ct = prev_ct
+                break
+
+        if overlay_ax_ct is not None:
+            overlay_x = "x" if overlay_ax_ct == 1 else "x{0}".format(overlay_ax_ct)
+            overlay_y = "y" if overlay_ax_ct == 1 else "y{0}".format(overlay_ax_ct)
+            xaxis["overlaying"] = overlay_x
+            yaxis["overlaying"] = overlay_y
+
+        if not props["axes"][0]["visible"]:
+            xaxis["visible"] = False
+        if not props["axes"][1]["visible"]:
+            yaxis["visible"] = False
+
+        self.axes_list.append((ax, self.axis_ct))
 
         # put axes in our figure
         self.plotly_fig["layout"]["xaxis{0}".format(self.axis_ct)] = xaxis

plotly/matplotlylib/tests/test_renderer.py

@@ -89,6 +89,205 @@ def test_multiple_traces_native_legend():
     assert plotly_fig.data[2].mode == "lines+markers"
 
 
+def test_axis_mirror_with_spines_and_ticks():
+    """Test that mirror=True when both spines and ticks are visible on both sides."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    # Show all spines
+    ax.spines["top"].set_visible(True)
+    ax.spines["bottom"].set_visible(True)
+    ax.spines["left"].set_visible(True)
+    ax.spines["right"].set_visible(True)
+
+    # Show ticks on all sides
+    ax.tick_params(top=True, bottom=True, left=True, right=True)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.mirror == "ticks"
+    assert plotly_fig.layout.yaxis.mirror == "ticks"
+
+
+def test_axis_mirror_with_ticks_only():
+    """Test that mirror=False when spines are not visible on both sides."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    # Hide opposite spines
+    ax.spines["top"].set_visible(False)
+    ax.spines["right"].set_visible(False)
+
+    # Show ticks on all sides
+    ax.tick_params(top=True, bottom=True, left=True, right=True)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.mirror == False
+    assert plotly_fig.layout.yaxis.mirror == False
+
+
+def test_axis_mirror_false_with_one_sided_ticks():
+    """Test that mirror=True when ticks are only on one side but spines are
+    visible on both sides."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    # Default matplotlib behavior - ticks only on bottom and left
+    ax.tick_params(top=False, bottom=True, left=True, right=False)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.mirror == True
+    assert plotly_fig.layout.yaxis.mirror == True
+
+
+def test_axis_mirror_mixed_configurations():
+    """Test different configurations for x and y axes."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    # X-axis: spines and ticks on both sides (mirror="ticks")
+    ax.spines["top"].set_visible(True)
+    ax.spines["bottom"].set_visible(True)
+    ax.tick_params(top=True, bottom=True)
+
+    # Y-axis: spine only on one side (mirror=False)
+    ax.spines["right"].set_visible(False)
+    ax.spines["left"].set_visible(True)
+    ax.tick_params(left=True, right=True)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.mirror == "ticks"
+    assert plotly_fig.layout.yaxis.mirror == False
+
+
+def test_axis_showline_tied_to_main_spine():
+    """Test that showline follows the main-side spine (bottom for x, left for y)."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    # Hide the mirror-side spines only
+    ax.spines["top"].set_visible(False)
+    ax.spines["right"].set_visible(False)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.showline == True
+    assert plotly_fig.layout.yaxis.showline == True
+
+
+def test_axis_showline_hidden_when_main_spine_hidden():
+    """Test that showline is False when the main-side spine is hidden."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    # Hide the main-side spines but keep the mirror-side ones
+    ax.spines["bottom"].set_visible(False)
+    ax.spines["left"].set_visible(False)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.showline == False
+    assert plotly_fig.layout.yaxis.showline == False
+
+
+def test_ticks_hidden_when_mpl_main_ticks_hidden():
+    """Test that tick markers are hidden when the mpl main-side ticks are hidden."""
+    fig, ax = plt.subplots()
+    ax.plot([0, 1], [0, 1])
+
+    ax.tick_params(top=False, bottom=False, left=False, right=False)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.ticks == ""
+    assert plotly_fig.layout.yaxis.ticks == ""
+
+
+def test_twinx_axis_position_and_ticks():
+    """Test that twinx secondary y-axis is on the right with visible ticks and title."""
+    fig, ax1 = plt.subplots()
+    ax1.plot([0, 1, 2], [0, 1, 4])
+    ax1.set_ylabel("left axis")
+    ax2 = ax1.twinx()
+    ax2.plot([0, 1, 2], [10, 5, 2])
+    ax2.set_ylabel("right axis")
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.yaxis.side == "left"
+    assert plotly_fig.layout.yaxis.title.text == "left axis"
+    assert plotly_fig.layout.yaxis.ticks == "inside"
+
+    assert plotly_fig.layout.yaxis2.side == "right"
+    assert plotly_fig.layout.yaxis2.title.text == "right axis"
+    assert plotly_fig.layout.yaxis2.ticks == "inside"
+    assert plotly_fig.layout.yaxis2.overlaying == "y"
+    assert plotly_fig.layout.xaxis2.overlaying == "x"
+    assert plotly_fig.layout.xaxis2.visible is False
+    assert len(plotly_fig.data) == 2
+
+
+def test_twiny_axis_position_and_ticks():
+    """Test that twiny secondary x-axis is on the top with visible ticks and title."""
+    fig, ax1 = plt.subplots()
+    ax1.plot([0, 1, 2], [0, 1, 4])
+    ax1.set_xlabel("bottom axis")
+    ax2 = ax1.twiny()
+    ax2.plot([10, 5, 2], [0, 1, 4])
+    ax2.set_xlabel("top axis")
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.xaxis.side == "bottom"
+    assert plotly_fig.layout.xaxis.title.text == "bottom axis"
+    assert plotly_fig.layout.xaxis.ticks == "inside"
+
+    assert plotly_fig.layout.xaxis2.side == "top"
+    assert plotly_fig.layout.xaxis2.title.text == "top axis"
+    assert plotly_fig.layout.xaxis2.ticks == "inside"
+    assert plotly_fig.layout.xaxis2.overlaying == "x"
+    assert plotly_fig.layout.yaxis2.overlaying == "y"
+    assert plotly_fig.layout.yaxis2.visible is False
+    assert len(plotly_fig.data) == 2
+
+
+def test_right_axis_ticks_hidden_when_mpl_right_ticks_hidden():
+    """Test that ticks are hidden on a right-side axis when right ticks are hidden in matplotlib."""
+    fig, ax1 = plt.subplots()
+    ax2 = ax1.twinx()
+    ax2.tick_params(right=False)
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert plotly_fig.layout.yaxis2.side == "right"
+    assert plotly_fig.layout.yaxis2.ticks == ""
+
+
+def test_sharex_stacked_lines_in_correct_subplots():
+    """Test that vertically stacked subplots with sharex=True place lines in separate subplots."""
+    fig, (ax1, ax2) = plt.subplots(2, 1, sharex=True)
+    ax1.plot([1, 2, 3], [4, 5, 6])
+    ax2.plot([1, 2, 3], [10, 20, 30])
+
+    plotly_fig = tls.mpl_to_plotly(fig)
+
+    assert len(plotly_fig.data) == 2
+    # First line belongs to the top subplot
+    assert plotly_fig.data[0].yaxis in (None, "y", "y1")
+    # Second line belongs to the bottom subplot
+    assert plotly_fig.data[1].yaxis == "y2"
+
+    # Distinct non-overlapping vertical domains (top above bottom)
+    assert plotly_fig.layout.yaxis.domain[0] > plotly_fig.layout.yaxis2.domain[1]
+
+    # The bottom subplot must not overlay the top subplot
+    assert plotly_fig.layout.yaxis2.overlaying is None
+    assert plotly_fig.layout.xaxis2.overlaying is None
+
+
 def test_violinplot_bodies_are_filled_polygons():
     fig, ax = plt.subplots()
     ax.violinplot(np.random.randn(100, 3))