matplotlib/tutorials/text/text_props.py at master · rth/matplotlib · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

"""

============================

Text properties and layout

============================

Controlling properties of text and its layout with Matplotlib.

The :class:`matplotlib.text.Text` instances have a variety of

properties which can be configured via keyword arguments to the text

commands (e.g., :func:`~matplotlib.pyplot.title`,

:func:`~matplotlib.pyplot.xlabel` and :func:`~matplotlib.pyplot.text`).

========================== ======================================================================================================================

Property Value Type

========================== ======================================================================================================================

alpha `float`

backgroundcolor any matplotlib :doc:`color </tutorials/colors/colors>`

bbox `~matplotlib.patches.Rectangle` prop dict plus key ``'pad'`` which is a pad in points

clip_box a matplotlib.transform.Bbox instance

clip_on bool

clip_path a `~matplotlib.path.Path` instance and a `~matplotlib.transforms.Transform` instance, a `~matplotlib.patches.Patch`

color any matplotlib :doc:`color </tutorials/colors/colors>`

family [ ``'serif'`` | ``'sans-serif'`` | ``'cursive'`` | ``'fantasy'`` | ``'monospace'`` ]

fontproperties a `~matplotlib.font_manager.FontProperties` instance

horizontalalignment or ha [ ``'center'`` | ``'right'`` | ``'left'`` ]

label any string

linespacing `float`

multialignment [``'left'`` | ``'right'`` | ``'center'`` ]

name or fontname string e.g., [``'Sans'`` | ``'Courier'`` | ``'Helvetica'`` ...]

picker [None|float|boolean|callable]

position (x, y)

rotation [ angle in degrees | ``'vertical'`` | ``'horizontal'`` ]

size or fontsize [ size in points | relative size, e.g., ``'smaller'``, ``'x-large'`` ]

style or fontstyle [ ``'normal'`` | ``'italic'`` | ``'oblique'`` ]

text string or anything printable with '%s' conversion

transform a `~matplotlib.transforms.Transform` instance

variant [ ``'normal'`` | ``'small-caps'`` ]

verticalalignment or va [ ``'center'`` | ``'top'`` | ``'bottom'`` | ``'baseline'`` ]

visible bool

x `float`

y `float`

zorder any number

========================== ======================================================================================================================

You can lay out text with the alignment arguments

``horizontalalignment``, ``verticalalignment``, and

``multialignment``. ``horizontalalignment`` controls whether the x

positional argument for the text indicates the left, center or right

side of the text bounding box. ``verticalalignment`` controls whether

the y positional argument for the text indicates the bottom, center or

top side of the text bounding box. ``multialignment``, for newline

separated strings only, controls whether the different lines are left,

center or right justified. Here is an example which uses the

:func:`~matplotlib.pyplot.text` command to show the various alignment

possibilities. The use of ``transform=ax.transAxes`` throughout the

code indicates that the coordinates are given relative to the axes

bounding box, with 0,0 being the lower left of the axes and 1,1 the

upper right.

"""

import matplotlib.pyplot as plt

import matplotlib.patches as patches

# build a rectangle in axes coords

left, width = .25, .5

bottom, height = .25, .5

right = left + width

top = bottom + height

fig = plt.figure()

ax = fig.add_axes([0, 0, 1, 1])

# axes coordinates are 0,0 is bottom left and 1,1 is upper right

p = patches.Rectangle(

(left, bottom), width, height,

fill=False, transform=ax.transAxes, clip_on=False

)

ax.add_patch(p)

ax.text(left, bottom, 'left top',

horizontalalignment='left',

verticalalignment='top',

transform=ax.transAxes)

ax.text(left, bottom, 'left bottom',

horizontalalignment='left',

verticalalignment='bottom',

transform=ax.transAxes)

ax.text(right, top, 'right bottom',

horizontalalignment='right',

verticalalignment='bottom',

transform=ax.transAxes)

ax.text(right, top, 'right top',

horizontalalignment='right',

verticalalignment='top',

transform=ax.transAxes)

ax.text(right, bottom, 'center top',

horizontalalignment='center',

verticalalignment='top',

transform=ax.transAxes)

ax.text(left, 0.5*(bottom+top), 'right center',

horizontalalignment='right',

verticalalignment='center',

rotation='vertical',

transform=ax.transAxes)

ax.text(left, 0.5*(bottom+top), 'left center',

horizontalalignment='left',

verticalalignment='center',

rotation='vertical',

transform=ax.transAxes)

ax.text(0.5*(left+right), 0.5*(bottom+top), 'middle',

horizontalalignment='center',

verticalalignment='center',

fontsize=20, color='red',

transform=ax.transAxes)

ax.text(right, 0.5*(bottom+top), 'centered',

horizontalalignment='center',

verticalalignment='center',

rotation='vertical',

transform=ax.transAxes)

ax.text(left, top, 'rotated\nwith newlines',

horizontalalignment='center',

verticalalignment='center',

rotation=45,

transform=ax.transAxes)

ax.set_axis_off()

plt.show()

###############################################################################

# ==============

# Default Font

# ==============

# The base default font is controlled by a set of rcParams. To set the font

# for mathematical expressions, use the rcParams beginning with ``mathtext``

# (see :ref:`mathtext <mathtext-fonts>`).

# +---------------------+----------------------------------------------------+

# | rcParam | usage |

# +=====================+====================================================+

# | ``'font.family'`` | List of either names of font or ``{'cursive', |

# | | 'fantasy', 'monospace', 'sans', 'sans serif', |

# | | 'sans-serif', 'serif'}``. |

# | | |

# +---------------------+----------------------------------------------------+

# | ``'font.style'`` | The default style, ex ``'normal'``, |

# | | ``'italic'``. |

# | | |

# +---------------------+----------------------------------------------------+

# | ``'font.variant'`` | Default variant, ex ``'normal'``, ``'small-caps'`` |

# | | (untested) |

# +---------------------+----------------------------------------------------+

# | ``'font.stretch'`` | Default stretch, ex ``'normal'``, ``'condensed'`` |

# | | (incomplete) |

# | | |

# +---------------------+----------------------------------------------------+

# | ``'font.weight'`` | Default weight. Either string or integer |

# | | |

# +---------------------+----------------------------------------------------+

# | ``'font.size'`` | Default font size in points. Relative font sizes |

# | | (``'large'``, ``'x-small'``) are computed against |

# | | this size. |

# +---------------------+----------------------------------------------------+

# The mapping between the family aliases (``{'cursive', 'fantasy',

# 'monospace', 'sans', 'sans serif', 'sans-serif', 'serif'}``) and actual font names

# is controlled by the following rcParams:

# +------------------------------------------+--------------------------------+

# | family alias | rcParam with mappings |

# +==========================================+================================+

# | ``'serif'`` | ``'font.serif'`` |

# +------------------------------------------+--------------------------------+

# | ``'monospace'`` | ``'font.monospace'`` |

# +------------------------------------------+--------------------------------+

# | ``'fantasy'`` | ``'font.fantasy'`` |

# +------------------------------------------+--------------------------------+

# | ``'cursive'`` | ``'font.cursive'`` |

# +------------------------------------------+--------------------------------+

# | ``{'sans', 'sans serif', 'sans-serif'}`` | ``'font.sans-serif'`` |

# +------------------------------------------+--------------------------------+

# which are lists of font names.

# Text with non-latin glyphs

# ==========================

# As of v2.0 the :ref:`default font <default_changes_font>` contains

# glyphs for many western alphabets, but still does not cover all of the

# glyphs that may be required by mpl users. For example, DejaVu has no

# coverage of Chinese, Korean, or Japanese.

# To set the default font to be one that supports the code points you

# need, prepend the font name to ``'font.family'`` or the desired alias

# lists ::

# matplotlib.rcParams['font.sans-serif'] = ['Source Han Sans TW', 'sans-serif']

# or set it in your :file:`.matplotlibrc` file::

# font.sans-serif: Source Han Sans TW, Arial, sans-serif

# To control the font used on per-artist basis use the ``'name'``,

# ``'fontname'`` or ``'fontproperties'`` kwargs documented :doc:`above

# </tutorials/text/text_props>`.

# On linux, `fc-list <https://linux.die.net/man/1/fc-list>`__ can be a

# useful tool to discover the font name; for example ::

# $ fc-list :lang=zh family

# Noto to Sans Mono CJK TC,Noto Sans Mono CJK TC Bold

# Noto Sans CJK TC,Noto Sans CJK TC Medium

# Noto Sans CJK TC,Noto Sans CJK TC DemiLight

# Noto Sans CJK KR,Noto Sans CJK KR Black

# Noto Sans CJK TC,Noto Sans CJK TC Black

# Noto Sans Mono CJK TC,Noto Sans Mono CJK TC Regular

# Noto Sans CJK SC,Noto Sans CJK SC Light

# lists all of the fonts that support Chinese.

matplotlib/tutorials/text/text_props.py at master · rth/matplotlib · GitHub

Repository navigation

Expand file tree

Breadcrumbs

text_props.py

Latest commit

History

Breadcrumbs

text_props.py

File metadata and controls