Skip to content

FIX: zero width lines need no pattern #29302

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

Closed
wants to merge 1 commit into from
+11 −1
Closed

FIX: zero width lines need no pattern #29302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion lib/matplotlib/lines.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def _scale_dashes(offset, dashes, lw):
return offset, dashes
scaled_offset = offset * lw
scaled_dashes = ([x * lw if x is not None else None for x in dashes]
if dashes is not None else None)
if dashes is not None and lw > 0 else None)
return scaled_offset, scaled_dashes


Expand Down
10 changes: 10 additions & 0 deletions lib/matplotlib/tests/test_collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,6 +680,16 @@ def test_set_wrong_linestyle():
c.set_linestyle('fuzzy')


@mpl.style.context('default')
def test_zero_linewidth_scaling():
c = Collection()
c.set_linestyle('dashed')
c.set_linewidth(0)

# With a zero linewidth, there can be no pattern
assert c.get_linestyle() == [(0, None)]
Copy link
Member

@timhoffm timhoffm Dec 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Note that "solid" results in [('', None)] instead which I believe is incorrect wrt. to the declared type.

We are overall not consistent and clear what get_linestyle() means:

  • for Line2D.get_linestyle() it is always a str, and if given a dash pattern, the result is "--".
  • for Patch.get_linestyle(), we basically get what we put in str or (unscaled) dash pattern; with the exception of normalizing "no style" ' ', '', 'none' to "None"
  • for Collections, we always get a scaled dash pattern.

While this fix may be ok as a workaround to fix the original issue (and doesn't make the consisteny worse), we should generally agee upon what get_linestyle() means - and a scaled dash pattern would be the last of my choices.

Copy link
Member Author

@rcomer rcomer Dec 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Actually looking closer, I don't think the legend handler should be getting the scaled pattern - it gets scaled again on the patch, so is wrong for any linewidth != 1.

I'll close this.



@mpl.style.context('default')
def test_capstyle():
col = mcollections.PathCollection([])
Expand Down
Loading