IProofImage Interface

A structure holding settings for proof images.

example
var emptyProduct = {
    surfaces: [
        {
            width: 720,
            height: 504,
            proofImage: {
                fileFormat: "PNG",
                mockupEnabled: false
            }
        }]
};

Properties

Optional cropSafetyLineName

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

Optional fileFormat

fileFormat: string

The type of preview files. It can be either "JPEG" or "PNG". The default value is "PNG".

Optional flipMode

flipMode: string

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

Optional inStringPlaceholderHintsEnabled

inStringPlaceholderHintsEnabled: boolean

If true, displays hints for unfilled in-string placeholders on proof images. The default value is true.

Optional interpolationMode

interpolationMode: string

The interpolation algorithm used for resizing proof images. You can find the list of supported algorithms in the specification of the Aurigma Graphics Mill library. For example, you can use "Lanczos", "NearestNeighbour", and other algorithms. By default, no interpolation algorithms are applied to resize proof images.

Optional mockupEnabled

mockupEnabled: boolean

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

Optional rotateMode

rotateMode: 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 safetyLinesEnabled

safetyLinesEnabled: boolean

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

Optional showStubContent

showStubContent: boolean

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

Optional spineAndFoldingLinesEnabled

spineAndFoldingLinesEnabled: boolean

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

Optional watermarkEnabled

watermarkEnabled: 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 watermarkFontPostScriptName

watermarkFontPostScriptName: string

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

Optional watermarkFontSize

watermarkFontSize: 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 watermarkText

watermarkText: string

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