Skip to content

Allow shared_yaxes to work with secondary axes #5180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Allow shared_yaxes to work with secondary axes #5180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fd64e00
Fix sharing of secondary y-axis
May 12, 2025
8f0ac47
Add test
May 12, 2025
948bc38
black
May 12, 2025
dcc607c
black
May 12, 2025
7fd2702
Merge branch 'main' into secondary-y-shared
gvwilson Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions plotly/_subplots.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -746,8 +746,12 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
)
grid_ref[r][c] = subplot_refs

_configure_shared_axes(layout, grid_ref, specs, "x", shared_xaxes, row_dir)
_configure_shared_axes(layout, grid_ref, specs, "y", shared_yaxes, row_dir)
_configure_shared_axes(layout, grid_ref, specs, "x", shared_xaxes, row_dir, False)
_configure_shared_axes(layout, grid_ref, specs, "y", shared_yaxes, row_dir, False)
if secondary_y:
_configure_shared_axes(
layout, grid_ref, specs, "y", shared_yaxes, row_dir, True
)
Comment on lines +751 to +754
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gmjw I think there's a logic issue here -- secondary_y is set in the loop above, which loops through all the specs for each subplot. So after the above loop terminates, secondary_y corresponds only to the value provided for secondary_y in the spec of the final subplot.

You can see how this causes issues if you set 'secondary_y': False for the final subplot only; it breaks shared y-axes for every subplot in the grid.

The fix might be as simple as something like this:

Suggested change
if secondary_y:
_configure_shared_axes(
layout, grid_ref, specs, "y", shared_yaxes, row_dir, True
)
any_secondary_y = any([spec.get("secondary_y", False) for spec_row in specs for spec in spec_row])
if any_secondary_y:
_configure_shared_axes(
layout, grid_ref, specs, "y", shared_yaxes, row_dir, True
)

although I haven't fully thought through all the edge cases.


# Build inset reference
# ---------------------
Expand Down Expand Up @@ -879,7 +883,9 @@ def _check_hv_spacing(dimsize, spacing, name, dimvarname, dimname):
return figure


def _configure_shared_axes(layout, grid_ref, specs, x_or_y, shared, row_dir):
def _configure_shared_axes(
layout, grid_ref, specs, x_or_y, shared, row_dir, secondary_y
):
rows = len(grid_ref)
cols = len(grid_ref[0])

Expand All @@ -890,6 +896,13 @@ def _configure_shared_axes(layout, grid_ref, specs, x_or_y, shared, row_dir):
else:
rows_iter = range(rows)

if secondary_y:
cols_iter = range(cols - 1, -1, -1)
axis_index = 1
else:
cols_iter = range(cols)
axis_index = 0

def update_axis_matches(first_axis_id, subplot_ref, spec, remove_label):
if subplot_ref is None:
return first_axis_id
Expand All @@ -913,13 +926,15 @@ def update_axis_matches(first_axis_id, subplot_ref, spec, remove_label):
return first_axis_id

if shared == "columns" or (x_or_y == "x" and shared is True):
for c in range(cols):
for c in cols_iter:
first_axis_id = None
ok_to_remove_label = x_or_y == "x"
for r in rows_iter:
if not grid_ref[r][c]:
continue
subplot_ref = grid_ref[r][c][0]
if axis_index >= len(grid_ref[r][c]):
continue
subplot_ref = grid_ref[r][c][axis_index]
spec = specs[r][c]
first_axis_id = update_axis_matches(
first_axis_id, subplot_ref, spec, ok_to_remove_label
Expand All @@ -929,26 +944,30 @@ def update_axis_matches(first_axis_id, subplot_ref, spec, remove_label):
for r in rows_iter:
first_axis_id = None
ok_to_remove_label = x_or_y == "y"
for c in range(cols):
for c in cols_iter:
if not grid_ref[r][c]:
continue
subplot_ref = grid_ref[r][c][0]
if axis_index >= len(grid_ref[r][c]):
continue
subplot_ref = grid_ref[r][c][axis_index]
spec = specs[r][c]
first_axis_id = update_axis_matches(
first_axis_id, subplot_ref, spec, ok_to_remove_label
)

elif shared == "all":
first_axis_id = None
for c in range(cols):
for ri, r in enumerate(rows_iter):
for ri, r in enumerate(rows_iter):
for c in cols_iter:
if not grid_ref[r][c]:
continue
subplot_ref = grid_ref[r][c][0]
if axis_index >= len(grid_ref[r][c]):
continue
subplot_ref = grid_ref[r][c][axis_index]
spec = specs[r][c]

if x_or_y == "y":
ok_to_remove_label = c > 0
ok_to_remove_label = c < cols - 1 if secondary_y else c > 0
else:
ok_to_remove_label = ri > 0 if row_dir > 0 else r < rows - 1

Expand Down
212 changes: 112 additions & 100 deletions tests/test_core/test_subplots/test_make_subplots.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1828,115 +1828,127 @@ def test_secondary_y_traces(self):
self.assertEqual(fig.to_plotly_json(), expected.to_plotly_json())

def test_secondary_y_subplots(self):
fig = subplots.make_subplots(
rows=2,
cols=2,
specs=[
[{"secondary_y": True}, {"secondary_y": True}],
[{"secondary_y": True}, {"secondary_y": True}],
],
)
for shared_y_axes in [False, True]:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally I would have passed in these options using mark.parametrize, but I don't think that is possible with unittest TestCase methods.

fig = subplots.make_subplots(
rows=2,
cols=2,
shared_yaxes=shared_y_axes,
specs=[
[{"secondary_y": True}, {"secondary_y": True}],
[{"secondary_y": True}, {"secondary_y": True}],
],
)

fig.add_scatter(y=[1, 3, 2], name="First", row=1, col=1)
fig.add_scatter(y=[2, 1, 3], name="Second", row=1, col=1, secondary_y=True)
fig.add_scatter(y=[1, 3, 2], name="First", row=1, col=1)
fig.add_scatter(y=[2, 1, 3], name="Second", row=1, col=1, secondary_y=True)

fig.add_scatter(y=[4, 3, 2], name="Third", row=1, col=2)
fig.add_scatter(y=[8, 1, 3], name="Forth", row=1, col=2, secondary_y=True)
fig.add_scatter(y=[4, 3, 2], name="Third", row=1, col=2)
fig.add_scatter(y=[8, 1, 3], name="Forth", row=1, col=2, secondary_y=True)

fig.add_scatter(y=[0, 2, 4], name="Fifth", row=2, col=1)
fig.add_scatter(y=[2, 1, 3], name="Sixth", row=2, col=1, secondary_y=True)
fig.add_scatter(y=[0, 2, 4], name="Fifth", row=2, col=1)
fig.add_scatter(y=[2, 1, 3], name="Sixth", row=2, col=1, secondary_y=True)

fig.add_scatter(y=[2, 4, 0], name="Fifth", row=2, col=2)
fig.add_scatter(y=[2, 3, 6], name="Sixth", row=2, col=2, secondary_y=True)
fig.add_scatter(y=[2, 4, 0], name="Fifth", row=2, col=2)
fig.add_scatter(y=[2, 3, 6], name="Sixth", row=2, col=2, secondary_y=True)

fig.update_traces(uid=None)
fig.update_traces(uid=None)

expected = Figure(
{
"data": [
{
"name": "First",
"type": "scatter",
"xaxis": "x",
"y": [1, 3, 2],
"yaxis": "y",
},
{
"name": "Second",
"type": "scatter",
"xaxis": "x",
"y": [2, 1, 3],
"yaxis": "y2",
},
{
"name": "Third",
"type": "scatter",
"xaxis": "x2",
"y": [4, 3, 2],
"yaxis": "y3",
},
{
"name": "Forth",
"type": "scatter",
"xaxis": "x2",
"y": [8, 1, 3],
"yaxis": "y4",
},
{
"name": "Fifth",
"type": "scatter",
"xaxis": "x3",
"y": [0, 2, 4],
"yaxis": "y5",
},
{
"name": "Sixth",
"type": "scatter",
"xaxis": "x3",
"y": [2, 1, 3],
"yaxis": "y6",
},
{
"name": "Fifth",
"type": "scatter",
"xaxis": "x4",
"y": [2, 4, 0],
"yaxis": "y7",
},
{
"name": "Sixth",
"type": "scatter",
"xaxis": "x4",
"y": [2, 3, 6],
"yaxis": "y8",
},
],
"layout": {
"xaxis": {"anchor": "y", "domain": [0.0, 0.37]},
"xaxis2": {
"anchor": "y3",
"domain": [0.5700000000000001, 0.9400000000000001],
},
"xaxis3": {"anchor": "y5", "domain": [0.0, 0.37]},
"xaxis4": {
"anchor": "y7",
"domain": [0.5700000000000001, 0.9400000000000001],
expected = Figure(
{
"data": [
{
"name": "First",
"type": "scatter",
"xaxis": "x",
"y": [1, 3, 2],
"yaxis": "y",
},
{
"name": "Second",
"type": "scatter",
"xaxis": "x",
"y": [2, 1, 3],
"yaxis": "y2",
},
{
"name": "Third",
"type": "scatter",
"xaxis": "x2",
"y": [4, 3, 2],
"yaxis": "y3",
},
{
"name": "Forth",
"type": "scatter",
"xaxis": "x2",
"y": [8, 1, 3],
"yaxis": "y4",
},
{
"name": "Fifth",
"type": "scatter",
"xaxis": "x3",
"y": [0, 2, 4],
"yaxis": "y5",
},
{
"name": "Sixth",
"type": "scatter",
"xaxis": "x3",
"y": [2, 1, 3],
"yaxis": "y6",
},
{
"name": "Fifth",
"type": "scatter",
"xaxis": "x4",
"y": [2, 4, 0],
"yaxis": "y7",
},
{
"name": "Sixth",
"type": "scatter",
"xaxis": "x4",
"y": [2, 3, 6],
"yaxis": "y8",
},
],
"layout": {
"xaxis": {"anchor": "y", "domain": [0.0, 0.37]},
"xaxis2": {
"anchor": "y3",
"domain": [0.5700000000000001, 0.9400000000000001],
},
"xaxis3": {"anchor": "y5", "domain": [0.0, 0.37]},
"xaxis4": {
"anchor": "y7",
"domain": [0.5700000000000001, 0.9400000000000001],
},
"yaxis": {"anchor": "x", "domain": [0.575, 1.0]},
"yaxis2": {"anchor": "x", "overlaying": "y", "side": "right"},
"yaxis3": {"anchor": "x2", "domain": [0.575, 1.0]},
"yaxis4": {"anchor": "x2", "overlaying": "y3", "side": "right"},
"yaxis5": {"anchor": "x3", "domain": [0.0, 0.425]},
"yaxis6": {"anchor": "x3", "overlaying": "y5", "side": "right"},
"yaxis7": {"anchor": "x4", "domain": [0.0, 0.425]},
"yaxis8": {"anchor": "x4", "overlaying": "y7", "side": "right"},
},
"yaxis": {"anchor": "x", "domain": [0.575, 1.0]},
"yaxis2": {"anchor": "x", "overlaying": "y", "side": "right"},
"yaxis3": {"anchor": "x2", "domain": [0.575, 1.0]},
"yaxis4": {"anchor": "x2", "overlaying": "y3", "side": "right"},
"yaxis5": {"anchor": "x3", "domain": [0.0, 0.425]},
"yaxis6": {"anchor": "x3", "overlaying": "y5", "side": "right"},
"yaxis7": {"anchor": "x4", "domain": [0.0, 0.425]},
"yaxis8": {"anchor": "x4", "overlaying": "y7", "side": "right"},
},
}
)
}
)

expected.update_traces(uid=None)
if shared_y_axes:
expected["layout"]["yaxis2"]["matches"] = "y4"
expected["layout"]["yaxis2"]["showticklabels"] = False
expected["layout"]["yaxis3"]["matches"] = "y"
expected["layout"]["yaxis3"]["showticklabels"] = False
expected["layout"]["yaxis6"]["matches"] = "y8"
expected["layout"]["yaxis6"]["showticklabels"] = False
expected["layout"]["yaxis7"]["matches"] = "y5"
expected["layout"]["yaxis7"]["showticklabels"] = False

self.assertEqual(fig.to_plotly_json(), expected.to_plotly_json())
expected.update_traces(uid=None)

self.assertEqual(fig.to_plotly_json(), expected.to_plotly_json())

def test_if_passed_figure(self):
# assert it returns the same figure it was passed
Expand Down