matplotlib._afm#

A python interface to Adobe Font Metrics Files.

Although a number of other Python implementations exist, and may be morecomplete than this, it was decided not to go with them because they wereeither:

  1. copyrighted or used a non-BSD compatible license

  2. had too many dependencies and a free standing lib was needed

  3. did more than needed and it was easier to write afresh rather thanfigure out how to get just what was needed.

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

>>>importmatplotlibasmpl>>>frompathlibimportPath>>>afm_path=Path(mpl.get_data_path(),'fonts','afm','ptmr8a.afm')>>>>>>frommatplotlib.afmimportAFM>>>withafm_path.open('rb')asfh:...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>>>afm.get_kern_dist('A','y')-92.0>>>afm.get_bbox_char('!')[130, -9, 238, 676]

As in the Adobe Font Metrics File Format Specification, all dimensionsare given in units of 1/1000 of the scale factor (point size) of the fontbeing used.

classmatplotlib._afm.AFM(fh)[source]#

Bases:object

Parse the AFM file in file objectfh.

propertyfamily_name#

The font family name, e.g., 'Times'.

get_angle()[source]#

Return the fontangle as float.

get_bbox_char(c,isord=False)[source]#
get_capheight()[source]#

Return the cap height as float.

get_familyname()[source]#

Return the font family name, e.g., 'Times'.

get_fontname()[source]#

Return the font name, e.g., 'Times-Roman'.

get_fullname()[source]#

Return the font full name, e.g., 'Times-Roman'.

get_height_char(c,isord=False)[source]#

Get the bounding box (ink) height of characterc (space is 0).

get_horizontal_stem_width()[source]#

Return the standard horizontal stem width as float, orNone ifnot specified in AFM file.

get_kern_dist(c1,c2)[source]#

Return the kerning pair distance (possibly 0) for charsc1 andc2.

get_kern_dist_from_name(name1,name2)[source]#

Return the kerning pair distance (possibly 0) for charsname1 andname2.

get_name_char(c,isord=False)[source]#

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

get_str_bbox(s)[source]#

Return the string bounding box.

get_str_bbox_and_descent(s)[source]#

Return the string bounding box and the maximal descent.

get_underline_thickness()[source]#

Return the underline thickness as float.

get_vertical_stem_width()[source]#

Return the standard vertical stem width as float, orNone ifnot specified in AFM file.

get_weight()[source]#

Return the font weight, e.g., 'Bold' or 'Roman'.

get_width_char(c,isord=False)[source]#

Get the width of the character from the character metric WX field.

get_width_from_char_name(name)[source]#

Get the width of the character from a type1 character name.

get_xheight()[source]#

Return the xheight as float.

propertypostscript_name#
string_width_height(s)[source]#

Return the string width (including kerning) and string heightas a (w,h) tuple.

classmatplotlib._afm.CharMetrics(width,name,bbox)[source]#

Bases:tuple

Represents the character metrics of a single character.

Notes

The fields do currently only describe a subset of character metricsinformation defined in the AFM standard.

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

bbox#

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

name#

The character name (N).

width#

The character width (WX).

classmatplotlib._afm.CompositePart(name,dx,dy)[source]#

Bases:tuple

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

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

dx#

x-displacement of the part from the origin.

dy#

y-displacement of the part from the origin.

name#

Name of the part, e.g. 'acute'.