- Introduction
- What's New?
- Features
- 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
- API
- Introduction to IFrame API
- IFrame API Reference
- BaseEditor Module
- IframeApi Module
- Configuration Module
- Editor Class
- loadEditor Function
- loadEditorByQueryString 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
- IMockupTemplateHandlerLegacy Interface
- IMockupTemplateObject Interface
- IModelComponent Interface
- IPointF Interface
- IPrintAreaDefinition Interface
- IPrintAreaTemplate Interface
- IProductDefinition Interface
- IProofImage Interface
- IRectangleF Interface
- ISafetyLine Interface
- ISize Interface
- ISpine Interface
- IStateSurface Interface
- IStateSurfaces Interface
- ISurfaceDefinition Interface
- ISurfacesFromFolder Interface
- ISurfacesFromMultipageTemplate Interface
- ISurfaceTemplate Interface
- ITagsDictionary Interface
- Item Class
- IVariable Interface
- PrintArea Class
- Product Class
- Surface Class
- SurfaceMockup Class
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Web API
- Old Query-string API
- Visual Proofing Tool
- Variable Data Printing
- System Requirements
- Troubleshooting
- Licensing
- Copyright Notices
IHiResOutput Interface
Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation
A structure holding the hi-res output settings.
Properties
Optional backgroundColor
The background color of the hi-res output.
Optional colorSpace
The color space of the hi-res output. It can have one of the following values: "RGB", "CMYK", or "Grayscale".
Optional compression
The type of hi-res output compression; "jpeg" and "zip" are supported for PDF files only, whereas "lzw" is supported for TIFF files; it can have one of the following values: "jpeg", "zip", "none", or "lzw".
Optional dpi
Hi-res output resolution in dots per inch (DPI).
Optional fileFormat
The type of the hi-res output. It can have one of the following values: "pdf", "jpeg", "png", or "tiff".
Optional flipMode
The flip mode of hi-res outputs. Allows for flipping hi-res output images. It can have one of the following values: "none", "vertical", "horizontal", or "both". The default value is "none".
Optional inStringPlaceholderHintsEnabled
If true, displays hints for unfilled in-string placeholders in hi-res outputs. The default value is true.
Optional jpegCompressionQuality
JPEG compression quality in percent; this parameter makes sense only for JPEG and PDF formats. For PDF, it should be used along with hiResOutputCompression="jpeg". The default value is 90.
Optional rotateMode
The rotate mode of hi-res outputs. Allows for rotating hi-res output images. It can have one of the following values: "none", "rotate90", "rotate180", or "rotate270". The default value is "none".