IHiResOutput

A structure holding hi-res output settings.

example
CustomersCanvas.IframeApi.loadEditor(
    iframe,
    {
        surfaces: [{ 
            printAreas: [{
                designFile: "Envelope",
                hiResOutput: {
                    fileFormat: "PDF",
                    dpi: 400,
                    flipMode: "both"
                }
            }]
        }]
    }
);

Properties

Optional backgroundColor

backgroundColor: string

Background color for the hi-res output.

Optional colorSpace

colorSpace: string

Color space of hi-res output; it can have one of the following values: "RGB", "CMYK", "Grayscale".

Optional compression

compression: string

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", "lzw".

Optional dpi

dpi: number

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

Optional fileFormat

fileFormat: string

Type of hi-res output; it can have one of the following values: "pdf", "jpeg", "png", "tiff".

Optional flipMode

flipMode: string

Flip mode for hi-res outputs. Allows for flipping hi-res output images. It can have one of the following values: "none", "vertical", "horizontal", "both".

Optional jpegCompressionQuality

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.