8000 Check parameters of ColorbarBase by timhoffm · Pull Request #14519 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Check parameters of ColorbarBase #14519

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 1 commit into from
Aug 8, 2019
Merged

Check parameters of ColorbarBase #14519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 66 additions & 18 deletions lib/matplotlib/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,40 +350,78 @@ def get_clim(self):


class ColorbarBase(_ColorbarMappableDummy):
'''
r"""
Draw a colorbar in an existing axes.

This is a base class for the :class:`Colorbar` class, which is the
basis for the :func:`~matplotlib.pyplot.colorbar` function and the
:meth:`~matplotlib.figure.Figure.colorbar` method, which are the
usual ways of creating a colorbar.
There are only some rare cases in which you would work directly with a
`.ColorbarBase` as an end-user. Typically, colorbars are used
with `.ScalarMappable`\s such as an `.AxesImage` generated via
`~.axes.Axes.imshow`. For these cases you will use `.Colorbar` and
likely create it via `.pyplot.colorbar` or `.Figure.colorbar`.

The main application of using a `.ColorbarBase` explicitly is drawing
colorbars that are not associated with other elements in the figure, e.g.
when showing a colormap by itself.

It is also useful by itself for showing a colormap. If the *cmap*
kwarg is given but *boundaries* and *values* are left as None,
then the colormap will be displayed on a 0-1 scale. To show the
If the *cmap* kwarg is given but *boundaries* and *values* are left as
None, then the colormap will be displayed on a 0-1 scale. To show the
under- and over-value colors, specify the *norm* as::

colors.Normalize(clip=False)
norm=colors.Normalize(clip=False)

To show the colors versus index instead of on the 0-1 scale,
use::

norm=colors.NoNorm.
norm=colors.NoNorm()

Useful public methods are :meth:`set_label` and :meth:`add_lines`.

Attributes
----------
ax : Axes
The `Axes` instance in which the colorbar is drawn.

ax : `~matplotlib.axes.Axes`
The `~.axes.Axes` instance in which the colorbar is drawn.
lines : list
A list of `LineCollection` if lines were drawn, otherwise
A list of `.LineCollection` if lines were drawn, otherwise
an empty list.

dividers : LineCollection
dividers : `.LineCollection`
A LineCollection if *drawedges* is ``True``, otherwise ``None``.
'''

Parameters
----------
ax : `~matplotlib.axes.Axes`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blank lines are not consistent.

Copy link
Member Author
@timhoffm timhoffm Jul 22, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually, I would not add blank lines here, because the descriptions are short.

Only where no description is present at all, I've added a blank line (or rather an indented empty description 😉). I think that's a fair compromise. Otherwise the parameters would be visually merged to one block.

And you were right anyway, there was no blank line between norm and alpha. Fixed that.

Ideally, one would write descriptions for all, but that's not the focus of this PR.

The `~.axes.Axes` instance in which the colorbar is drawn.
cmap : `~matplotlib.colors.Colormap` or None
The colormap to use. If *None*, use :rc:`image.cmap`.
norm : `~matplotlib.colors.Normalize`

alpha : float

values

boundaries

orientation : {'vertical', 'horizontal'}

ticklocation : {'auto', 'left', 'right', 'top', 'bottom'}

extend : {'neiter', 'both', 'min', 'max'}

spacing : {'uniform', 'proportional'}

ticks : `~matplotlib.ticker.Locator` or array-like of float

format : str or `~matplotlib.ticker.Formatter`

drawedges : bool

filled : bool

extendfrac

extendrec

label : str
"""
_slice_dict = {'neither': slice(0, None),
'both': slice(1, -1),
'min': slice(1, None),
Expand All @@ -408,7 +446,17 @@ def __init__(self, ax, cmap=None,
extendrect=False,
label='',
):
#: The axes that this colorbar lives in.
cbook._check_isinstance([colors.Colormap, None], cmap=cmap)
cbook._check_in_list(
['vertical', 'horizontal'], orientation=orientation)
cbook._check_in_list(
['auto', 'left', 'right', 'top', 'bottom'],
ticklocation=ticklocation)
cbook._check_in_list(
self._slice_dict, extend=extend)
cbook._check_in_list(
['uniform', 'proportional'], spacing=spacing)

self.ax = ax
self._patch_ax()
if cmap is None:
Expand Down
0