- Introduction
- What's New?
- Features
- Upgrading the Design Editor
- Breaking Changes in 6.0
- Getting Started
- Integration with E-commerce
- Integration with Remote Asset Sources
- Printable Files and Proof Images
- Configuring Products
- Creating Product Templates
- User Interface
- Configuration Files
- APIs
- IFrame API
- Getting Started with IFrame API
- Using the Design Atoms Framework in IFrame API
- Changing the Product Size
- BaseEditor Module
- IframeApi Module
- Commands Module
- Configuration Module
- Editor Class
- loadEditor Function
- ObjectModel Module
- ChannelContainerType Enumeration
- Container Class
- CropMarkTextAlignment Enumeration
- IBarcodeVariable Interface
- IBasePrintAreaDefinition Interface
- IBaseSurfaceDefinition Interface
- IBaseSurfacesDefinition Interface
- IBgFoldingModeParams Interface
- IChannelContainerDefinition Interface
- ICropMark Interface
- ICropMarkText Interface
- IFoldingLine Interface
- IHiResOutput Interface
- IMarginHV Interface
- IMarginLTRB Interface
- IMockupData Interface
- IMockupFolders Interface
- IMockupTemplate Interface
- IModelComponent Interface
- IPageTemplate Interface
- IPointF Interface
- IPrintAreaDefinition Interface
- IPrintAreaTemplate Interface
- IProductDefinition Interface
- IProofImage Interface
- IRectangleF Interface
- ISafetyLine Interface
- ISetPrintAreasOptions Interface
- ISize Interface
- ISpine Interface
- IStateSurface Interface
- IStateSurfaces Interface
- ISurfaceDefinition Interface
- ISurfaceFromState Interface
- ISurfacesFromFolder Interface
- ISurfacesFromMultipageTemplate Interface
- ISurfaceTemplate Interface
- ITagsDictionary Interface
- Item Class
- IUpdateSurfaceOptionsByDefinition Interface
- IVariable Interface
- PdfBox Enumeration
- PrintArea Class
- Product Class
- Surface Class
- SurfaceMockup Class
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Web API
- Design Atoms Framework
- UI Framework
- Dynamic Image API
- IFrame API
- Add-ons
- System Requirements
- Troubleshooting
- Migrating Your Applications
- Licensing
- Copyright Notices
IProofImage Interface
Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation
A structure holding settings for proof images.
Properties
Optional 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.
Optional fileFormat
The type of preview files. It can be either "JPEG" or "PNG". The default value is "JPEG".
Optional 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".
Optional inStringPlaceholderHintsEnabled
If true, displays hints for unfilled in-string placeholders on proof images. The default value is false.
Optional 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.
Optional mockupEnabled
Displays mockups on proof images. The default value is true.
Optional rgbColorProfileName
The name of an RGB color profile for proof images. By default, the editor uses the sRGB IEC61966-2.1 profile to render proof images.
Optional 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".
Optional safetyLinesEnabled
Allows for drawing safety lines on proof images. The default value is true.
Optional showStubContent
Displays stub images and text hints in unfilled placeholders. The default value is false.
Optional spineAndFoldingLinesEnabled
Displays spines and folding lines on proof images. The default value is true.