<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>afm (Adobe Font Metrics interface) &mdash; Matplotlib 2.1.2 documentation</title>

<link rel="stylesheet" href="../_static/mpl.css"

type="text/css" />

<link rel="stylesheet" href="../_static/pygments.css"

type="text/css" />

<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />

<script type="text/javascript">

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.1.2',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

<script type="text/javascript" src="../_static/jquery.js"></script>

<script type="text/javascript" src="../_static/underscore.js"></script>

<script type="text/javascript" src="../_static/doctools.js"></script>

<link rel="search" type="application/opensearchdescription+xml"

title="Search within Matplotlib 2.1.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="top" title="Matplotlib 2.1.2 documentation" href="../index.html" />

<link rel="up" title="The Matplotlib API" href="index.html" />

<link rel="next" title="animation module" href="animation_api.html" />

<link rel="prev" title="The top level matplotlib module" href="matplotlib_configuration_api.html" />

<link rel="canonical" href="https://matplotlib.org/stable/api/afm_api.html" />

<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 (v2.1.2). For the latest version see <a href="https://matplotlib.org/stable/api/afm_api.html">https://matplotlib.org/stable/api/afm_api.html</a></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 2.1.2</span></div>

<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>

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

<div class="related">

<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="animation_api.html" title="animation module"

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

<li class="right" >

<a href="matplotlib_configuration_api.html" title="The top level matplotlib module"

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

<li><a href="../index.html">home</a>|&nbsp;</li>

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

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

<li><a href="pyplot_summary.html">pyplot</a>|&nbsp;</li>

<li><a href="../contents.html">docs</a> &raquo;</li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> &raquo;</li>

</ul>

</div>

<div class="sphinxsidebar">

<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">

<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&amp;colorA=E1523D&amp;colorB=007D8A">

<a href="http://depsy.org/package/python/matplotlib">

<img src="../_static/depsy_badge.svg">

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>

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

<ul>

<li><a class="reference internal" href="#">afm (Adobe Font Metrics interface)</a><ul>

<li><a class="reference internal" href="#module-matplotlib.afm"><code class="docutils literal"><span class="pre">matplotlib.afm</span></code></a></li>

<div class="relations">

<h3>Related Topics</h3>

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

<li><a href="index.html">The Matplotlib API</a><ul>

<li>Previous: <a href="matplotlib_configuration_api.html" title="previous chapter">The top level <code class="docutils literal"><span class="pre">matplotlib</span></code> module</a></li>

<li>Next: <a href="animation_api.html" title="next chapter"><code class="docutils literal"><span class="pre">animation</span></code> module</a></li>

</ul></li>

</ul></li>

<div role="note" aria-label="source link">

<h3>This Page</h3>

<ul class="this-page-menu">

<li><a href="../_sources/api/afm_api.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<div id="searchbox" style="display: none" role="search">

<h3>Quick search</h3>

<form class="search" action="../search.html" method="get">

<div><input type="text" name="q" /></div>

<div><input type="submit" value="Go" /></div>

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

<script type="text/javascript">$('#searchbox').show(0);</script>

</div>

</div>

<div class="document">

<div class="documentwrapper">

<div class="bodywrapper">

<div class="body">

<div class="section" id="afm-adobe-font-metrics-interface">

<h1>afm (Adobe Font Metrics interface)<a class="headerlink" href="#afm-adobe-font-metrics-interface" title="Permalink to this headline">¶</a></h1>

<div class="section" id="module-matplotlib.afm">

<span id="matplotlib-afm"></span><h2><a class="reference internal" href="#module-matplotlib.afm" title="matplotlib.afm"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.afm</span></code></a><a class="headerlink" href="#module-matplotlib.afm" title="Permalink to this headline">¶</a></h2>

<p>This is a python interface to Adobe Font Metrics Files. Although a

number of other python implementations exist, and may be more complete

than this, it was decided not to go with them because they were

either:</p>

<div><ol class="arabic simple">

<li>copyrighted or used a non-BSD compatible license</li>

<li>had too many dependencies and a free standing lib was needed</li>

<li>Did more than needed and it was easier to write afresh rather than

figure out how to get just what was needed.</li>

<p>It is pretty easy to use, and requires only built-in python libs:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">matplotlib</span> <span class="k">import</span> <span class="n">rcParams</span>

<span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">os.path</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">afm_fname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">&#39;datapath&#39;</span><span class="p">],</span>

<span class="gp">... </span> <span class="s1">&#39;fonts&#39;</span><span class="p">,</span> <span class="s1">&#39;afm&#39;</span><span class="p">,</span> <span class="s1">&#39;ptmr8a.afm&#39;</span><span class="p">)</span>

<span class="go">&gt;&gt;&gt;</span>

<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">matplotlib.afm</span> <span class="k">import</span> <span class="n">AFM</span>

<span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">afm_fname</span><span class="p">)</span> <span class="k">as</span> <span class="n">fh</span><span class="p">:</span>

<span class="gp">... </span> <span class="n">afm</span> <span class="o">=</span> <span class="n">AFM</span><span class="p">(</span><span class="n">fh</span><span class="p">)</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">afm</span><span class="o">.</span><span class="n">string_width_height</span><span class="p">(</span><span class="s1">&#39;What the heck?&#39;</span><span class="p">)</span>

<span class="go">(6220.0, 694)</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">afm</span><span class="o">.</span><span class="n">get_fontname</span><span class="p">()</span>

<span class="go">&#39;Times-Roman&#39;</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">afm</span><span class="o">.</span><span class="n">get_kern_dist</span><span class="p">(</span><span class="s1">&#39;A&#39;</span><span class="p">,</span> <span class="s1">&#39;f&#39;</span><span class="p">)</span>

<span class="go">0</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">afm</span><span class="o">.</span><span class="n">get_kern_dist</span><span class="p">(</span><span class="s1">&#39;A&#39;</span><span class="p">,</span> <span class="s1">&#39;y&#39;</span><span class="p">)</span>

<span class="go">-92.0</span>

<span class="gp">&gt;&gt;&gt; </span><span class="n">afm</span><span class="o">.</span><span class="n">get_bbox_char</span><span class="p">(</span><span class="s1">&#39;!&#39;</span><span class="p">)</span>

<span class="go">[130, -9, 238, 676]</span>

<dl class="class">

<dt id="matplotlib.afm.AFM">

<em class="property">class </em><code class="descclassname">matplotlib.afm.</code><code class="descname">AFM</code><span class="sig-paren">(</span><em>fh</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM" 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.6)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>

<p>Parse the AFM file in file object <em>fh</em></p>

<dl class="attribute">

<dt id="matplotlib.afm.AFM.family_name">

<code class="descname">family_name</code><a class="headerlink" href="#matplotlib.afm.AFM.family_name" title="Permalink to this definition">¶</a></dt>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_angle">

<code class="descname">get_angle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_angle" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the fontangle as float</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_bbox_char">

<code class="descname">get_bbox_char</code><span class="sig-paren">(</span><em>c</em>, <em>isord=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_bbox_char" title="Permalink to this definition">¶</a></dt>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_capheight">

<code class="descname">get_capheight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_capheight" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the cap height as float</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_familyname">

<code class="descname">get_familyname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_familyname" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the font family name, e.g., ‘Times’</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_fontname">

<code class="descname">get_fontname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_fontname" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the font name, e.g., ‘Times-Roman’</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_fullname">

<code class="descname">get_fullname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_fullname" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the font full name, e.g., ‘Times-Roman’</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_height_char">

<code class="descname">get_height_char</code><span class="sig-paren">(</span><em>c</em>, <em>isord=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_height_char" title="Permalink to this definition">¶</a></dt>

<dd><p>Get the height of character <em>c</em> from the bounding box. This

is the ink height (space is 0)</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_horizontal_stem_width">

<code class="descname">get_horizontal_stem_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_horizontal_stem_width" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the standard horizontal stem width as float, or <em>None</em> if

not specified in AFM file.</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_kern_dist">

<code class="descname">get_kern_dist</code><span class="sig-paren">(</span><em>c1</em>, <em>c2</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_kern_dist" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the kerning pair distance (possibly 0) for chars <em>c1</em>

and <em>c2</em></p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_kern_dist_from_name">

<code class="descname">get_kern_dist_from_name</code><span class="sig-paren">(</span><em>name1</em>, <em>name2</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_kern_dist_from_name" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the kerning pair distance (possibly 0) for chars

<em>name1</em> and <em>name2</em></p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_name_char">

<code class="descname">get_name_char</code><span class="sig-paren">(</span><em>c</em>, <em>isord=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_name_char" title="Permalink to this definition">¶</a></dt>

<dd><p>Get the name of the character, i.e., ‘;’ is ‘semicolon’</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_str_bbox">

<code class="descname">get_str_bbox</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_str_bbox" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the string bounding box</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_str_bbox_and_descent">

<code class="descname">get_str_bbox_and_descent</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_str_bbox_and_descent" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the string bounding box</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_underline_thickness">

<code class="descname">get_underline_thickness</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_underline_thickness" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the underline thickness as float</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_vertical_stem_width">

<code class="descname">get_vertical_stem_width</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_vertical_stem_width" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the standard vertical stem width as float, or <em>None</em> if

not specified in AFM file.</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_weight">

<code class="descname">get_weight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_weight" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the font weight, e.g., ‘Bold’ or ‘Roman’</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_width_char">

<code class="descname">get_width_char</code><span class="sig-paren">(</span><em>c</em>, <em>isord=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_width_char" title="Permalink to this definition">¶</a></dt>

<dd><p>Get the width of the character from the character metric WX

field</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_width_from_char_name">

<code class="descname">get_width_from_char_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_width_from_char_name" title="Permalink to this definition">¶</a></dt>

<dd><p>Get the width of the character from a type1 character name</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.get_xheight">

<code class="descname">get_xheight</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.get_xheight" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the xheight as float</p>

<dl class="method">

<dt id="matplotlib.afm.AFM.string_width_height">

<code class="descname">string_width_height</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.AFM.string_width_height" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the string width (including kerning) and string height

as a (<em>w</em>, <em>h</em>) tuple.</p>

<dl class="function">

<dt id="matplotlib.afm.parse_afm">

<code class="descclassname">matplotlib.afm.</code><code class="descname">parse_afm</code><span class="sig-paren">(</span><em>fh</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.afm.parse_afm" title="Permalink to this definition">¶</a></dt>

<dd><p>Parse the Adobe Font Metics file in file handle <em>fh</em>. Return value

is a (<em>dhead</em>, <em>dcmetrics_ascii</em>, <em>dmetrics_name</em>, <em>dkernpairs</em>,

<em>dcomposite</em>) tuple where

<em>dhead</em> is a <code class="xref py py-func docutils literal"><span class="pre">_parse_header()</span></code> dict,

<em>dcmetrics_ascii</em> and <em>dcmetrics_name</em> are the two resulting dicts

from <code class="xref py py-func docutils literal"><span class="pre">_parse_char_metrics()</span></code>,

<em>dkernpairs</em> is a <code class="xref py py-func docutils literal"><span class="pre">_parse_kern_pairs()</span></code> dict (possibly {}) and

<em>dcomposite</em> is a <code class="xref py py-func docutils literal"><span class="pre">_parse_composites()</span></code> dict (possibly {})</p>

</div>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="footer">

&copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team.

Last updated on Feb 08, 2018.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.

</div>