Bitmap recipe

Bitmap recipe

The <bitmap> XML element defines the bitmap image to be used for auto-digitizing or artwork generation. It specifies the source file and whether to automatically remove the background.

XML structure

<bitmap                                          <!-- Root element: bitmap recipe -->
  file="logo.jpg"                             <!-- Filename of the bitmap (must match an entry in <files>) -->
  remove_background="true"      <!-- Whether to auto-remove the background (default: true) -->
/>

Usage

The bitmap XML is provided as input to the following API functions:
  1. api/bitmapArtPreview
  2. api/bitmapArtTrueview
  3. api/bitmapArtDesign

Attributes

Attribute
Type
Description
file
string
  1. Required. Name of the bitmap file — e.g. 'logo.jpg', 'image.png'.
  2. Must match a file listed in the <files> XML block by filename.
remove_background
boolean
  1. Optional. Instructs the system to automatically detect and remove the bitmap's background.
  2. Defaults to 'true'.
  3. Ignored if the input image is already transparent — e.g. PNG with alpha.

Remarks

  1. The bitmap is referenced by filename only — its actual contents must be included in the <files> XML structure.
  2. The remove_background option allows EWA (Embroidery Web API) to remove solid or flat backgrounds automatically. If the image has transparency, this setting has no effect.
  3. The bitmap element is simple but extensible — additional options may be added in the future to support more advanced image handling.
  4. There are specific limitations on input bitmap files for auto-digitizing. Refer to Auto-digitize artwork limitations for guidelines and best practices.
  5. Supported bitmap formats are listed in Supported formats section of this document.