Interface IHiResOutput

A structure holding the hi-res output settings.

Package: @aurigma/design-editor-iframe

Examples

const product = {
  surfaces: [{
      printAreas: [{
          designFile: "Envelope",
          hiResOutput: {
              fileFormat: "PDF",
              cmykColorProfileName: "US Sheetfed Coated v2",
              dpi: 400,
              flipMode: "both",
              rotateMode: "rotate90"
          }
      }]
  }]
};

Properties

backgroundColor

The background color of the hi-res output.

Declaration

backgroundColor?: string;

Property Value

Type	Description
string	The background color of the hi-res output.

colorSpace

The color space of the hi-res output. It can have one of the following values: "RGB", "CMYK", or "Grayscale".

Declaration

colorSpace?: string;

Property Value

Type	Description
string	The color space of the hi-res output. It can have one of the following values: "RGB", "CMYK", or "Grayscale".

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

Declaration

compression?: string;

Property Value

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

dpi

Hi-res output resolution in dots per inch (DPI).

Declaration

dpi?: number;

Property Value

Type	Description
number	Hi-res output resolution in dots per inch (DPI).

fileFormat

The type of the hi-res output. It can have one of the following values: "pdf", "jpeg", "png", or "tiff". The default value is "pdf".

Declaration

fileFormat?: string;

Property Value

Type	Description
string	The type of the hi-res output. It can have one of the following values: "pdf", "jpeg", "png", or "tiff". The default value is "pdf".

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

Declaration

flipMode?: string;

Property Value

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

inStringPlaceholderHintsEnabled

If true, displays hints for unfilled in-string placeholders in hi-res outputs. The default value is false.

Declaration

inStringPlaceholderHintsEnabled?: string;

Property Value

Type	Description
string	If true, displays hints for unfilled in-string placeholders in hi-res outputs. The default value is false.

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.

Declaration

jpegCompressionQuality?: number;

Property Value

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

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

Declaration

rotateMode?: string;

Property Value

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