IProofImage Interface

A structure holding settings for proof images.

example
var emptyProduct = {
    surfaces: [
        {
            width: 720,
            height: 504,
            proofImage: {
                fileFormat: "PNG",
                mockupEnabled: false,
                watermarkEnabled: true,
                watermarkText: "PREVIEW",
                watermarkFontSize: 50
            }
        }]
};

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 for proof images. Allows for flipping proof images. Possible values are "none", "vertical", "horizontal", "both".

Optional mockupEnabled

mockupEnabled: boolean

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

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. Displays a watermark on proof images. The default value is true. You can use IWatermarkConfig instead. For more details, refer to the Watermarks topic.

Optional watermarkFontPostScriptName

watermarkFontPostScriptName: string

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

Optional watermarkFontSize

watermarkFontSize: number

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

Optional watermarkText

watermarkText: string

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