Skip to content

[ENH]: Use new style format strings for colorbar ticks #21542

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
jklymak merged 2 commits into from
Nov 9, 2021
Merged

[ENH]: Use new style format strings for colorbar ticks #21542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
782c82a
Reverted the code according to the review and kept the support for
vfdev-5 Nov 8, 2021
c4aae9d
Fixed flake8
vfdev-5 Nov 8, 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
9 changes: 8 additions & 1 deletion lib/matplotlib/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,8 @@ class Colorbar:
ticks : `~matplotlib.ticker.Locator` or array-like of float

format : str or `~matplotlib.ticker.Formatter`
If string, it supports '%' operator and `str.format` formats:
e.g. ``"%4.2e"`` or ``"{x:.2e}"``.

drawedges : bool

Expand Down Expand Up @@ -487,7 +489,12 @@ def __init__(self, ax, mappable=None, *, cmap=None,
self.locator = ticks # Handle default in _ticker()

if isinstance(format, str):
self.formatter = ticker.FormatStrFormatter(format)
# Check format between FormatStrFormatter and StrMethodFormatter
try:
self.formatter = ticker.FormatStrFormatter(format)
_ = self.formatter(0)
except TypeError:
self.formatter = ticker.StrMethodFormatter(format)
else:
self.formatter = format # Assume it is a Formatter or None
self.draw_all()
Expand Down
5 changes: 3 additions & 2 deletions lib/matplotlib/tests/test_colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,14 +543,15 @@ def test_colorbar_renorm():
assert np.isclose(cbar.vmax, z.max() * 1000)


def test_colorbar_format():
@pytest.mark.parametrize('fmt', ['%4.2e', '{x:.2e}'])
def test_colorbar_format(fmt):
# make sure that format is passed properly
x, y = np.ogrid[-4:4:31j, -4:4:31j]
z = 120000*np.exp(-x**2 - y**2)

fig, ax = plt.subplots()
im = ax.imshow(z)
cbar = fig.colorbar(im, format='%4.2e')
cbar = fig.colorbar(im, format=fmt)
fig.canvas.draw()
assert cbar.ax.yaxis.get_ticklabels()[4].get_text() == '8.00e+04'

Expand Down