Simple lettering

The <simple_lettering> element defines the core lettering parameters, including text content, font (alphabet), size, style (bold/italic), spacing, alignment, and baseline shape.

XML structure

<simple_lettering

text="Lettering 1" 

alphabet_name="London" 

height="20.0" 

bold="false" 

italic="false" 

word_spacing="0.6" 

justification="centre" 

baseline="horizontal" 

baseline_radius="50.0" 

baseline_length="100.0" 

auto_fit_mode="spacing" 

Attributes

Attribute
Purpose
text
The lettering text. May contain multiple lines.
alphabet_name
Embroidery font face (alphabet) name. Must match an alphabet installed with the API.
height
Lettering height in mm (5.0–50.0).
bold
True or false. Makes text bold.
italic
True or false. Makes text italic.
word_spacing
Word spacing as a ratio of height – e.g. 0.6 = 60% of height.
justification
For multi-line text: left, right, centre, or fit (fully justified).
baseline
Defines the text path. Options: horizontal, vertical, circle_cw (circle clockwise), circle_ccw (circle counter-clockwise), horizontal_fixed, vertical_fixed.
baseline_radius
Circle radius in mm (20–1000). Used only for circular baselines.
baseline_length
Length in mm (20–1000). Used for fixed baselines to constrain lettering width/height.
auto_fit_mode
How lettering fits the fixed baseline:
spacing – adjusts spacing only
letter – reduces letter width/height only
letter_prop – proportionally reduces letter width/height
whole – adjusts spacing and letter width/height
whole_prop – proportionally adjusts all

Remarks

Fixed baselines (horizontal_fixed, vertical_fixed) use baseline_length and auto_fit_mode to constrain size.
Circle baselines use baseline_radius.
For standard horizontal/vertical baselines, text size is flexible.

This allows precise control of embroidery text shape, alignment, and size.

Example

<simple_lettering

text="Custom Text"

alphabet_name="London"

height="30.0"

bold="true"

italic="false"

word_spacing="0.5"

justification="centre"

baseline="circle_cw"

baseline_radius="80.0"

Attribute	Purpose
text	The lettering text. May contain multiple lines.
alphabet_name	Embroidery font face (alphabet) name. Must match an alphabet installed with the API.
height	Lettering height in mm (5.0–50.0).
bold	True or false. Makes text bold.
italic	True or false. Makes text italic.
word_spacing	Word spacing as a ratio of height – e.g. 0.6 = 60% of height.
justification	For multi-line text: left, right, centre, or fit (fully justified).
baseline	Defines the text path. Options: horizontal, vertical, circle_cw (circle clockwise), circle_ccw (circle counter-clockwise), horizontal_fixed, vertical_fixed.
baseline_radius	Circle radius in mm (20–1000). Used only for circular baselines.
baseline_length	Length in mm (20–1000). Used for fixed baselines to constrain lettering width/height.
auto_fit_mode	How lettering fits the fixed baseline: spacing – adjusts spacing only letter – reduces letter width/height only letter_prop – proportionally reduces letter width/height whole – adjusts spacing and letter width/height whole_prop – proportionally adjusts all

Simple lettering

Simple lettering

XML structure

Attributes

Remarks

Example

Related topics