api/newDesignTrueview

Action:

Obtain a transparent TrueView™ image of a new set of decorations in a combined design which is created based on the design recipe provided. The TrueView™ image is 1:1 size will have a transparent background (i.e. PNG file with transparency).

Also obtain information about the produced design, such as height, width, number of stitches, etc, as the api/designInfo function.

Post Parameters:

  • appId: Application id of Wilcom API Develop Portal account.
  • appKey: Application key of Wilcom API Develop Portal account.
  • requestXml: an XML string containing the full specification of the components of design:
<xml>
  <recipe ... /> 			// recipe
  <files ... />				// files used by the recipe
</xml>

Return Values:

On success, an XML string containing the generated TrueView and the design information:

<xml>
  <files>
    <file ... />			// resulting trueview file
  </files>
  <design_info ... /> 			// design information
</xml>

Remarks:

The method will create a new design by combining the multiple decorations supplied and position them according to the transforms specified by recipe.

It will then create a transparent bitmap of the produced design that will be returned in files part of the return value, named according to the trueview_file parameter of the output component of the recipe.

It will then create the design information about the produced design that will be returned in design_info part of the return value. This method does not return the actual embroidery design data – only an image of what the design would look like. Use api/newDesign to get the actual embroidery data.