Support overlaying and visibility for twinned and overlaid subplots

Author: robertoffmoura

plotly/matplotlylib/renderer.py

@@ -67,6 +67,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."""
@@ -167,8 +168,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"
@@ -223,6 +224,36 @@ def open_axes(self, ax, props):
         if not y_main_ticks:
             yaxis["ticks"] = ""
 
+        overlay_ax_ct = None
+        for prev_ax, prev_ct in self.axes_list:
+            is_twinned = (
+                (
+                    hasattr(ax, "_twinned_axes")
+                    and ax in ax._twinned_axes.get_siblings(prev_ax)
+                )
+                or getattr(ax, "_sharex", None) == prev_ax
+                or getattr(ax, "_sharey", None) == prev_ax
+                or getattr(prev_ax, "_sharex", None) == ax
+                or getattr(prev_ax, "_sharey", None) == ax
+                or (ax.get_position().bounds == prev_ax.get_position().bounds)
+            )
+            if is_twinned:
+                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
         self.plotly_fig["layout"]["yaxis{0}".format(self.axis_ct)] = yaxis

plotly/matplotlylib/tests/test_renderer.py

@@ -224,6 +224,10 @@ def test_twinx_axis_position_and_ticks():
     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():
@@ -244,6 +248,10 @@ def test_twiny_axis_position_and_ticks():
     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():