View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IHiResOutput Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure holding the hi-res output settings.

example
CustomersCanvas.IframeApi.loadEditor(
    iframe,
    {
        surfaces: [{ 
            printAreas: [{
                designFile: "Envelope",
                hiResOutput: {
                    fileFormat: "PDF",
                    cmykColorProfileName: "US Sheetfed Coated v2",
                    dpi: 400,
                    flipMode: "both",
                    rotateMode: "rotate90"
                }
            }]
        }]
    }
);

Properties

Optional backgroundColor

backgroundColor: string

The background color of the hi-res output.

Optional cmykColorProfileName

cmykColorProfileName: string

The name of a CMYK color profile for the hi-res output. By default, the editor uses the SWOP (Coated) 20%, GCR, Medium profile to render hi-res outputs in CMYK.

Optional colorSpace

colorSpace: string

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

Optional compression

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

Optional dpi

dpi: number

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

Optional fileFormat

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

Optional flipMode

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

Optional grayscaleColorProfileName

grayscaleColorProfileName: string

The name of a color profile for grayscale outputs. By default, the editor uses the Dot Gain 30% profile to render hi-res outputs in grayscale.

Optional inStringPlaceholderHintsEnabled

inStringPlaceholderHintsEnabled: string

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

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.

Optional pdfMetadata

pdfMetadata: IPdfMetadata

PDF metadata to be saved in the hi-res output. You can save such data as a document title, author and creator names, keywords, and a document subject.

Optional rgbColorProfileName

rgbColorProfileName: string

The name of an RGB color profile for the hi-res output. By default, the editor uses the sRGB IEC61966-2.1 profile to render hi-res outputs in RGB.

Optional rotateMode

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