Clip annotations if annotation_clip is not False and clip_on is not set #15096
Conversation
There was a problem hiding this comment.
This is no proper fix. Currently we have the defaults such that annotations are shown outside the axes, as desired:
With this PR they would be cut out:
I stated the two possible solutions to the problem in #14354 (comment)
|
Is there any use to annotation_clip and clip_on to ever be different? This seems like a case of annotation having its own API for something the parent Artist class already had. |
|
I answered that in #14354 (comment) (to keep discussion in one place). |
|
@ImportanceOfBeingErnest Could you please provide the code you used for the image comparison? I think I am just not aware of the way you use annotations. In the way I would create this figure the PR does not have that influence. |
|
And btw. thank you very much for investing the time to explain, this is really helpful for me! |
|
Ooh, looking at your last comment on #14354 and looking at how the failing examples are built, I think I finally got the issue. Thank you very much for spending that time. As a default, annotations can currently leave the plot range and still be painted as long as their origin is on the visible part of the plot. I always thought that since in my example, obviously the annotations are not visible, they would be painted on the plot which is in its entirety invisible at that point. But instead, they are just not plotted, because their origin is not in the visible area. Now I also understand why you mean it would be hacky to solve this. Thank you very much again! |
PR Summary
If an annotation is created using e.g.
plt.annotate(xy=(3, 3), s='test'), then this annotation is clipped on the scene as a default, but still virtually occupies space that leads to a larger bounding box. This goes also forannotation_clip=True. Currently, the parameterclip_ondefaults toNone, which leads to this exact situation. With this PR, it defaults toTrue, ifannotation_clipis notFalse. This fixes the original issue while preserving both the ability to changeclip_onif wished and leaving the API unchanged, so the result ofannotation_clip=Falseis unchanged.Fixes #14354.
PR Checklist
Disclamer: This PR is created as bug fix. Therefore, most of the following checklist does not apply. If a unit test for this is desired, I can create one. I am just not sure how a good test would be applied here.