Render

Format

/1/Render/[design component]

Design component can be Lettering, a design, a template or a compound.

Requests can be made using GET or POST methods for "Designs" and "Templates". For POST method, the parameters must be passed in the body of the request, as a JSON object containing key/value pairs. The key/value pairs must be double-quoted strings with decoded text, following the same format from the query parameters of GET requests, as shown in the examples below:

• &Personalizations[1].TextColour=1000+-+Black --> "Personalizations[1].TextColour": "1000 - Black"
• &Personalizations[1].IsRainbowText=False --> "Personalizations[1].IsRainbowText": "False"

Description

Renders a design component onto a bitmap and returns the bitmap.

Parameters

• Format - Format of the returned image. Valid values are "png", "jpg", or "jpeg". Default is "png".
• Background - The background colour to render the design component onto. The format of the background is an ARGB quad-tuplet. Default is fully opaque white "ffffffff".
• ImageWidth - Width in pixels of the resulting image.
• ImageHeight - Height in pixels of the resulting image.
• DPI - DPI value to use when generating the image. Ignored if any of ImageWidth or ImageHeight are specified. Default is 96.
• IsSquare - True/false value specifying if the resulting image should be square. Ignored if ImageWidth and ImageHeight are both specified. Default is false. Default is false.
• Padding - Number of pixels around the edge of the image to pad the image of the design. Default is 0.
• Box.Left - Left edge of the bounding box on the image in which the design will be rendered. Default is 0.
• Box.Top - Top edge of the bounding box on the image in which the design will be rendered. Default is 0.
• Box.Right - Right edge of the bounding box on the image in which the design will be rendered. Default is image width - 1.
• Box.Bottom - Bottom edge of the bounding box on the image in which the design will be rendered. Default is image width - 1.
• IsLaser - Will render the result as outlines or filled if the design or template has laser segments. Valid values are:
  • true
  • false
  Default is false.
• Recipe - Recipe to use when generating the final design which will apply a recipe on top of any existing. Default is "Normal". See list of available recipes.
• ElementRecipe[] - Array of recipes to be applied per element. See arrays for more information about specifying array values.
• Reflect - The ability to mirror a design with additional options on where the mirror will occur. Valid values are:
  • rtRight
  • rtCenterX
  • rtLeft
  • rtTop
  • rtCenterY
  • rtBottom
  Default is no reflect.
• Transparency - The alpha value from the ARGB quad-tuplet. Default is fully opaque white "FF".
  • Transparency Note: Currently only supported for Laser where the IsLaser is set to true
• LightenShadows
  • Shadows in some cases are very dark, affecting the look of lighter thread colors.
  • This could be noticed especially with white and yellow thread colors.
  • Valid values are "true" or "false".
  Default is "false".
• UseImageDimensions - True/False value whether or not to include the design's image size in the size of the final image. Only applies to PXF files that contain an image. Default is false.

If ImageWidth and ImageHeight are both specified, the resulting image will be the specified width and height.

If only one of ImageWidth and ImageHeight are specified, and IsSquare is false, then the resulting image will be generated using that value as a constraint and the other value will be calculated such that the image is at the same aspect ratio as the design component. Otherwise, if IsSquare is true, then the resulting image will be square using the specified value as a constraint.

If ImageWidth and ImageHeight are both omitted, then the image will be generated at a size determined by the DPI parameter to be the "actual" size of the embroidery.

An image using a transparent background can be obtained by using Format=png and Background=00000000. JPG images do not support transparency.

Example

/1/Render/Lettering?Text=ABC&ImageWidth=400

Output

---