Interface IProofImage

A structure holding settings for proof images.

Package: @aurigma/design-editor-iframe

Examples

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

Properties

cropSafetyLineName

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.

Declaration

cropSafetyLineName?: string;

Property Value

Type	Description
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.

fileFormat

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

Declaration

fileFormat?: string;

Property Value

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

flipMode

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

Declaration

flipMode?: string;

Property Value

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

inStringPlaceholderHintsEnabled

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

Declaration

inStringPlaceholderHintsEnabled?: boolean;

Property Value

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

interpolationMode

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.

Declaration

interpolationMode?: string;

Property Value

Type	Description
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.

mockupEnabled

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

Declaration

mockupEnabled?: boolean;

Property Value

Type	Description
boolean	Displays mockups on proof images. The default value is true.

rotateMode

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

Declaration

rotateMode?: string;

Property Value

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

safetyLinesEnabled

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

Declaration

safetyLinesEnabled?: boolean;

Property Value

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

showStubContent

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

Declaration

showStubContent?: boolean;

Property Value

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

spineAndFoldingLinesEnabled

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

Declaration

spineAndFoldingLinesEnabled?: boolean;

Property Value

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