Repository navigation
boxplot/violinplot orientation-setting API #13435
Description
Bug report
Bug summary
Currently, boxplot(), bxp(), violin(), and violinplot() take a vert: bool argument to switch between vertical and horizontal; this is inconsistent with colorbar(), hist(), eventplot(), and Slider(), which take an orientation: {"vertical", "horizontal"} argument.
For consistency, I'd suggest adding support for orientation (both because I think colorbar() and hist(), in particular, are probably the most used among all these, and because I like the API better :-)), and later deprecate vert. Thoughts?
attn @phobson who has been involved in boxplots, IIRC.
Reacted by Tim Hoffmann
Activity
phobson commentedon Feb 14, 2019
I think this is a good idea.
Should be easy enough to capture
vert, emit and deprecation warning, and then setorientationaccordingly.anntzer commentedon Feb 14, 2019
(and while we're at it, the manage_xticks arg should be renamed to manage_ticks, as it covers both orientations)
phobson commentedon Feb 14, 2019
just throwing this out there: what would you say to
manage_labels?anntzer commentedon Feb 14, 2019
well technically it's managing ticks, tick labels, and axis limits so I think manage_labels is worse than manage_ticks, and perhaps manage_axis is better?
I also wonder whether it really needs to manage axis limits -- can't the standard margins system do that just as well? (needs to be investigated)
phobson commentedon Feb 14, 2019
good points all around.
just noticed a wrinkle:
boxplot.vertis an rcParamanntzer commentedon Feb 14, 2019
We know how to handle deprecation/renaming of rcParams too, but thanks for pointing that out.
github-actions commentedon May 31, 2023
This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!
anntzer commentedon May 31, 2023
At least adding orientation should hopefully be uncontroversial.
saranti commentedon Mar 30, 2024
Would you want separate PRs for
boxplotandviolinplotto keep it simple? The review process for theboxplotsection will probably take a bit longer because it involves the deprecation of an rcParam which Ive never done before.timhoffm commentedon Mar 30, 2024
Should we simply deprecate the
boxplot.vertrcParams without replacement? This is more of a plot-type setting rather than style. It’s not useful as a global config or style parameter. The only use case would be a local context (e.g. via a context manager) if somebody wants to make multiple horizontal plots. But for that rare case using the parameter explicitly may be good enough and is more clear for the reader.I believe, we also don’t have that config for
bar()orhist().phobson commentedon Apr 3, 2024
I think that's a good idea and the justification is solid, IMO