Design information

The <design_info> XML element provides detailed metadata about an embroidery design, including machine settings, dimensions, colorways, stops, and optional lettering or monogram objects. This structure is returned by several API functions to describe the generated or analyzed design.

---

XML structure

<design_info

  machine_name="Melco"            <!-- Embroidery machine format -->

  num_stitches="49569"              <!-- Total number of stitches -->

  num_colours="7"                        <!-- Number of colors used -->

  num_trims="21"                         <!-- Number of trims -->

  num_objects="100"                   <!-- Number of embroidery objects -->

  num_colour_changes="13"       <!-- Number of color changes -->

  height="215.572222"               <!-- Height in mm -->

  width="138.633333"                <!-- Width in mm -->

>

  <colorways>                              <!-- List of design colorways -->

    <colorway

      name="Colorway 1"             <!-- Name of the colorway -->

      file="Colorway 1.png"          <!-- Optional TrueView bitmap filename (output only) -->

      bkg_colr="12632256"         <!-- Background color (always provided) -->

      current="true"                      <!-- Indicates if this is the current colorway -->

    >

      <threads>                             <!-- Ordered list of threads for this colorway -->

        <thread ... />

        <thread ... />

        <thread ... />

      </threads>

    </colorway>

    <colorway ... />                    <!-- Additional colorways, if any -->

  </colorways>

  <stop_sequence>                  <!-- Sequence of machine stops during stitching -->

    <stop_record

      color_idx="0"                     <!-- Index to colorway's thread list (can be -1) -->

      num_stitches="73"           <!-- Stitches in this stop -->

      element=""                        <!-- Optional descriptive label -->

    />

    <stop_record ... />

    <stop_record ... />

  </stop_sequence>

  <lettering_objects>             <!-- Optional list of lettering objects -->

    <lettering_object index="0">

      <simple_lettering ... />    <!-- Lettering configuration -->

      <thread ... />                    <!-- Associated thread -->

    </lettering_object>

  </lettering_objects>

  <monogram_objects>         <!-- Optional list of monogram objects -->

    <monogram_object index="0">

      <monogram_lettering ... />        <!-- Monogram lettering -->

      <monogram_ornament ... />     <!-- Monogram ornament -->

    </monogram_object>

  </monogram_objects>

</design_info>

---

Usage

The <design_info> XML is returned by the following API endpoints:

Output only:

1. api/designInfo
2. api/designTrueview
3. api/newDesignTrueview
4. api/newDesign
5. api/newLetteringPreview

---

Elements

✅ <design_info>

Contains the core information about the embroidery design:

Attribute	Details
machine_name	The embroidery machine format – e.g. Melco.
num_stitches	Total stitch count. When estimated – e.g. by api/newLetteringPreview – the accuracy is ±10%.
num_colours	Number of colors. When estimated, this is always 1.
num_trims	Number of trims. When estimated, this is always 0.
num_objects	Number of embroidery objects.
num_colour_changes	Number of color changes. When estimated, this is always 0.
height and width	Design dimensions in millimeters.

✅ <colorways>

Contains one or more colorway elements. Each <colorway> includes:

Attribute	Details
name	Colorway name for use in design decorations.
file	Optional bitmap file – only returned by api/designTrueview.
bkg_colr	Background color (decimal RGB).
current	Indicates the current colorway.
threads	Ordered list of threads for this colorway.

✅ <stop_sequence>

Describes the embroidery machine’s stop sequence: Each <stop_record> includes:

Attribute	Details
color_idx	Zero-based index into the colorway’s thread list. May be -1 if no color is applicable.
num_stitches	Number of stitches for this stop.
element	Optional text to describe the stop.

✅ <lettering_objects>

Optional list of lettering_object items. Each object contains:

Attribute	Details
index	Zero-based index.
simple_lettering	Lettering settings.
thread	Thread used for this lettering.

Lettering objects inside Team Name Lettering or Monograms are not included here, as they cannot be modified individually.

✅ <monogram_objects>

Optional list of monogram_object items. Each includes:

Attribute	Details
index	Position in the monogram list.
monogram_lettering	Monogram lettering settings.
monogram_ornament	Monogram ornament settings.

---

Estimation accuracy

When generated by api/newLetteringPreview, some values in design_info are estimated for performance. Some fields are estimated exactly, others approximately:

Field	Estimation notes
num_stitches	Estimated within ±10%
num_colours	Always estimated as 1
num_trims	Always estimated as 0
num_colour_changes	Always estimated as 0
Others	Estimated to match actual values

---

Remarks

1. file in colorway is only returned by api/designTrueview.
   
2. Always use returned colorway names in your design decorations.
3. The color_idx in stop_record links stops to specific threads in any colorway.
   
4. Background color (bkg_colr) is always provided, pulled from:
   
1. Template (for stitch formats like DST, PES)
   
2. Design file (for native formats like EMB, ART)
   
5. Color index (color_idx) may be -1 for stops without a thread color – e.g. in borer designs.
   
6. Lettering/monogram objects tied to team name lettering or monograms are excluded.
   
7. The design_info structure may be extended in future versions.

• Related Articles

• View design information

  The Design Information pane displays detailed information about a selected design in the Library. From this pane you can review metadata, inspect technical design properties, view available colorways, and manage attachments associated with the ...

• Update design information

  The update design information feature allows you to modify the metadata associated with a design in Wilcom Library. Keeping design information up to date ensures designs are easy to find, correctly categorized, and ready for production workflows. ...

• Design status

  The design status setting allows you to define workflow stages used to track the progress of designs. Status values help teams manage design workflows, from initial request through approval and production. Design statuses are shared across the ...

• Capture design bitmap

  The Capture Design Bitmap feature allows you to create and download a bitmap image of a design stored in Wilcom Library. Bitmap previews are useful for sharing design visuals with customers, including designs in documentation, or referencing designs ...

• Upload design files

  Uploading files to Wilcom Library allows you to store embroidery designs and related materials in a central location where they can be accessed and shared across your organization. When a design file is uploaded, Library creates a design record that ...