Skip to content

Enh better colorbar axes #18900

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
jklymak wants to merge 3 commits into from
Closed

Enh better colorbar axes #18900

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1df5ca8
ENH: Make colorbar axes more typical
jklymak Nov 5, 2020
df33845
FIX: address review
jklymak Feb 23, 2021
fe34851
Apply suggestions from code review
jklymak Apr 23, 2021
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
Next Next commit
ENH: Make colorbar axes more typical
  • Loading branch information
@jklymak
jklymak committed Apr 6, 2021
commit 1df5ca8cba9e26b2929a4b8a85e93e5402be753e
31 changes: 31 additions & 0 deletions doc/api/next_api_changes/behavior/18900-JMK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Axes used to make colorbar now wrapped
======================================

The axes used to place a colorbar is now wrapped by a new parent class
(``ColorbarAxes``). This affects calls like::

cb = fig.colorbar(im, cax=cax)
cax.tick_params()

so that this will no longer affect the visible axes ticks. Rather call
methods on the axes stored on the colorbar object::

cb = fig.colorbar(im, cax=cax)
cb.ax.tick_params()

If necessary, the original axes can be accessed via::

assert cb.ax.parent_axes == cax
Comment thread
jklymak marked this conversation as resolved.
Outdated

This change means that the parent axes (``cb.ax.parent_axes``) handles the
placement of the colorbar axes object, and its aspect ratio, but the child
axes (``cb.ax``) handles all the tick parameters, labelling, and holds the
artists that make up the colorbar.

Colorbar lines no longer clipped
================================

If a colorbar has lines added to it (e.g. for contour lines), these will
no longer be clipped. This is an improvement for lines on the edge of
the colorbar, but could lead to lines off the colorbar if the limits of
the colorbar are changed.
Loading