ENH: Allow tuple for borderpad in AnchoredOffsetbox #30359
Conversation
98cfadf to
8df4614
Compare
There was a problem hiding this comment.
Thanks @Aaratrika-Shelly, nice work! I have confirmed this solves the inset_axes issue:
import matplotlib.pyplot as plt
from mpl_toolkits.axes_grid1.inset_locator import inset_axes
fig, ax = plt.subplots()
axins = inset_axes(ax, width="30%", height=1., loc="upper left", borderpad=(3, 0))
plt.show()
Please could you update the inset_axes docstring to match what you have done here? This should also get a what's new entry and "added" directive.
8df4614 to
c84ef64
Compare
|
All the suggested changes have been made. Thanks for the suggestions. |
There was a problem hiding this comment.
Thanks @Aaratrika-Shelly, this will still need a new entry in https://github.com/matplotlib/matplotlib/tree/main/doc/users/next_whats_new
Also I just remembered that the type annotation will need updating in offsetbox.pyi. We do not yet have typing stubs for anything under toolkits so there is nothing to do for type annotations for inset_axes.
c84ef64 to
2b60116
Compare
5bd8215 to
b98dbdc
Compare
lib/matplotlib/offsetbox.py
Outdated
| the *loc* code with the *borderpad*. | ||
| The paddings are specified by *pad_x* and *pad_y*. |
There was a problem hiding this comment.
| the *loc* code with the *borderpad*. | |
| The paddings are specified by *pad_x* and *pad_y*. | |
| the *loc* code and padding *pad_x*, *pad_y*. |
lib/matplotlib/legend.py
Outdated
| return offsetbox._get_anchored_bbox( | ||
| loc, bbox, parentbbox, | ||
| self.borderaxespad * renderer.points_to_pixels(self._fontsize)) | ||
| pad,pad) |
There was a problem hiding this comment.
| pad,pad) | |
| pad, pad) |
Could also be inlined to the line before.
b98dbdc to
abbc352
Compare
|
Since you are amending the one commit, it would be good to also correct the typo: "tupple" -> "tuple" |
abbc352 to
ca8f475
Compare
There was a problem hiding this comment.
Thanks @Aaratrika-Shelly, just one missing blank line now as far as I can see.
ca8f475 to
c3ce74a
Compare
c3ce74a to
2a5d41b
Compare
|
"It looks like all the tests passed except for a single failure in test_openin_any_paranoid, which appears to be a CI environment issue related to the DISPLAY variable. |
|
Hi @Aaratrika-Shelly it looks like your last push did not change anything. Did you forget to |
2a5d41b to
a43d64c
Compare
This PR closes #30331 .
PR summary
This PR enhances
AnchoredOffsetboxto allow theborderpadparameter to accept a tuple of(x_pad, y_pad)in addition to a single float value.Why is this change necessary? Currently,
borderpadapplies the same padding in both x and y directions. This can be inflexible, especially when placing inset axes in a corner. For example, a user may want horizontal padding to avoid overlapping the main plot's y-axis labels, but no vertical padding in order to keep the inset flush with the top of the plot area.What problem does it solve? It gives users finer control over the positioning of anchored elements, allowing for separate horizontal and vertical padding.
What is the reasoning for this implementation?
AnchoredOffsetbox.get_offset.self.borderpadis a tuple and calculates separatepad_x_pixelsandpad_y_pixels.A new unit test has been added to verify this functionality, and the docstring for
AnchoredOffsetboxhas been updated to reflect the new API.PR checklist