1. Aurigma Customer's Canvas 4.3.8
  2. API
  3. IFrame API Reference
  4. IframeApi Module
  5. Configuration Module

IRenderingProperty Interface

A structure containing the hi-res output and proof images configuration. For details, see the Configuring High Resolution and Proof Images topic.

example
configuration = {
    rendering: {
        proofImageSafetyLinesEnabled: true,
        proofImageSpineAndFoldingLinesEnabled: false,
        hiResOutputRotateMode: "rotate270"
    }
};

Properties

Optional hiResOutputBackgroundColor

hiResOutputBackgroundColor: string

The background color for the hi-res output. The default value is "rgba(255,255,255,0)".

Optional hiResOutputColorSpace

hiResOutputColorSpace: string

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

Optional hiResOutputCompression

hiResOutputCompression: 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". The default value is "zip".

Optional hiResOutputDpi

hiResOutputDpi: number

Hi-res output resolution in dots per inch (DPI). The default value is 300.

Optional hiResOutputFileFormat

hiResOutputFileFormat: 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 hiResOutputFlipMode

hiResOutputFlipMode: string

The flip mode of the 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 hiResOutputJpegCompressionQuality

hiResOutputJpegCompressionQuality: 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 hiResOutputPdfMetadata

hiResOutputPdfMetadata: 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 hiResOutputRotateMode

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

Optional hiResOutputToSeparateFiles

hiResOutputToSeparateFiles: boolean

If true, the hi-res output for each page of a multipage product will be put in a separate file. The default value is false.

Optional proofImageCropSafetyLine

proofImageCropSafetyLine: string

The name of a safety line which proof images are cropped to; if there is no safety line with the given name, proof images are not cropped. The default value is "bleed". For details, see the Configuring High Resolution and Proof Images topic.

Optional proofImageFileFormat

proofImageFileFormat: string

The type of proof image files; it can be either "JPEG" or "PNG". The default value is "PNG".

Optional proofImageFlipMode

proofImageFlipMode: string

The flip mode of proof images. Allows for flipping proof images. Possible values are "none", "vertical", "horizontal", or "both". The default value is "none".

Optional proofImageMockupEnabled

proofImageMockupEnabled: boolean

Displays mockups on proof images. The default value is true.

Optional proofImageRotateMode

proofImageRotateMode: string

The rotate mode of proof images. Allows for rotating proof images. Possible values are "none", "rotate90", "rotate180", and "rotate270". The default value is "none".

Optional proofImageSafetyLinesEnabled

proofImageSafetyLinesEnabled: boolean

Allows for drawing safety lines on proof images. The default value is false.

Optional proofImageShowStubContent

proofImageShowStubContent: boolean

Displays stub images and text hints in unfilled placeholders. The default value is false.

Optional proofImageSpineAndFoldingLinesEnabled

proofImageSpineAndFoldingLinesEnabled: boolean

Displays spines and folding lines on proof images. The default value is true.

Optional proofImageWatermarkEnabled

proofImageWatermarkEnabled: boolean

Outdated, use IWatermarkConfig instead. Displays a watermark on proof images. The default value is true. For more details, refer to the Watermarks topic.

Optional proofImageWatermarkFontPostScriptName

proofImageWatermarkFontPostScriptName: string

Outdated, use IWatermarkConfig instead. The watermark font name. The default value is "ArialMT". For more details, refer to the Watermarks topic.

Optional proofImageWatermarkFontSize

proofImageWatermarkFontSize: number

Outdated, use IWatermarkConfig instead. The watermark font size, in points. The default value is 35. For more details, refer to the Watermarks topic.

Optional proofImageWatermarkText

proofImageWatermarkText: string

Outdated, use IWatermarkConfig instead. The watermark text. The default value is "watermark". For more details, refer to the Watermarks topic.