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

History

368 lines (316 loc) · 25.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

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

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

<head>

<title>matplotlib.afm — Matplotlib 3.4.3 documentation</title>

title="Search within Matplotlib 3.4.3 documentation"

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

</head><body>

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

-->

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

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

</div>

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

</form>

</li>

</ul>

</nav>

<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="matplotlib.animation"

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

<a href="matplotlib_configuration_api.html" title="matplotlib"

accesskey="P">previous</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">matplotlib.afm</code></a></li>

</ul>

</div>

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

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

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

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

</div>

<h1><code class="docutils literal notranslate">matplotlib.afm</code><a class="headerlink" href="#module-matplotlib.afm" title="Permalink to this headline">¶</a></h1>

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>

It is pretty easy to use, and has no external dependencies:

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import matplotlib as mpl

>>> from pathlib import Path

>>> afm_path = Path(mpl.get_data_path(), 'fonts', 'afm', 'ptmr8a.afm')

>>>

>>> from matplotlib.afm import AFM

>>> with afm_path.open('rb') as fh:

... afm = AFM(fh)

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

As in the Adobe Font Metrics File Format Specification, all dimensions

are given in units of 1/1000 of the scale factor (point size) of the font

being used.

class <code class="descclassname">matplotlib.afm.</code><code class="descname">AFM</code>(fh)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM" title="Permalink to this definition">¶</a></dt>

<dd>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">object</code></a>

Parse the AFM file in file object fh.

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

<dd>The font family name, e.g., 'Times'.

</dd></dl>

<code class="descname">get_angle</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_angle">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_angle" title="Permalink to this definition">¶</a></dt>

<dd>Return the fontangle as float.

</dd></dl>

<code class="descname">get_bbox_char</code>(c, isord=False)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_bbox_char">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_bbox_char" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_capheight</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_capheight">[source]</a><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>

<code class="descname">get_familyname</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_familyname">[source]</a><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>

<code class="descname">get_fontname</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_fontname">[source]</a><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>

<code class="descname">get_fullname</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_fullname">[source]</a><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>

<code class="descname">get_height_char</code>(c, isord=False)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_height_char">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_height_char" title="Permalink to this definition">¶</a></dt>

<dd>Get the bounding box (ink) height of character c (space is 0).

</dd></dl>

<code class="descname">get_horizontal_stem_width</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_horizontal_stem_width">[source]</a><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>

<code class="descname">get_kern_dist</code>(c1, c2)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_kern_dist">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_kern_dist" title="Permalink to this definition">¶</a></dt>

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

</dd></dl>

<code class="descname">get_kern_dist_from_name</code>(name1, name2)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_kern_dist_from_name">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_kern_dist_from_name" title="Permalink to this definition">¶</a></dt>

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

name1 and name2.

</dd></dl>

<code class="descname">get_name_char</code>(c, isord=False)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_name_char">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_name_char" title="Permalink to this definition">¶</a></dt>

<dd>Get the name of the character, i.e., ';' is 'semicolon'.

</dd></dl>

<code class="descname">get_str_bbox</code>(s)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_str_bbox">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_str_bbox" title="Permalink to this definition">¶</a></dt>

<dd>Return the string bounding box.

</dd></dl>

<code class="descname">get_str_bbox_and_descent</code>(s)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_str_bbox_and_descent">[source]</a><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 and the maximal descent.

</dd></dl>

<code class="descname">get_underline_thickness</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_underline_thickness">[source]</a><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>

<code class="descname">get_vertical_stem_width</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_vertical_stem_width">[source]</a><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>

<code class="descname">get_weight</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_weight">[source]</a><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>

<code class="descname">get_width_char</code>(c, isord=False)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_width_char">[source]</a><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>

<code class="descname">get_width_from_char_name</code>(name)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_width_from_char_name">[source]</a><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>

<code class="descname">get_xheight</code>()<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.get_xheight">[source]</a><a class="headerlink" href="#matplotlib.afm.AFM.get_xheight" title="Permalink to this definition">¶</a></dt>

<dd>Return the xheight as float.

</dd></dl>

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

<code class="descname">string_width_height</code>(s)<a class="reference internal" href="../_modules/matplotlib/afm.html#AFM.string_width_height">[source]</a><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>

class <code class="descclassname">matplotlib.afm.</code><code class="descname">CharMetrics</code>(width, name, bbox)<a class="headerlink" href="#matplotlib.afm.CharMetrics" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">tuple</code></a>

Represents the character metrics of a single character.

Notes

The fields do currently only describe a subset of character metrics

information defined in the AFM standard.

Create new instance of CharMetrics(width, name, bbox)

<dd>The bbox of the character (B) as a tuple (llx, lly, urx, ury).

</dd></dl>

<dd>The character name (N).

</dd></dl>

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

<dd>The character width (WX).

</dd></dl>

class <code class="descclassname">matplotlib.afm.</code><code class="descname">CompositePart</code>(name, dx, dy)<a class="headerlink" href="#matplotlib.afm.CompositePart" title="Permalink to this definition">¶</a></dt>

Represents the information on a composite element of a composite char.

Create new instance of CompositePart(name, dx, dy)

<dd>x-displacement of the part from the origin.

</dd></dl>

<dd>y-displacement of the part from the origin.

</dd></dl>

<dd>Name of the part, e.g. 'acute'.

</dd></dl>

</div>

</div>

Last updated on Aug 13, 2021.

Created using

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

Doc version v3.4.3-2-ge48e4acce0.

</div>

</footer>

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