Ziafont

https://ziafont.readthedocs.io/en/latest/
Admin
Ziafont is a Python library that reads TrueType/OpenType font files and draws characters and strings...
Tokens:4,775
Snippets:81
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### SVG Output Example

Source: https://ziafont.readthedocs.io/en/latest/index.html

Example of the resulting SVG structure generated by Ziafont.

```xml
<svg xmlns="http://www.w3.org/2000/svg" width="28.406" height="34.266" viewBox="
```

--------------------------------

### Install Ziafont via pip

Source: https://ziafont.readthedocs.io/en/latest/_sources/index.rst.txt

Install the Ziafont package using the Python package manager.

```bash
pip install ziafont
```

--------------------------------

### Render text with Ziafont

Source: https://ziafont.readthedocs.io/en/latest/_sources/index.rst.txt

Load a font file and generate text output using the Ziafont library.

```python
import ziafont
font = ziafont.Font('NotoSerif-Regular.ttf')
font.text('Ziafont!')
```

--------------------------------

### Load a font

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Initialize a font object from a file path or system font name.

```python
import ziafont
font = ziafont.Font('NotoSerif-Regular.ttf')
```

--------------------------------

### Setting Default Font Size

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Configures the global default font size.

```python
ziafont.config.fontsize = 36
```

--------------------------------

### Resetting Configuration

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Resets debug mode and sets a new default font size.

```python
ziafont.config.debug = False
ziafont.config.fontsize = 48
```

--------------------------------

### Render multi-line strings

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Handle multi-line text with alignment and line spacing controls.

```python
font.text('Two\nLines', halign='center', linespacing=.8)
```

--------------------------------

### Configure font features

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Enable or disable OpenType features like stylistic alternatives.

```python
font = ziafont.Font()
font.features
```

```python
font.text('apple')
```

```python
font.features['salt'] = True
font.text('apple')
```

--------------------------------

### Show font feature substitutions

Source: https://ziafont.readthedocs.io/en/latest/_sources/inspect.rst.txt

Use ShowFeature to inspect substitutions applied by specific font features.

```python
ziafont.inspect.ShowFeature('salt', font)
```

--------------------------------

### Enable stylistic alternatives

Source: https://ziafont.readthedocs.io/en/latest/usage.html

Modify the features dictionary to enable specific OpenType font features like stylistic alternatives.

```python
font.text('apple')
```

```python
font.features['salt'] = True
font.text('apple')
```

--------------------------------

### Set font size

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Adjust the text size using the size parameter.

```python
font.text('small', size=12)
```

```python
font.text('large', size=72)
```

--------------------------------

### Retrieve and Render Glyphs

Source: https://ziafont.readthedocs.io/en/latest/usage.html

Methods for obtaining a Glyph object and rendering it as an SVG string or XML element.

```python
font.glyph('D')
```

```python
font.glyph('D').svgxml()
```

```python
<Element 'svg' at 0x7abf09097180>
```

--------------------------------

### Inspect glyph rendering and control points

Source: https://ziafont.readthedocs.io/en/latest/_sources/inspect.rst.txt

Use InspectGlyph to render a glyph and visualize its control points.

```python
ziafont.inspect.InspectGlyph(font.glyph('B'))
```

--------------------------------

### Set text color

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Apply CSS colors using names or hex codes.

```python
font.text('medium slate blue', color='mediumslateblue')
```

--------------------------------

### Aligning Text Vertically

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Demonstrates vertical alignment options including top, center, base, and bottom using the valign parameter.

```python
ziafont.config.fontsize = 16
ziafont.config.debug = True  # Show bounding box and origin
svg = ET.Element('svg')
svg.attrib['xmlns'] = 'http://www.w3.org/2000/svg'
svg.attrib['xmlns:xlink'] = 'http://www.w3.org/1999/xlink'
svg.attrib['width'] = '300'
svg.attrib['height'] = '100'
svg.attrib['viewBox'] = '0 0 300 100'

font.text('align
top', valign='top').drawon(svg, 50, 50)
font.text('align
center', valign='center').drawon(svg, 100, 50)
font.text('align
base', valign='base').drawon(svg, 160, 50)
font.text('align
bottom', valign='bottom').drawon(svg, 210, 50)

SVG(ET.tostring(svg))
```

--------------------------------

### Display glyph table

Source: https://ziafont.readthedocs.io/en/latest/_sources/inspect.rst.txt

Use ShowGlyphs to visualize a table of font glyphs. The nmax parameter limits the number of glyphs displayed.

```python
font = ziafont.Font()
ziafont.inspect.ShowGlyphs(font, nmax=105)
```

--------------------------------

### Toggle kerning

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Enable or disable GPOS-based kerning adjustments.

```python
font = ziafont.Font()
font.features['kern'] = False
font.text('Type')
```

```python
font.features['kern'] = True
font.text('Type')
```

--------------------------------

### Describe font metadata

Source: https://ziafont.readthedocs.io/en/latest/_sources/inspect.rst.txt

Use DescribeFont to display comprehensive metadata about the font object.

```python
ziafont.inspect.DescribeFont(font)
```

--------------------------------

### Accessing Glyphs

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Retrieves glyph objects and their SVG representations.

```python
font.glyph('D')
```

```python
font.glyph('D').svgxml()
```

--------------------------------

### ziafont.inspect.DescribeFont

Source: https://ziafont.readthedocs.io/en/latest/inspect.html

Retrieves metadata and information about a font object.

```APIDOC
## ziafont.inspect.DescribeFont(font)

### Description
Returns metadata about the provided font object, such as font name, family, subfamily, and manufacturer information.

### Usage
```python
ziafont.inspect.DescribeFont(font)
```
```

--------------------------------

### Toggle ligatures

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Enable or disable GSUB-based ligature substitution.

```python
font.features['liga'] = False
font.text('waffle')
```

```python
font.features['liga'] = True
font.text('waffle')
```

--------------------------------

### Render text as SVG

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Convert strings to SVG objects for display or export.

```python
font.text('Example')
```

```python
s = font.text('Example').svg()
print(s[:80])  # Just show 80 characters here...
```

```python
font.text('Example').svgxml()
```

--------------------------------

### ziafont.inspect.InspectGlyph

Source: https://ziafont.readthedocs.io/en/latest/inspect.html

Provides a detailed rendering of a glyph and its control points.

```APIDOC
## ziafont.inspect.InspectGlyph(glyph)

### Description
Generates a detailed inspection view of a glyph, including its visual rendering and the underlying control points.

### Usage
```python
ziafont.inspect.InspectGlyph(font.glyph('B'))
```
```

--------------------------------

### Describe a specific glyph

Source: https://ziafont.readthedocs.io/en/latest/_sources/inspect.rst.txt

Use DescribeGlyph to retrieve detailed information about a specific glyph object.

```python
ziafont.inspect.DescribeGlyph(font.glyph('B'))
```

--------------------------------

### Retrieving Glyph Indexes

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Obtains the index of a character or retrieves a glyph by its ID.

```python
font.glyphindex('&')
```

```python
font.glyph_fromid(9)
```

--------------------------------

### Access Glyph Indexes

Source: https://ziafont.readthedocs.io/en/latest/usage.html

Retrieve the font-specific index for a character and reconstruct a glyph from that index.

```python
font.glyphindex('&')
```

```python
9
```

```python
font.glyph_fromid(9)
```

--------------------------------

### Configuring SVG Compatibility

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Disables SVG 2.0 features for better compatibility with older renderers.

```python
ziafont.config.svg2 = False
```

--------------------------------

### Calculating String Size

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Calculates the pixel dimensions of a string without rendering it.

```python
font.text('How wide is this string?').getsize()
```

--------------------------------

### ziafont.font.Text

Source: https://ziafont.readthedocs.io/en/latest/api.html

Class to draw text as SVG paths.

```APIDOC
## class ziafont.font.Text(s, font=None, size=None, linespacing=1, halign='left', valign='base', color=None, rotation=0, rotation_mode='anchor')

### Description
Draw text as SVG paths.

### Parameters
- **s** (str | Sequence[int]) - Required - String to draw.
- **font** (str | Font | None) - Optional - Font name or ziafont.Font to use.
- **size** (float | None) - Optional - Font size in points.
- **linespacing** (float) - Optional - Spacing between lines.
- **halign** (Literal['left', 'center', 'right']) - Optional - Horizontal Alignment.
- **valign** (Literal['base', 'center', 'top']) - Optional - Vertical Alignment.
- **color** (str | None) - Optional - Color for string.
- **rotation** (float) - Optional - Rotation angle in degrees.
- **rotation_mode** (str) - Optional - Either 'default' or 'anchor'.
```

--------------------------------

### Draw on existing SVG

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Render text onto an existing XML ElementTree SVG structure.

```python
from IPython.display import SVG
from xml.etree import ElementTree as ET

svg = ET.Element('svg')
svg.set('width', '100')
svg.set('height', '50')
svg.set('xmlns', 'http://www.w3.org/2000/svg')
svg.set('viewBox', '0 0 100 50')
circ = ET.SubElement(svg, 'circle')
circ.set('cx', '50')
circ.set('cy', '25')
circ.set('r', '25')
circ.set('fill', 'orange')

font.text('Hello', size=18).drawon(svg, 50, 25)
font.text('123', size=14).drawon(svg, 75, 40)

SVG(ET.tostring(svg))
```

--------------------------------

### Access font features

Source: https://ziafont.readthedocs.io/en/latest/usage.html

The features attribute lists available OpenType features and their current enabled status.

```python
font = ziafont.Font()
font.features
```

```python
{'kern': True,
 'aalt': False,
 'case': False,
 'dlig': False,
 'hlig': False,
 'liga': True,
 'salt': False}
```

--------------------------------

### ziafont.inspect.DescribeGlyph

Source: https://ziafont.readthedocs.io/en/latest/inspect.html

Retrieves descriptive metadata for a specific glyph, such as Unicode value, character representation, and bounding box metrics.

```APIDOC
## ziafont.inspect.DescribeGlyph(glyph)

### Description
Returns metadata for a given glyph object, including its Unicode index, character mapping, and coordinate bounds (xmin, xmax, ymin, ymax) and advance width.

### Usage
```python
ziafont.inspect.DescribeGlyph(font.glyph('B'))
```
```

--------------------------------

### Generate SVG path for a character

Source: https://ziafont.readthedocs.io/en/latest/_sources/index.rst.txt

Convert a character into an SVG path string.

```python
s = font.text('Z').svg()
print(s[:80])  # Just show 80 characters here...
```

--------------------------------

### Configure text alignment on SVG

Source: https://ziafont.readthedocs.io/en/latest/usage.html

Apply valign parameters to control vertical text positioning relative to the baseline or block boundaries. Debug mode can be enabled to visualize bounding boxes and origins.

```python
ziafont.config.fontsize = 16
ziafont.config.debug = True  # Show bounding box and origin
svg = ET.Element('svg')
svg.attrib['xmlns'] = 'http://www.w3.org/2000/svg'
svg.attrib['xmlns:xlink'] = 'http://www.w3.org/1999/xlink'
svg.attrib['width'] = '300'
svg.attrib['height'] = '100'
svg.attrib['viewBox'] = '0 0 300 100'

font.text('align\ntop', valign='top').drawon(svg, 50, 50)
font.text('align\ncenter', valign='center').drawon(svg, 100, 50)
font.text('align\nbase', valign='base').drawon(svg, 160, 50)
font.text('align\nbottom', valign='bottom').drawon(svg, 210, 50)

SVG(ET.tostring(svg))
```

--------------------------------

### Adjusting SVG Decimal Precision

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Sets the coordinate precision for SVG output to balance file size and image quality.

```python
ziafont.config.precision = 6
# ...
```

```python
print('...', font.text('A').svg()[252:326])
```

```python
ziafont.config.precision = 2
# ...
```

```python
print('...', font.text('A').svg()[228:276])
```

--------------------------------

### ziafont.font.Font

Source: https://ziafont.readthedocs.io/en/latest/api.html

Class to read/parse an OpenType/TTF font and write glyphs to SVG.

```APIDOC
## class ziafont.font.Font(name=None, searchpaths=None)

### Description
Class to read/parse an OpenType/TTF font and write glyphs to SVG.

### Parameters
- **name** (str | Path | None) - Optional - File name of the font. Defaults to DejaVuSans.
- **searchpaths** (Sequence[str | Path] | None) - Optional - Paths to search for font files.
```

--------------------------------

### Rotate text

Source: https://ziafont.readthedocs.io/en/latest/_sources/usage.rst.txt

Rotate text by a specified angle in degrees.

```python
font.text('Rotated', rotation=30)
```
Tokens:
Raw