-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathfont_manager_api.html
More file actions
751 lines (678 loc) · 63.5 KB
/
font_manager_api.html
File metadata and controls
751 lines (678 loc) · 63.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>matplotlib.font_manager — Matplotlib 3.4.2 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.4.2-2-gf801f04d09-dirty" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.2 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.fontconfig_pattern" href="fontconfig_pattern_api.html" />
<link rel="prev" title="matplotlib.figure" href="figure_api.html" />
<link rel="top" title="Matplotlib 3.4.2 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/font_manager_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.2). For the latest version see <a href="https://matplotlib.org/stable/api/font_manager_api.html">https://matplotlib.org/stable/api/font_manager_api.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.4.2</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="fontconfig_pattern_api.html" title="matplotlib.fontconfig_pattern"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="figure_api.html" title="matplotlib.figure"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.font_manager</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<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/api/font_manager_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.font_manager">
<span id="matplotlib-font-manager"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.font_manager</span></code><a class="headerlink" href="#module-matplotlib.font_manager" title="Permalink to this headline">¶</a></h1>
<p>A module for finding, managing, and using fonts across platforms.</p>
<p>This module provides a single <a class="reference internal" href="#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> instance that can
be shared across backends and platforms. The <a class="reference internal" href="#matplotlib.font_manager.findfont" title="matplotlib.font_manager.findfont"><code class="xref py py-obj docutils literal notranslate"><span class="pre">findfont</span></code></a>
function returns the best TrueType (TTF) font file in the local or
system font path that matches the specified <a class="reference internal" href="#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a>
instance. The <a class="reference internal" href="#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> also handles Adobe Font Metrics
(AFM) font files for use by the PostScript backend.</p>
<p>The design is based on the <a class="reference external" href="http://www.w3.org/TR/1998/REC-CSS2-19980512/">W3C Cascading Style Sheet, Level 1 (CSS1)
font specification</a>.
Future versions may implement the Level 2 or 2.1 specifications.</p>
<dl class="py class">
<dt id="matplotlib.font_manager.FontEntry">
<em class="property">class </em><code class="descclassname">matplotlib.font_manager.</code><code class="descname">FontEntry</code><span class="sig-paren">(</span><em><span class="n">fname</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">name</span><span class="o">=</span><span class="default_value">''</span></em>, <em><span class="n">style</span><span class="o">=</span><span class="default_value">'normal'</span></em>, <em><span class="n">variant</span><span class="o">=</span><span class="default_value">'normal'</span></em>, <em><span class="n">weight</span><span class="o">=</span><span class="default_value">'normal'</span></em>, <em><span class="n">stretch</span><span class="o">=</span><span class="default_value">'normal'</span></em>, <em><span class="n">size</span><span class="o">=</span><span class="default_value">'medium'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontEntry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontEntry" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A class for storing Font properties. It is used when populating
the font lookup dictionary.</p>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.font_manager.FontManager">
<em class="property">class </em><code class="descclassname">matplotlib.font_manager.</code><code class="descname">FontManager</code><span class="sig-paren">(</span><em><span class="n">size</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">weight</span><span class="o">=</span><span class="default_value">'normal'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>On import, the <a class="reference internal" href="#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> singleton instance creates a list of ttf and
afm fonts and caches their <a class="reference internal" href="#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a>. The <a class="reference internal" href="#matplotlib.font_manager.FontManager.findfont" title="matplotlib.font_manager.FontManager.findfont"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager.findfont</span></code></a>
method does a nearest neighbor search to find the font that most closely
matches the specification. If no good enough match is found, the default
font is returned.</p>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.addfont">
<code class="descname">addfont</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.addfont"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.addfont" title="Permalink to this definition">¶</a></dt>
<dd><p>Cache the properties of the font at <em>path</em> to make it available to the
<a class="reference internal" href="#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a>. The type of font is inferred from the path suffix.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>path</strong><span class="classifier">str or path-like</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.defaultFont">
<em class="property">property </em><code class="descname">defaultFont</code><a class="headerlink" href="#matplotlib.font_manager.FontManager.defaultFont" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.findfont">
<code class="descname">findfont</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">prop</span></em>, <em><span class="n">fontext</span><span class="o">=</span><span class="default_value">'ttf'</span></em>, <em><span class="n">directory</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fallback_to_default</span><span class="o">=</span><span class="default_value">True</span></em>, <em><span class="n">rebuild_if_missing</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.findfont"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.findfont" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a font that most closely matches the given font properties.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>prop</strong><span class="classifier">str or <a class="reference internal" href="#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a></span></dt><dd><p>The font properties to search for. This can be either a
<a class="reference internal" href="#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a> object or a string defining a
<a class="reference external" href="https://www.freedesktop.org/software/fontconfig/fontconfig-user.html">fontconfig patterns</a>.</p>
</dd>
<dt><strong>fontext</strong><span class="classifier">{'ttf', 'afm'}, default: 'ttf'</span></dt><dd><p>The extension of the font file:</p>
<ul class="simple">
<li>'ttf': TrueType and OpenType fonts (.ttf, .ttc, .otf)</li>
<li>'afm': Adobe Font Metrics (.afm)</li>
</ul>
</dd>
<dt><strong>directory</strong><span class="classifier">str, optional</span></dt><dd><p>If given, only search this directory and its subdirectories.</p>
</dd>
<dt><strong>fallback_to_default</strong><span class="classifier">bool</span></dt><dd><p>If True, will fallback to the default font family (usually
"DejaVu Sans" or "Helvetica") if the first lookup hard-fails.</p>
</dd>
<dt><strong>rebuild_if_missing</strong><span class="classifier">bool</span></dt><dd><p>Whether to rebuild the font cache and search again if the first
match appears to point to a nonexisting font (i.e., the font cache
contains outdated entries).</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>str</dt><dd><p>The filename of the best matching font.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>This performs a nearest neighbor search. Each font is given a
similarity score to the target font properties. The first font with
the highest score is returned. If no matches below a certain
threshold are found, the default font (usually DejaVu Sans) is
returned.</p>
<p>The result is cached, so subsequent lookups don't have to
perform the O(n) nearest neighbor search.</p>
<p>See the <a class="reference external" href="http://www.w3.org/TR/1998/REC-CSS2-19980512/">W3C Cascading Style Sheet, Level 1</a> documentation
for a description of the font finding algorithm.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.get_default_size">
<em class="property">static </em><code class="descname">get_default_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.get_default_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.get_default_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the default font size.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.get_default_weight">
<code class="descname">get_default_weight</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.get_default_weight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.get_default_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the default font weight.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.score_family">
<code class="descname">score_family</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">families</span></em>, <em><span class="n">family2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.score_family"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.score_family" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a match score between the list of font families in
<em>families</em> and the font family name <em>family2</em>.</p>
<p>An exact match at the head of the list returns 0.0.</p>
<p>A match further down the list will return between 0 and 1.</p>
<p>No match will return 1.0.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.score_size">
<code class="descname">score_size</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">size1</span></em>, <em><span class="n">size2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.score_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.score_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a match score between <em>size1</em> and <em>size2</em>.</p>
<p>If <em>size2</em> (the size specified in the font file) is 'scalable', this
function always returns 0.0, since any font size can be generated.</p>
<p>Otherwise, the result is the absolute distance between <em>size1</em> and
<em>size2</em>, normalized so that the usual range of font sizes (6pt -
72pt) will lie between 0.0 and 1.0.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.score_stretch">
<code class="descname">score_stretch</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">stretch1</span></em>, <em><span class="n">stretch2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.score_stretch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.score_stretch" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a match score between <em>stretch1</em> and <em>stretch2</em>.</p>
<p>The result is the absolute value of the difference between the
CSS numeric values of <em>stretch1</em> and <em>stretch2</em>, normalized
between 0.0 and 1.0.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.score_style">
<code class="descname">score_style</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">style1</span></em>, <em><span class="n">style2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.score_style"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.score_style" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a match score between <em>style1</em> and <em>style2</em>.</p>
<p>An exact match returns 0.0.</p>
<p>A match between 'italic' and 'oblique' returns 0.1.</p>
<p>No match returns 1.0.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.score_variant">
<code class="descname">score_variant</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">variant1</span></em>, <em><span class="n">variant2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.score_variant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.score_variant" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a match score between <em>variant1</em> and <em>variant2</em>.</p>
<p>An exact match returns 0.0, otherwise 1.0.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.score_weight">
<code class="descname">score_weight</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">weight1</span></em>, <em><span class="n">weight2</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.score_weight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.score_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a match score between <em>weight1</em> and <em>weight2</em>.</p>
<p>The result is 0.0 if both weight1 and weight 2 are given as strings
and have the same value.</p>
<p>Otherwise, the result is the absolute value of the difference between
the CSS numeric values of <em>weight1</em> and <em>weight2</em>, normalized between
0.05 and 1.0.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontManager.set_default_weight">
<code class="descname">set_default_weight</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">weight</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontManager.set_default_weight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontManager.set_default_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the default font weight. The initial value is 'normal'.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="matplotlib.font_manager.FontProperties">
<em class="property">class </em><code class="descclassname">matplotlib.font_manager.</code><code class="descname">FontProperties</code><span class="sig-paren">(</span><em><span class="n">family</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">style</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">variant</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">weight</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">stretch</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">size</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fname</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">math_fontfamily</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A class for storing and manipulating font properties.</p>
<p>The font properties are the six properties described in the
<a class="reference external" href="http://www.w3.org/TR/1998/REC-CSS2-19980512/">W3C Cascading Style Sheet, Level 1</a> font
specification and <em>math_fontfamily</em> for math fonts:</p>
<ul class="simple">
<li>family: A list of font names in decreasing order of priority.
The items may include a generic font family name, either
'sans-serif' (default), 'serif', 'cursive', 'fantasy', or 'monospace'.
In that case, the actual font to be used will be looked up
from the associated rcParam.</li>
<li>style: Either 'normal' (default), 'italic' or 'oblique'.</li>
<li>variant: Either 'normal' (default) or 'small-caps'.</li>
<li>stretch: A numeric value in the range 0-1000 or one of
'ultra-condensed', 'extra-condensed', 'condensed',
'semi-condensed', 'normal' (default), 'semi-expanded', 'expanded',
'extra-expanded' or 'ultra-expanded'.</li>
<li>weight: A numeric value in the range 0-1000 or one of
'ultralight', 'light', 'normal' (default), 'regular', 'book', 'medium',
'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy',
'extra bold', 'black'.</li>
<li>size: Either an relative value of 'xx-small', 'x-small',
'small', 'medium', 'large', 'x-large', 'xx-large' or an
absolute font size, e.g., 10 (default).</li>
<li>math_fontfamily: The family of fonts used to render math text; overrides
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=mathtext.fontset#a-sample-matplotlibrc-file"><span class="pre">rcParams["mathtext.fontset"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'dejavusans'</span></code>). Supported values are the same as the ones
supported by <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=mathtext.fontset#a-sample-matplotlibrc-file"><span class="pre">rcParams["mathtext.fontset"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'dejavusans'</span></code>): 'dejavusans', 'dejavuserif', 'cm',
'stix', 'stixsans' and 'custom'.</li>
</ul>
<p>Alternatively, a font may be specified using the absolute path to a font
file, by using the <em>fname</em> kwarg. However, in this case, it is typically
simpler to just pass the path (as a <a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pathlib.Path</span></code></a>, not a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) to the
<em>font</em> kwarg of the <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code></a> object.</p>
<p>The preferred usage of font sizes is to use the relative values,
e.g., 'large', instead of absolute font sizes, e.g., 12. This
approach allows all text sizes to be made larger or smaller based
on the font manager's default font size.</p>
<p>This class will also accept a <a class="reference external" href="https://www.freedesktop.org/wiki/Software/fontconfig/">fontconfig</a> <a class="reference external" href="https://www.freedesktop.org/software/fontconfig/fontconfig-user.html">pattern</a>, if it is the only
argument provided. This support does not depend on fontconfig; we are
merely borrowing its pattern syntax for use here.</p>
<p>Note that Matplotlib's internal font manager and fontconfig use a
different algorithm to lookup fonts, so the results of the same pattern
may be different in Matplotlib than in other applications that use
fontconfig.</p>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.copy">
<code class="descname">copy</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a copy of self.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_family">
<code class="descname">get_family</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_family"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_family" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of font names that comprise the font family.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_file">
<code class="descname">get_file</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the filename of the associated font.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_fontconfig_pattern">
<code class="descname">get_fontconfig_pattern</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_fontconfig_pattern"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_fontconfig_pattern" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a <a class="reference external" href="https://www.freedesktop.org/wiki/Software/fontconfig/">fontconfig</a> <a class="reference external" href="https://www.freedesktop.org/software/fontconfig/fontconfig-user.html">pattern</a> suitable for looking up the font as
specified with fontconfig's <code class="docutils literal notranslate"><span class="pre">fc-match</span></code> utility.</p>
<p>This support does not depend on fontconfig; we are merely borrowing its
pattern syntax for use here.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_math_fontfamily">
<code class="descname">get_math_fontfamily</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_math_fontfamily"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_math_fontfamily" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of the font family used for math text.</p>
<p>The default font is <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=mathtext.fontset#a-sample-matplotlibrc-file"><span class="pre">rcParams["mathtext.fontset"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'dejavusans'</span></code>).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_name">
<code class="descname">get_name</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of the font that best matches the font properties.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_size">
<code class="descname">get_size</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font size.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_size_in_points">
<code class="descname">get_size_in_points</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_size_in_points"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_size_in_points" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_slant">
<code class="descname">get_slant</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_slant" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font style. Values are: 'normal', 'italic' or 'oblique'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_stretch">
<code class="descname">get_stretch</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_stretch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_stretch" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font stretch or width. Options are: 'ultra-condensed',
'extra-condensed', 'condensed', 'semi-condensed', 'normal',
'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_style">
<code class="descname">get_style</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_style"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_style" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font style. Values are: 'normal', 'italic' or 'oblique'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_variant">
<code class="descname">get_variant</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_variant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_variant" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the font variant. Values are: 'normal' or 'small-caps'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.get_weight">
<code class="descname">get_weight</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.get_weight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.get_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font weight. Options are: A numeric value in the
range 0-1000 or one of 'light', 'normal', 'regular', 'book',
'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold',
'heavy', 'extra bold', 'black'</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_family">
<code class="descname">set_family</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">family</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_family"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_family" title="Permalink to this definition">¶</a></dt>
<dd><p>Change the font family. May be either an alias (generic name
is CSS parlance), such as: 'serif', 'sans-serif', 'cursive',
'fantasy', or 'monospace', a real font name or a list of real
font names. Real font names are not supported when
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) is <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_file">
<code class="descname">set_file</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">file</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the filename of the fontfile to use. In this case, all
other properties will be ignored.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_fontconfig_pattern">
<code class="descname">set_fontconfig_pattern</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">pattern</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_fontconfig_pattern"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_fontconfig_pattern" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the properties by parsing a <a class="reference external" href="https://www.freedesktop.org/wiki/Software/fontconfig/">fontconfig</a> <em>pattern</em>.</p>
<p>This support does not depend on fontconfig; we are merely borrowing its
pattern syntax for use here.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_math_fontfamily">
<code class="descname">set_math_fontfamily</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">fontfamily</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_math_fontfamily"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_math_fontfamily" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font family for text in math mode.</p>
<p>If not set explicitly, <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=mathtext.fontset#a-sample-matplotlibrc-file"><span class="pre">rcParams["mathtext.fontset"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'dejavusans'</span></code>) will be used.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fontfamily</strong><span class="classifier">str</span></dt><dd><p>The name of the font family.</p>
<p>Available font families are defined in the
matplotlibrc.template file
<a class="reference internal" href="../tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files"><span class="std std-ref">here</span></a></p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="text_api.html#matplotlib.text.Text.get_math_fontfamily" title="matplotlib.text.Text.get_math_fontfamily"><code class="xref py py-obj docutils literal notranslate"><span class="pre">text.Text.get_math_fontfamily</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_name">
<code class="descname">set_name</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">family</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Change the font family. May be either an alias (generic name
is CSS parlance), such as: 'serif', 'sans-serif', 'cursive',
'fantasy', or 'monospace', a real font name or a list of real
font names. Real font names are not supported when
<code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=text.usetex#a-sample-matplotlibrc-file"><span class="pre">rcParams["text.usetex"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>) is <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_size">
<code class="descname">set_size</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">size</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font size. Either an relative value of 'xx-small',
'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'
or an absolute font size, e.g., 12.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_slant">
<code class="descname">set_slant</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">style</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_slant" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font style. Values are: 'normal', 'italic' or 'oblique'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_stretch">
<code class="descname">set_stretch</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">stretch</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_stretch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_stretch" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font stretch or width. Options are: 'ultra-condensed',
'extra-condensed', 'condensed', 'semi-condensed', 'normal',
'semi-expanded', 'expanded', 'extra-expanded' or
'ultra-expanded', or a numeric value in the range 0-1000.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_style">
<code class="descname">set_style</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">style</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_style"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_style" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font style. Values are: 'normal', 'italic' or 'oblique'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_variant">
<code class="descname">set_variant</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">variant</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_variant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_variant" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font variant. Values are: 'normal' or 'small-caps'.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.font_manager.FontProperties.set_weight">
<code class="descname">set_weight</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">weight</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#FontProperties.set_weight"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.FontProperties.set_weight" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the font weight. May be either a numeric value in the
range 0-1000 or one of 'ultralight', 'light', 'normal',
'regular', 'book', 'medium', 'roman', 'semibold', 'demibold',
'demi', 'bold', 'heavy', 'extra bold', 'black'</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.afmFontProperty">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">afmFontProperty</code><span class="sig-paren">(</span><em><span class="n">fontpath</span></em>, <em><span class="n">font</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#afmFontProperty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.afmFontProperty" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract information from an AFM font file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>font</strong><span class="classifier"><a class="reference internal" href="afm_api.html#matplotlib.afm.AFM" title="matplotlib.afm.AFM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AFM</span></code></a></span></dt><dd><p>The AFM font file from which information will be extracted.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference internal" href="#matplotlib.font_manager.FontEntry" title="matplotlib.font_manager.FontEntry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontEntry</span></code></a></dt><dd><p>The extracted font properties.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.findSystemFonts">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">findSystemFonts</code><span class="sig-paren">(</span><em><span class="n">fontpaths</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fontext</span><span class="o">=</span><span class="default_value">'ttf'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#findSystemFonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.findSystemFonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Search for fonts in the specified font paths. If no paths are
given, will use a standard set of system paths, as well as the
list of fonts tracked by fontconfig if fontconfig is installed and
available. A list of TrueType fonts are returned by default with
AFM fonts as an option.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.findfont">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">findfont</code><span class="sig-paren">(</span><em><span class="n">prop</span></em>, <em><span class="n">fontext</span><span class="o">=</span><span class="default_value">'ttf'</span></em>, <em><span class="n">directory</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fallback_to_default</span><span class="o">=</span><span class="default_value">True</span></em>, <em><span class="n">rebuild_if_missing</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.font_manager.findfont" title="Permalink to this definition">¶</a></dt>
<dd><p>Find a font that most closely matches the given font properties.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>prop</strong><span class="classifier">str or <a class="reference internal" href="#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a></span></dt><dd><p>The font properties to search for. This can be either a
<a class="reference internal" href="#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontProperties</span></code></a> object or a string defining a
<a class="reference external" href="https://www.freedesktop.org/software/fontconfig/fontconfig-user.html">fontconfig patterns</a>.</p>
</dd>
<dt><strong>fontext</strong><span class="classifier">{'ttf', 'afm'}, default: 'ttf'</span></dt><dd><p>The extension of the font file:</p>
<ul class="simple">
<li>'ttf': TrueType and OpenType fonts (.ttf, .ttc, .otf)</li>
<li>'afm': Adobe Font Metrics (.afm)</li>
</ul>
</dd>
<dt><strong>directory</strong><span class="classifier">str, optional</span></dt><dd><p>If given, only search this directory and its subdirectories.</p>
</dd>
<dt><strong>fallback_to_default</strong><span class="classifier">bool</span></dt><dd><p>If True, will fallback to the default font family (usually
"DejaVu Sans" or "Helvetica") if the first lookup hard-fails.</p>
</dd>
<dt><strong>rebuild_if_missing</strong><span class="classifier">bool</span></dt><dd><p>Whether to rebuild the font cache and search again if the first
match appears to point to a nonexisting font (i.e., the font cache
contains outdated entries).</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>str</dt><dd><p>The filename of the best matching font.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>This performs a nearest neighbor search. Each font is given a
similarity score to the target font properties. The first font with
the highest score is returned. If no matches below a certain
threshold are found, the default font (usually DejaVu Sans) is
returned.</p>
<p>The result is cached, so subsequent lookups don't have to
perform the O(n) nearest neighbor search.</p>
<p>See the <a class="reference external" href="http://www.w3.org/TR/1998/REC-CSS2-19980512/">W3C Cascading Style Sheet, Level 1</a> documentation
for a description of the font finding algorithm.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.get_font">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">get_font</code><span class="sig-paren">(</span><em><span class="n">filename</span></em>, <em><span class="n">hinting_factor</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#get_font"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.get_font" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.get_fontconfig_fonts">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">get_fontconfig_fonts</code><span class="sig-paren">(</span><em><span class="n">fontext</span><span class="o">=</span><span class="default_value">'ttf'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#get_fontconfig_fonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.get_fontconfig_fonts" title="Permalink to this definition">¶</a></dt>
<dd><p>List font filenames known to <code class="xref py py-obj docutils literal notranslate"><span class="pre">fc-list</span></code> having the given extension.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.get_fontext_synonyms">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">get_fontext_synonyms</code><span class="sig-paren">(</span><em><span class="n">fontext</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#get_fontext_synonyms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.get_fontext_synonyms" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of file extensions extensions that are synonyms for
the given file extension <em>fileext</em>.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.is_opentype_cff_font">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">is_opentype_cff_font</code><span class="sig-paren">(</span><em><span class="n">filename</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#is_opentype_cff_font"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.is_opentype_cff_font" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the given font is a Postscript Compact Font Format Font
embedded in an OpenType wrapper. Used by the PostScript and PDF backends
that can not subset these fonts.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.json_dump">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">json_dump</code><span class="sig-paren">(</span><em><span class="n">data</span></em>, <em><span class="n">filename</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#json_dump"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.json_dump" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump <a class="reference internal" href="#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> <em>data</em> as JSON to the file named <em>filename</em>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.font_manager.json_load" title="matplotlib.font_manager.json_load"><code class="xref py py-obj docutils literal notranslate"><span class="pre">json_load</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>File paths that are children of the Matplotlib data path (typically, fonts
shipped with Matplotlib) are stored relative to that data path (to remain
valid across virtualenvs).</p>
<p>This function temporarily locks the output file to prevent multiple
processes from overwriting one another's output.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.json_load">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">json_load</code><span class="sig-paren">(</span><em><span class="n">filename</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#json_load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.json_load" title="Permalink to this definition">¶</a></dt>
<dd><p>Load a <a class="reference internal" href="#matplotlib.font_manager.FontManager" title="matplotlib.font_manager.FontManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontManager</span></code></a> from the JSON file named <em>filename</em>.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference internal" href="#matplotlib.font_manager.json_dump" title="matplotlib.font_manager.json_dump"><code class="xref py py-obj docutils literal notranslate"><span class="pre">json_dump</span></code></a></dt><dd></dd>
</dl>
</div>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.list_fonts">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">list_fonts</code><span class="sig-paren">(</span><em><span class="n">directory</span></em>, <em><span class="n">extensions</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#list_fonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.list_fonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of all fonts matching any of the extensions, found
recursively under the directory.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.ttfFontProperty">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">ttfFontProperty</code><span class="sig-paren">(</span><em><span class="n">font</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#ttfFontProperty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.ttfFontProperty" title="Permalink to this definition">¶</a></dt>
<dd><p>Extract information from a TrueType font file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>font</strong><span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FT2Font</span></code></span></dt><dd><p>The TrueType font file from which information will be extracted.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><a class="reference internal" href="#matplotlib.font_manager.FontEntry" title="matplotlib.font_manager.FontEntry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FontEntry</span></code></a></dt><dd><p>The extracted font properties.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.win32FontDirectory">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">win32FontDirectory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#win32FontDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.win32FontDirectory" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the user-specified font directory for Win32. This is
looked up from the registry key</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>\\<span class="n">HKEY_CURRENT_USER</span>\<span class="n">Software</span>\<span class="n">Microsoft</span>\<span class="n">Windows</span>\<span class="n">CurrentVersion</span>\<span class="n">Explorer</span>\<span class="n">Shell</span> <span class="n">Folders</span>\<span class="n">Fonts</span>
</pre></div>
</div>
<p>If the key is not found, <code class="docutils literal notranslate"><span class="pre">%WINDIR%\Fonts</span></code> will be returned.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.font_manager.win32InstalledFonts">
<code class="descclassname">matplotlib.font_manager.</code><code class="descname">win32InstalledFonts</code><span class="sig-paren">(</span><em><span class="n">directory</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">fontext</span><span class="o">=</span><span class="default_value">'ttf'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/font_manager.html#win32InstalledFonts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.font_manager.win32InstalledFonts" title="Permalink to this definition">¶</a></dt>
<dd><p>Search for fonts in the specified font directory, or use the
system directories if none given. Additionally, it is searched for user
fonts installed. A list of TrueType font filenames are returned by default,
or AFM fonts if <em>fontext</em> == 'afm'.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on May 08, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.2-2-gf801f04d09-dirty.
</div>
</footer>
</body>
</html>