Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Documented the incompatibility of shrink and cax kwargs in colorbar. #9456

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

Merged
merged 3 commits into from
Oct 18, 2017
Merged

Documented the incompatibility of shrink and cax kwargs in colorbar. #9456

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab4b878
Documented the incompatibility of shrink and cax kwargs in colorbar.
Oct 17, 2017
1dc1d8d
Documented the incompatibility of shrink and cax kwargs in colorbar.
Oct 17, 2017
1269f62
Added incompatibility of kwargs *shrink* and *aspect* with *cax* to t…
Oct 18, 2017
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
Prev Previous commit
Added incompatibility of kwargs *shrink* and *aspect* with *cax* to t… 
…he documentation.
  • Loading branch information
navdeep rana committed Oct 18, 2017
commit 1269f623bca3951ee96d7e98e56c5763c99a6093
11 changes: 3 additions & 8 deletions 11 lib/matplotlib/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,14 +175,9 @@
If *mappable* is a :class:`~matplotlib.contours.ContourSet`, its *extend*
kwarg is included automatically.

Note that the *shrink* kwarg provides a simple way to keep a vertical
colorbar, for example, from being taller than the axes of the mappable
to which the colorbar is attached; but it is a manual method requiring
some trial and error. If the colorbar is too tall (or a horizontal
colorbar is too wide) use a smaller value of *shrink*.
Further, *shrink* and *cax* kwargs are incompatible with each other and
*shrink* applies only if the colorbar makes its own Axes by sharing space
with the Axes in which it resides.
The *shrink* kwarg provides a simple way to scale the colorbar with respect
to the axes. Note that if *cax* is specified it determines the size of the
colorbar and *shrink* and *aspect* kwargs are ignored.

For more precise control, you can manually specify the positions of
the axes objects in which the mappable and the colorbar are drawn. In
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.