Interface: IHiResOutput

A structure holding the hi-res output settings.

Example

const product = {
  surfaces: [
    {
      printAreas: [
        {
          designFile: "Envelope",
          hiResOutput: {
            fileFormat: "PDF",
            cmykColorProfileName: "US Sheetfed Coated v2",
            dpi: 400,
            flipMode: "both",
            rotateMode: "rotate90",
          },
        },
      ],
    },
  ],
};

Properties

dpi?

optional dpi?: number

Hi-res output resolution in dots per inch (DPI).

---

fileFormat?

optional fileFormat?: string

The type of the hi-res output. It can have one of the following values: "pdf", "jpeg", "png", or "tiff". The default value is "pdf".

---

colorSpace?

optional colorSpace?: string

The color space of the hi-res output. It can have one of the following values: "RGB", "CMYK", or "Grayscale".

---

backgroundColor?

optional backgroundColor?: string

The background color of the hi-res output.

---

compression?

optional compression?: string

The type of hi-res output compression; "jpeg" and "zip" are supported for PDF files only, whereas "lzw" is supported for TIFF files; it can have one of the following values: "jpeg", "zip", "none", or "lzw".

---

jpegCompressionQuality?

optional jpegCompressionQuality?: number

JPEG compression quality in percent; this parameter makes sense only for JPEG and PDF formats. For PDF, it should be used along with hiResOutputCompression="jpeg". The default value is 90.

---

flipMode?

optional flipMode?: string

The flip mode of hi-res outputs. Allows for flipping hi-res output images. It can have one of the following values: "none", "vertical", "horizontal", or "both". The default value is "none".

---

rotateMode?

optional rotateMode?: string

The rotate mode of hi-res outputs. Allows for rotating hi-res output images. It can have one of the following values: "none", "rotate90", "rotate180", or "rotate270". The default value is "none".

---

inStringPlaceholderHintsEnabled?

optional inStringPlaceholderHintsEnabled?: string

If true, displays hints for unfilled in-string placeholders in hi-res outputs. The default value is false.