Lettering objects

Lettering objects

The lettering_objects element lets you modify existing lettering objects inside a design. Use it with editDesign or editDesignTrueview APIs. You can check if a design has lettering objects via designInfo or designTrueview.

XML structure

<lettering_objects>				
   <lettering_object index="0">		
      <simple_lettering ... />	<!-- Optional: modify lettering parameters -->
      <thread ... />		<!-- Optional: modify lettering color -->
   </lettering_object>
   <lettering_object index="n">		
      <simple_lettering ... />			
      <thread ... />				
   </lettering_object>
</lettering_objects>

Usage

Each <lettering_object> targets one lettering object in the design:
  1. index → the zero-based index of the lettering object to edit.
  2. You can change:
    1. Text (text)
    2. Font (alphabet_name)
    3. Height
    4. Bold setting
    5. Italic setting
    6. Thread color
  3. Multiple <lettering_object> edits can be done in one request.
  4. Only supplied parameters are changed. For example, change just the text, or just the color, or both.
  5. The thread tag lets you change the lettering color.

Examples

✅ Change the color of the first lettering object:

<lettering_objects>
      <lettering_object index="0">
            <thread color="32768" code="xx" brand="xx" description="xx" />
      </lettering_object>
</lettering_objects>

✅ Change the text of the first lettering object:

<lettering_objects>
      <lettering_object index="0">
            <simple_lettering text="New Name"/>
      </lettering_object>
</lettering_objects>

✅ Change text and alphabet of first object; text and color of second object:

<lettering_objects>
      <lettering_object index="0">
            <simple_lettering text="John" alphabet_name="Agatha"/>
      </lettering_object>
      <lettering_object index="1">
            <simple_lettering text="Smith"/>
            <thread color="32768" code="xx" brand="xx" description="xx" />
      </lettering_object>
</lettering_objects>

Remarks

✔️ The font used must be supported by EWA:
  1. If you change alphabet_name, the new font must be valid.
  2. If you only change other attributes, the original font must be valid.

✔️ Thread colors:
  1. If the color already exists in the design’s palette, it’s reused.
  2. If not, the API adds it with the supplied details.
✔️ Multiple colorways:
  1. If the design has more than one, the edit only applies to the appointed colorway (if specified) or the current one.


    • Related Articles

    • Creating production-ready embroidery lettering

      When selling decorated garments online, it’s not enough to simply let customers type in text and place it on a shirt. Unlike printing, embroidery requires fabric-specific settings to produce good stitch quality. The same lettering will need different ...

    • Reducing the number of trims for lettering

      Symptom: You have found that there are too many trims between letters when stitching on your machine. Solution: If the lettering part in the emb file is the lettering object, then you need to adjust Connectors parameter for the lettering object. This ...

    • EWA API capabilities

      Wilcom’s Embroidery Web API (EWA) provides a RESTful interface for integrating advanced embroidery capabilities into web and cloud-based applications. The API exposes functionality for rendering, modifying, and generating embroidery designs using ...

    • Use case: golf club personalized garments

      A golf club wants to let members order embroidered polo shirts and other merchandise, personalized with their own names (or names of family and friends). Step 1: Design preparation in EmbroideryStudio In Wilcom EmbroideryStudio, create a lettering ...

    • Embroidery fonts vs printing fonts

      This article is for Embroidery Web API customers and developers, especially those with a printing or graphics background. In printing, fonts are just shapes – easy to scale, resize, or modify because they are made of vectors and pixels. Embroidery is ...