EWA design recipe
The <recipe> element is the root container for describing a complete
embroidery design or preview. It describes the
placement, decorations, and desired output settings.
XML structure
<recipe> <!--
Root element: design recipe -->
<location
... /> <!-- Placement and
positioning -->
<decorations
... /> <!-- List of design
decorations -->
<output
... /> <!-- Output options
and format -->
</recipe>
<recipe>
<location width="100.0" height="100.0" />
<decorations>
<design file="logo1.emb" />
<lettering>
<simple_lettering text="TEAM" />
</lettering>
</decorations>
<output format="png" />
</recipe>
This defines:
- A 100mm x 100mm embroidery area
- A logo and a line of text
- Output as a PNG image
Components
The <recipe> is the root element containing all the data required to generate or
preview a new embroidery design. Its flexible format allows detailed control
over placement, design components, and final output. It consists of three main parts:
Element | Description |
<location> | Defines where the design is placed, positioned, or transformed on the hoop or workspace. |
Describes the actual embroidery elements — lettering, monograms, team names, ornaments, and any recoloring instructions. | |
<output> | Specifies output options for the generated design or TrueView™ image. This includes format, file type, and additional rendering preferences. |
Usage
A <recipe> XML is required as input for the following APIs:
At least one decoration is required. For api/newLetteringPreview, you must use exactly one lettering in <decorations>.
XML elements
The <recipe> structure can include or reference the
following detailed XML elements, depending on design requirements. Always refer to the specific sub-element documentation for exact
attributes and valid values:
| Element | Purpose |
Defines positioning and transformations. | |
Lists all decorative elements. | |
Handles scaling, rotation, or flipping. | |
Specifies thread colors and types. | |
Embeds additional design components. | |
Controls rendering output. | |
Defines lettering parts of the design. | |
Defines monogram elements. | |
Provides recoloring instructions. | |
Used for customized personalized lettering. | |
Used for customized personalized lettering. | |
Used for customized team lettering. | |
Used for customized team lettering. | |
Used for customized team lettering. | |
Used to define monogrammed lettering and ornament details. | |
Used to define monogram lettering details. | |
Used to define monogram ornament details. | |
Specifies file type, naming, and output control. |