Skip to main content

Interface: IProofImage

A structure holding settings for proof images.

Example​

const emptyProduct = {
  surfaces: [
    {
      width: 720,
      height: 504,
      proofImage: {
        fileFormat: "PNG",
        rgbColorProfileName: "Adobe RGB (1998)",
        mockupEnabled: false,
      },
    },
  ],
};

Properties​

fileFormat?​

optional fileFormat?: string

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

safetyLinesEnabled?​

optional safetyLinesEnabled?: boolean

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

cropSafetyLineName?​

optional 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 an empty string.

spineAndFoldingLinesEnabled?​

optional spineAndFoldingLinesEnabled?: boolean

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

mockupEnabled?​

optional mockupEnabled?: boolean

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

showStubContent?​

optional showStubContent?: boolean

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

flipMode?​

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

rotateMode?​

optional rotateMode?: string

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

interpolationMode?​

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

inStringPlaceholderHintsEnabled?​

optional inStringPlaceholderHintsEnabled?: boolean

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

Was this page helpful?