matplotlib.github.com/2.2.2/tutorials/text/text_props.html at main · matplotlib/matplotlib.github.com

History

478 lines (439 loc) · 37.5 KB

Raw

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

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Text properties and layout — Matplotlib 2.2.2 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.2.2',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.2 documentation"

href="../../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.2). For the latest version see <a href="https://matplotlib.org/stable/tutorials/text/text_props.html">https://matplotlib.org/stable/tutorials/text/text_props.html</a></div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 2.2.2</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="text_intro.html" title="Text in Matplotlib Plots"

accesskey="N">next</a> |</li>

<a href="mathtext.html" title="Writing mathematical expressions"

accesskey="P">previous</a> |</li>

<li><a href="../../gallery/index.html">examples</a>| </li>

<li><a href="../index.html">tutorials</a>| </li>

<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>

<li><a href="../../users/index.html" >User’s Guide</a> »</li>

<li><a href="../index.html" accesskey="U">Tutorials</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3><a href="../../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Text properties and layout</a></li>

<li><a class="reference internal" href="#default-font">Default Font</a><ul>

<li><a class="reference internal" href="#text-with-non-latin-glyphs">Text with non-latin glyphs</a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../../users/index.html">User’s Guide</a><ul>

<li><a href="../index.html">Tutorials</a><ul>

<li>Previous: <a href="mathtext.html" title="previous chapter">Writing mathematical expressions</a></li>

<li>Next: <a href="text_intro.html" title="next chapter">Text in Matplotlib Plots</a></li>

</ul></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../../_sources/tutorials/text/text_props.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

Note

Click <a class="reference internal" href="#sphx-glr-download-tutorials-text-text-props-py">here</a> to download the full example code

</div>

<h1>Text properties and layout<a class="headerlink" href="#text-properties-and-layout" title="Permalink to this headline">¶</a></h1>

Controlling properties of text and its layout with Matplotlib.

The <a class="reference internal" href="../../api/text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate">matplotlib.text.Text</code></a> instances have a variety of

properties which can be configured via keyword arguments to the text

commands (e.g., <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.title.html#matplotlib.pyplot.title" title="matplotlib.pyplot.title"><code class="xref py py-func docutils literal notranslate">title()</code></a>,

<a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.xlabel.html#matplotlib.pyplot.xlabel" title="matplotlib.pyplot.xlabel"><code class="xref py py-func docutils literal notranslate">xlabel()</code></a> and <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.text.html#matplotlib.pyplot.text" title="matplotlib.pyplot.text"><code class="xref py py-func docutils literal notranslate">text()</code></a>).

</colgroup>

<tr class="row-odd"><th class="head">Property</th>

<th class="head">Value Type</th>

</tr>

</thead>

<tr class="row-even"><td>alpha</td>

<td><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate">float</code></a></td>

</tr>

<tr class="row-odd"><td>backgroundcolor</td>

<td>any matplotlib <a class="reference internal" href="../colors/colors.html#sphx-glr-tutorials-colors-colors-py">color</a></td>

</tr>

<td><a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><code class="xref py py-obj docutils literal notranslate">Rectangle</code></a> prop dict plus key <code class="docutils literal notranslate">'pad'</code> which is a pad in points</td>

</tr>

<td>a matplotlib.transform.Bbox instance</td>

</tr>

</tr>

<td>a <a class="reference internal" href="../../api/path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> instance and a <a class="reference internal" href="../../api/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a> instance, a <a class="reference internal" href="../../api/_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-obj docutils literal notranslate">Patch</code></a></td>

</tr>

<tr class="row-even"><td>color</td>

<td>any matplotlib <a class="reference internal" href="../colors/colors.html#sphx-glr-tutorials-colors-colors-py">color</a></td>

</tr>

<tr class="row-odd"><td>family</td>

<td>[ <code class="docutils literal notranslate">'serif'</code> | <code class="docutils literal notranslate">'sans-serif'</code> | <code class="docutils literal notranslate">'cursive'</code> | <code class="docutils literal notranslate">'fantasy'</code> | <code class="docutils literal notranslate">'monospace'</code> ]</td>

</tr>

<tr class="row-even"><td>fontproperties</td>

<td>a <a class="reference internal" href="../../api/font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate">FontProperties</code></a> instance</td>

</tr>

<tr class="row-odd"><td>horizontalalignment or ha</td>

<td>[ <code class="docutils literal notranslate">'center'</code> | <code class="docutils literal notranslate">'right'</code> | <code class="docutils literal notranslate">'left'</code> ]</td>

</tr>

<tr class="row-even"><td>label</td>

<td>any string</td>

</tr>

<tr class="row-odd"><td>linespacing</td>

</tr>

<tr class="row-even"><td>multialignment</td>

<td>[<code class="docutils literal notranslate">'left'</code> | <code class="docutils literal notranslate">'right'</code> | <code class="docutils literal notranslate">'center'</code> ]</td>

</tr>

<tr class="row-odd"><td>name or fontname</td>

<td>string e.g., [<code class="docutils literal notranslate">'Sans'</code> | <code class="docutils literal notranslate">'Courier'</code> | <code class="docutils literal notranslate">'Helvetica'</code> …]</td>

</tr>

<tr class="row-even"><td>picker</td>

<td>[None|float|boolean|callable]</td>

</tr>

<tr class="row-odd"><td>position</td>

</tr>

<tr class="row-even"><td>rotation</td>

<td>[ angle in degrees | <code class="docutils literal notranslate">'vertical'</code> | <code class="docutils literal notranslate">'horizontal'</code> ]</td>

</tr>

<tr class="row-odd"><td>size or fontsize</td>

<td>[ size in points | relative size, e.g., <code class="docutils literal notranslate">'smaller'</code>, <code class="docutils literal notranslate">'x-large'</code> ]</td>

</tr>

<tr class="row-even"><td>style or fontstyle</td>

<td>[ <code class="docutils literal notranslate">'normal'</code> | <code class="docutils literal notranslate">'italic'</code> | <code class="docutils literal notranslate">'oblique'</code> ]</td>

</tr>

<td>string or anything printable with ‘%s’ conversion</td>

</tr>

<tr class="row-even"><td>transform</td>

<td>a <a class="reference internal" href="../../api/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a> instance</td>

</tr>

<tr class="row-odd"><td>variant</td>

<td>[ <code class="docutils literal notranslate">'normal'</code> | <code class="docutils literal notranslate">'small-caps'</code> ]</td>

</tr>

<tr class="row-even"><td>verticalalignment or va</td>

<td>[ <code class="docutils literal notranslate">'center'</code> | <code class="docutils literal notranslate">'top'</code> | <code class="docutils literal notranslate">'bottom'</code> | <code class="docutils literal notranslate">'baseline'</code> ]</td>

</tr>

<tr class="row-odd"><td>visible</td>

</tr>

<tr class="row-even"><td>weight or fontweight</td>

<td>[ <code class="docutils literal notranslate">'normal'</code> | <code class="docutils literal notranslate">'bold'</code> | <code class="docutils literal notranslate">'heavy'</code> | <code class="docutils literal notranslate">'light'</code> | <code class="docutils literal notranslate">'ultrabold'</code> | <code class="docutils literal notranslate">'ultralight'</code>]</td>

</tr>

</tr>

</tr>

<tr class="row-odd"><td>zorder</td>

<td>any number</td>

</tr>

</tbody>

</table>

You can lay out text with the alignment arguments

<code class="docutils literal notranslate">horizontalalignment</code>, <code class="docutils literal notranslate">verticalalignment</code>, and

<code class="docutils literal notranslate">multialignment</code>. <code class="docutils literal notranslate">horizontalalignment</code> controls whether the x

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

side of the text bounding box. <code class="docutils literal notranslate">verticalalignment</code> controls whether

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

top side of the text bounding box. <code class="docutils literal notranslate">multialignment</code>, for newline

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

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

<a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.text.html#matplotlib.pyplot.text" title="matplotlib.pyplot.text"><code class="xref py py-func docutils literal notranslate">text()</code></a> command to show the various alignment

possibilities. The use of <code class="docutils literal notranslate">transform=ax.transAxes</code> 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.

<div class="highlight-python notranslate"><div class="highlight"><pre>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 = <a href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="View documentation for matplotlib.pyplot.figure">plt.figure</a>()

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

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

p = <a href="../../api/_as_gen/matplotlib.patches.Rectangle.html#matplotlib.patches.Rectangle" title="View documentation for matplotlib.patches.Rectangle">patches.Rectangle</a>(

(left, bottom), width, height,

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

)

ax.add_patch(p)

horizontalalignment='left',

verticalalignment='top',

transform=ax.transAxes)

horizontalalignment='left',

verticalalignment='bottom',

transform=ax.transAxes)

horizontalalignment='right',

verticalalignment='bottom',

transform=ax.transAxes)

horizontalalignment='right',

verticalalignment='top',

transform=ax.transAxes)

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)

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()

<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show">plt.show</a>()

</pre></div>

</div>

</div>

<h1>Default Font<a class="headerlink" href="#default-font" title="Permalink to this headline">¶</a></h1>

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

for mathematical expressions, use the rcParams beginning with <code class="docutils literal notranslate">mathtext</code>

(see <a class="reference internal" href="mathtext.html#mathtext-fonts">mathtext</a>).

</colgroup>

<tr class="row-odd"><th class="head">rcParam</th>

<th class="head">usage</th>

</tr>

</thead>

<tr class="row-even"><td><code class="docutils literal notranslate">'font.family'</code></td>

<td>List of either names of font or <code class="docutils literal notranslate">{'cursive',

'fantasy', 'monospace', 'sans', 'sans serif',

'sans-serif', 'serif'}</code>.</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate">'font.style'</code></td>

<td>The default style, ex <code class="docutils literal notranslate">'normal'</code>,

<code class="docutils literal notranslate">'italic'</code>.</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate">'font.variant'</code></td>

<td>Default variant, ex <code class="docutils literal notranslate">'normal'</code>, <code class="docutils literal notranslate">'small-caps'</code>

(untested)</td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate">'font.stretch'</code></td>

<td>Default stretch, ex <code class="docutils literal notranslate">'normal'</code>, <code class="docutils literal notranslate">'condensed'</code>

(incomplete)</td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate">'font.weight'</code></td>

<td>Default weight. Either string or integer</td>

</tr>

<td>Default font size in points. Relative font sizes

(<code class="docutils literal notranslate">'large'</code>, <code class="docutils literal notranslate">'x-small'</code>) are computed against

this size.</td>

</tr>

</tbody>

</table>

The mapping between the family aliases (<code class="docutils literal notranslate">{'cursive', 'fantasy',

'monospace', 'sans', 'sans serif', 'sans-serif', 'serif'}</code>) and actual font names

is controlled by the following rcParams:

</colgroup>

<tr class="row-odd"><th class="head">family alias</th>

<th class="head">rcParam with mappings</th>

</tr>

</thead>

<tr class="row-even"><td><code class="docutils literal notranslate">'serif'</code></td>

<td><code class="docutils literal notranslate">'font.serif'</code></td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate">'monospace'</code></td>

<td><code class="docutils literal notranslate">'font.monospace'</code></td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate">'fantasy'</code></td>

<td><code class="docutils literal notranslate">'font.fantasy'</code></td>

</tr>

<tr class="row-odd"><td><code class="docutils literal notranslate">'cursive'</code></td>

<td><code class="docutils literal notranslate">'font.cursive'</code></td>

</tr>

<tr class="row-even"><td><code class="docutils literal notranslate">{'sans', 'sans serif', 'sans-serif'}</code></td>

<td><code class="docutils literal notranslate">'font.sans-serif'</code></td>

</tr>

</tbody>

</table>

which are lists of font names.

<h2>Text with non-latin glyphs<a class="headerlink" href="#text-with-non-latin-glyphs" title="Permalink to this headline">¶</a></h2>

As of v2.0 the <a class="reference internal" href="../../users/dflt_style_changes.html#default-changes-font">default font</a> 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 <code class="docutils literal notranslate">'font.family'</code> or the desired alias

lists

<div class="highlight-default notranslate"><div class="highlight"><pre>matplotlib.rcParams['font.sans-serif'] = ['Source Han Sans TW', 'sans-serif']

</pre></div>

</div>

or set it in your <code class="file docutils literal notranslate">.matplotlibrc</code> file:

<div class="highlight-default notranslate"><div class="highlight"><pre>font.sans-serif: Source Han Sans TW, Arial, sans-serif

</pre></div>

</div>

To control the font used on per-artist basis use the <code class="docutils literal notranslate">'name'</code>,

<code class="docutils literal notranslate">'fontname'</code> or <code class="docutils literal notranslate">'fontproperties'</code> kwargs documented <a class="reference internal" href="#sphx-glr-tutorials-text-text-props-py">above</a>.

On linux, <a class="reference external" href="https://linux.die.net/man/1/fc-list">fc-list</a> can be a

useful tool to discover the font name; for example

<div class="highlight-default notranslate"><div class="highlight"><pre>$ 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

</pre></div>

</div>

lists all of the fonts that support Chinese.

<a class="reference download internal" href="../../_downloads/text_props.py" download=""><code class="xref download docutils literal notranslate">Download Python source code: text_props.py</code></a></div>

<a class="reference download internal" href="../../_downloads/text_props.ipynb" download=""><code class="xref download docutils literal notranslate">Download Jupyter notebook: text_props.ipynb</code></a></div>

</div>

Keywords: matplotlib code example, codex, python plot, pyplot

<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a>

</div>

</div>

Last updated on Jun 28, 2018.

Created using

<ahref="http://sphinx-doc.org/">Sphinx</a> 1.7.5.

Doc version v2.2.2-101-g15e1eadd0.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

text_props.html

Latest commit

History

text_props.html

File metadata and controls