Generate TrueView for modified design

Generate TrueView for modified design

The editDesignTrueview API method generates a TrueView image (transparent PNG) of an existing embroidery design, after modifying lettering objects and monogram objects. It also returns estimated design metadata — e.g. size, stitch count.

POST parameters

ParameterTypeRequiredDescription
appIdString✅App ID from your Wilcom Developer Portal account.
appKeyString✅App Key from your Wilcom Developer Portal account.
requestXml
String
✅
An XML string specifying the design file to edit and the desired output settings for lettering or monogram.

XML structure

<xml>
  <recipe>
    <design>
      <design_file filename="template.emb" />
      <lettering_objects>
        <lettering text="New Text" font="Block" height="10" />
      </lettering_objects>
    </design>
    <output trueview_file="preview.png" />
  </recipe>
  <files>
    <file filename="template.emb" filecontents="..." />
  </files>
</xml>

Response

On success, the API returns an XML string containing the generated TrueView™ image and the updated design metadata:

<xml>
  <files>
    <file filename="preview.png" filecontents="..." />     <!-- Transparent preview -->
  </files>
  <design_info>...</design_info>                           <!-- Estimated metadata -->
</xml>

XML components

ComponentDetails
<recipe>The design is built on-the-fly using the provided <recipe>, including lettering, team names, or any other decorations.
<design>
Design is specified in the <design> block via a design_file.
<design_file>
Input file is identified in <design_file> and passed in <files>.
<lettering_objects>
To update lettering, use <lettering_objects>. To update monograms, use <monogram_objects>.
<lettering>
Place custom text with specific style, position, and thread color. 
<output>
The preview PNG file name is taken from the trueview_file in <output>.
<files>This element is used to pass one or more files to or from API endpoints. It contains the input vector file and the resulting design and TrueView™ file(s).
<design_info>Provides updated details about the modified design — e.g. size, stitch count. 

Remarks

  1. No design file is returned with the editDesignTrueview method — only a preview.
  2. To obtain the edited embroidery design file, use the api/editDesign API method.
  3. Supported bitmap formats are listed in Supported formats section of this document.