Skip to content

Fix add hline not working for make_subplot if not populated #5254

New issue

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

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

Already on GitHub? # to your account

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

Conversation

Erikp15
Copy link

@Erikp15 Erikp15 commented Jun 27, 2025

This is a proposal fix for issue #5136
I first reproduced the issue and created two unit tests, test_add_hline_empty_subplots.py and test_hline_subplots_bug.py, that check if the bug is resolved. Then I implemented the fix (outlined below), which passed both of the new unit tests, and in the process, no old tests were broken.

Root cause

add_shape() is called with exclude_empty_subplots=True. For a fresh make_subplots figure, every subplot is flagged empty, so the h/v line shape is filtered out and never appears, even after traces are later added.

Fix overview

When add_hline/add_vline are invoked and the figure contains no traces (len(self.data)==0), the code now disables the exclude empty subplots logic before delegating to add_shape, allowing the shape to be created and later displayed once data is added.

Code PR

  • I have read through the contributing notes and understand the structure of the package. In particular, if my PR modifies code of plotly.graph_objects, my modifications concern the code generator and not the generated files.
  • I have added tests or modified existing tests.
  • For a new feature, I have added documentation examples (please see the doc checklist as well).
  • I have added a CHANGELOG entry if changing anything substantial.
  • For a new feature or a change in behavior, I have updated the relevant docstrings in the code.

@gvwilson gvwilson self-assigned this Jul 3, 2025
@gvwilson gvwilson added P1 needed for current cycle community community contribution fix fixes something broken labels Jul 3, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
community community contribution fix fixes something broken P1 needed for current cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants