matplotlib.github.com/1.4.0/api/afm_api.html at main · matplotlib/matplotlib.github.com

History

328 lines (281 loc) · 18.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

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

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

<head>

<title>afm (Adobe Font Metrics interface) — Matplotlib 1.4.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.4.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.4.0 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v1.4.0). 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>

</map>

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

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

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

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

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

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

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

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

</ul>

</div>

<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"><tt class="docutils literal">matplotlib.afm</tt></a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<a href="matplotlib_configuration_api.html"

title="previous chapter">The top level <tt class="docutils literal">matplotlib</tt> module</a>

<h4>Next topic</h4>

<a href="animation_api.html"

title="next chapter">animation</a>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</div>

</div>

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

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

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:

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

</ol>

</div></blockquote>

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

<div class="highlight-python"><div class="highlight"><pre>>>> from matplotlib import rcParams

>>> import os.path

>>> afm_fname = os.path.join(rcParams['datapath'],

... 'fonts', 'afm', 'ptmr8a.afm')

>>>

>>> from matplotlib.afm import AFM

>>> afm = AFM(open(afm_fname))

>>> afm.string_width_height('What the heck?')

(6220.0, 694)

>>> afm.get_fontname()

'Times-Roman'

>>> afm.get_kern_dist('A', 'f')

0

-92.0

>>> afm.get_bbox_char('!')

[130, -9, 238, 676]

</pre></div>

</div>

class <tt class="descclassname">matplotlib.afm.</tt><tt class="descname">AFM</tt>(fh)<a class="headerlink" href="#matplotlib.afm.AFM" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <tt class="xref py py-class docutils literal">object</tt>

Parse the AFM file in file object fh

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

<dd>Return the fontangle as float

</dd></dl>

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

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

<dd>Return the cap height as float

</dd></dl>

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

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

</dd></dl>

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

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

</dd></dl>

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

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

</dd></dl>

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

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

is the ink height (space is 0)

</dd></dl>

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

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

not specified in AFM file.

</dd></dl>

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

and c2

</dd></dl>

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

name1 and name2

</dd></dl>

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

<dd>Get the name of the character, ie, ‘;’ is ‘semicolon’

</dd></dl>

<dd>Return the string bounding box

</dd></dl>

<tt class="descname">get_str_bbox_and_descent</tt>(s)<a class="headerlink" href="#matplotlib.afm.AFM.get_str_bbox_and_descent" title="Permalink to this definition">¶</a></dt>

<dd>Return the string bounding box

</dd></dl>

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

<dd>Return the underline thickness as float

</dd></dl>

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

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

not specified in AFM file.

</dd></dl>

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

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

</dd></dl>

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

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

field

</dd></dl>

<tt class="descname">get_width_from_char_name</tt>(name)<a class="headerlink" href="#matplotlib.afm.AFM.get_width_from_char_name" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

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

<dd>Return the xheight as float

</dd></dl>

<tt class="descname">string_width_height</tt>(s)<a class="headerlink" href="#matplotlib.afm.AFM.string_width_height" title="Permalink to this definition">¶</a></dt>

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

as a (w, h) tuple.

</dd></dl>

<tt class="descclassname">matplotlib.afm.</tt><tt class="descname">parse_afm</tt>(fh)<a class="headerlink" href="#matplotlib.afm.parse_afm" title="Permalink to this definition">¶</a></dt>

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

is a (dhead, dcmetrics, dkernpairs, dcomposite) tuple where

dhead is a <tt class="xref py py-func docutils literal">_parse_header()</tt> dict, dcmetrics is a

<tt class="xref py py-func docutils literal">_parse_composites()</tt> dict, dkernpairs is a

<tt class="xref py py-func docutils literal">_parse_kern_pairs()</tt> dict (possibly {}), and dcomposite is a

<tt class="xref py py-func docutils literal">_parse_composites()</tt> dict (possibly {})

</dd></dl>

</div>

</div>

Last updated on Sep 02, 2014.

Created using <a

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

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

afm_api.html

Latest commit

History

afm_api.html

File metadata and controls