Skip to content

Anchored sizebar fontprop #2712

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 4 commits into from
Jan 13, 2014
Merged

Anchored sizebar fontprop #2712

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cf9cd63
Improvements to anchored_artists.AnchoredSizeBar
magnunor Nov 8, 2013
a693d00
Add fontprop parameter to anchored_artists.AnchoredSizeBar
magnunor Jan 6, 2014
a1e2989
Modify AnchoredSizeBar: change fontprops argument to fontproperties
magnunor Jan 10, 2014
c09cf41
Merge pull request #7 from magnunor/pelson_anchored_sizebar_fontprop
pelson Jan 13, 2014
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
44 changes: 32 additions & 12 deletions lib/mpl_toolkits/axes_grid1/anchored_artists.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ class AnchoredSizeBar(AnchoredOffsetbox):
def __init__(self, transform, size, label, loc,
pad=0.1, borderpad=0.1, sep=2, prop=None,
frameon=True, size_vertical=0, color='black',
label_top=False,
label_top=False, fontproperties=None,
**kwargs):
"""
Draw a horizontal bar with the size in data coordinate of the give axes.
Draw a horizontal bar with the size in data coordinate of the given axes.
A label will be drawn underneath (center-aligned).

Parameters:
Expand All @@ -97,25 +97,45 @@ def __init__(self, transform, size, label, loc,
color : str, optional
color for the size bar and label
label_top : bool, optional
if true, the label will be over the rectangle
if True, the label will be over the rectangle
fontproperties: a matplotlib.font_manager.FontProperties instance, optional
sets the font properties for the label text

Returns:
--------
AnchoredSizeBar object

Example:
--------
>>>> import matplotlib.pyplot as plt
>>>> import numpy as np
>>>> from mpl_toolkits.axes_grid1.anchored_artists import AnchoredSizeBar
>>>> fig, ax = plt.subplots()
>>>> ax = imshow(np.random.random((10,10)))
>>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', pad=0.5, loc=4, sep=5, borderpad=0.5, frameon=False, size_vertical=0.5, color='white')
>>>> ax.add_artist(bar)
>>>> plt.show()
>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import AnchoredSizeBar
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10,10)))
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', 4)
>>> ax.add_artist(bar)
>>> fig.show()

Using all the optional parameters

>>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(size=14, family='monospace')
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', 4, pad=0.5, sep=5, borderpad=0.5, frameon=False, size_vertical=0.5, color='white', fontproperties=fontprops)

"""

self.size_bar = AuxTransformBox(transform)
self.size_bar.add_artist(Rectangle((0,0), size, size_vertical, fill=True, facecolor=color, edgecolor=color))

self.txt_label = TextArea(label, minimumdescent=False)
if not fontproperties:
textprops = {'color': color}
else:
textprops = {'color': color, 'fontproperties': fontproperties}

self.txt_label = TextArea(
label,
minimumdescent=False,
textprops=textprops)

if label_top:
_box_children = [self.txt_label, self.size_bar]
Expand Down