Backdrop

Description

You can open add an image file to use as a backdrop for on-screen digitizing or for auto tracing.
You can add an image in 3 standard file formats. See below. When you add an image, it will retain its original size if not specified otherwise.
Pulse allows you to save loaded images in *.PXF files.
Backdrop images can only be used in a Compound call. See Compounds for more information.

For example: /1/Render/Compound?Elements[0]=Lettering%3fText=PULSE&Elements[1]=Backdrop%3fPath%3DPulseLogoVerticalHQ.PNG%26Format%3Dpng

Parameters

• Backdrop Note: The image must be uploaded using the Upload action of the API
• Path - The image to be added. Supports subdirectories as well in the call. /MySubdirectory/MyImage.PNG
• ImageScale - Option to resize the image. Default is 1.0 which will retain its original size
• Format - File format of the image that is being added. Valid values are:
  • png
  • bmp
  • jpg
  Default is "png".
• Units - Value used to determine the X and Y offset of the image added to the embroidery. Valid values are:
  • mm - Millimeters
  • in - Inches
  • pt - Embroidery or Stitch Points
  Default is "mm".
• OffsetX - Upper left corner of image from 0,0 in the Embroidery design. Positive will move right. See examples below.
• OffsetY - Upper left corner of image from 0,0 in the Embroidery design. Positive will move down. See examples below.

Example

Generate/Compound?Elements[0]=Lettering%3fText=PULSE&Elements[1]=Backdrop%3fPath%3DPulseLogoVerticalHQ.PNG%26Format%3Dpng%26OffsetX%3D-15.0%26OffsetY%3D25.4%26Units%3Dmm

Generate File Re Generate Download File

---