DOC: add a couple more placement examples, crosslink axes_grid [ci doc] #26914
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1115c7f to
3ca96ad
Compare
rcomer
reviewed
Sep 26, 2023
galleries/examples/axes_grid1/demo_colorbar_with_axes_divider.py
Outdated
Show resolved
Hide resolved
|
|
||
| # %% | ||
| # Manually placing colorbars | ||
| # ========================== |
There was a problem hiding this comment.
I wonder if this and the previous section should be two subsections under this title, since in both we are encouraging the user to do it manually.
There was a problem hiding this comment.
OK, I rearranged somewhat. Need to see how it looks before I decide where to link
|
|
||
| Inset axes placement is controlled as for legends: either by providing a *loc* | ||
| option ("upper right", "best", ...), or by providing a locator with respect to | ||
| the parent bbox. Parameters such as *bbox_to_anchor* and *borderpad* likewise | ||
| work in the same way, and are also demonstrated here. | ||
|
|
||
| Users should consider using `.Axes.inset_axes` instead (see | ||
| :ref:`colorbar_placement`). |
There was a problem hiding this comment.
If the last two sections of the colorbar guide become one "Manually Placing Colorbars" section (see other comment), then this could link directly to that.
08926c5 to
c234384
Compare
c234384 to
4f75570
Compare
rcomer
reviewed
Sep 26, 2023
| fig.colorbar(pcm, ax=axs[1], shrink=0.6) | ||
|
|
||
| # %% | ||
| # This is usual undesired, and can be worked around in various ways, e.g. |
There was a problem hiding this comment.
Suggested change
| # This is usual undesired, and can be worked around in various ways, e.g. | |
| # This is usually undesired, and can be worked around in various ways, e.g. |
Comment on lines
13
to
14
| Automatic placement | ||
| =================== |
There was a problem hiding this comment.
Suggested change
| Automatic placement | |
| =================== | |
| Automatic placement of colorbars | |
| ================================ |
For consistency with the "Manual" section below. Or make the other title short to match this, but I think the longer titles would be better if other parts of the docs link to specific sections?
| # :ref:`axes_grid` has methods for creating colorbar axes as well: | ||
| # | ||
| # - :ref:`demo-colorbar-with-inset-locator` | ||
| # - :ref:`demo-colorbar-with-axes-divider` |
There was a problem hiding this comment.
Think the "see also" should be at the bottom of the page?
Comment on lines
171
to
173
| # We solve this problem using `.Axes.inset_axes` to locate the axes in axes | ||
| # coordinates. Note that if you zoom in on the axes, and thus | ||
| # change the shape of the axes, the colorbar will also change position. |
There was a problem hiding this comment.
Suggested change
| # We solve this problem using `.Axes.inset_axes` to locate the axes in axes | |
| # coordinates. Note that if you zoom in on the axes, and thus | |
| # change the shape of the axes, the colorbar will also change position. | |
| # We solve this problem using `.Axes.inset_axes` to locate the colorbar relative to the | |
| # parent axes. Note that if you zoom in on the parent axes, and thus | |
| # change the shape of it, the colorbar will also change position. |
I appreciate this paragraph isn't new, but I feel like there are too many "axes" in there and it could be more specific about which axes each one refers to...!
There was a problem hiding this comment.
Went with the similar with a link out to the jargon:
# We solve this problem using `.Axes.inset_axes` to locate the axes in "axes
# coordinates" (see :ref:`transforms_tutorial`). Note that if you zoom in on
# the parent axes, and thus change the shape of it, the colorbar will also
# change position.
3ca0e25 to
fdf1f25
Compare
Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>
fdf1f25 to
ab94dd7
Compare
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 27, 2023
…es, crosslink axes_grid [ci doc]
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 27, 2023
…es, crosslink axes_grid [ci doc]
rcomer
added a commit
that referenced
this pull request
Sep 27, 2023
…914-on-v3.8.0-doc Backport PR #26914 on branch v3.8.0-doc (DOC: add a couple more placement examples, crosslink axes_grid [ci doc])
rcomer
added a commit
that referenced
this pull request
Sep 27, 2023
…914-on-v3.8.x Backport PR #26914 on branch v3.8.x (DOC: add a couple more placement examples, crosslink axes_grid [ci doc])
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Noted in SciTools/cartopy#2248 (comment) - placing colorbars inside axes is sometimes a good thing to do (think a map, where you know you have no data coloured over a body of water, so the colorbar fits nicely there). This adds a couple of simple examples to show how to do that. Also crosslink from
demo-colorbar-with-inset-locatoranddemo-colorbar-with-axes-dividerand added some notes that these methods can typically be accomplished by easier means.