Interface IRenderingProperty

A structure containing the hi-res output and proof images configuration.

Package: IframeApi

Remarks

For details, see Configuring Print Files topic.

Examples

configuration = {
   rendering: {
       proofImageSafetyLinesEnabled: true,
       proofImageSpineAndFoldingLinesEnabled: false,
       proofImageInterpolationMode: "NearestNeighbour",
       proofImageRotateMode: "auto"
   }
};

Properties

hiResOutputBackgroundColor

The background color for the hi-res output. The default value is "rgba(255,255,255,0)".

Declaration

hiResOutputBackgroundColor?: string

Property Value

Type	Description
string

HiResOutputChannelContainersRenderEmptyPage

To maintain the same number of pages in output files of the base design and channel containers, this parameter allows you to add empty pages to PDF with spot colors and textures if the corresponding pages of the base design do not have channel containers. The default value is true.

Declaration

HiResOutputChannelContainersRenderEmptyPage?: boolean

Property Value

Type	Description
boolean

HiResOutputChannelContainersToSeparateFiles

If true, enables rendering spot colors and textures to separate PDF files. The default value is false.

Declaration

HiResOutputChannelContainersToSeparateFiles?: boolean

Property Value

Type	Description
boolean

hiResOutputCmykColorProfileName

The name of a CMYK color profile for the hi-res output. By default, the editor uses the SWOP (Coated) 20%, GCR, Medium profile to render hi-res outputs in CMYK.

Declaration

hiResOutputCmykColorProfileName?: string

Property Value

Type	Description
string

hiResOutputColorSpace

The color space of the hi-res output. It can have one of the following values: "rgb", "cmyk", or "grayscale". The default value is "cmyk".

Declaration

hiResOutputColorSpace?: string

Property Value

Type	Description
string

hiResOutputCompression

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". The default value is "jpeg".

Declaration

hiResOutputCompression?: string

Property Value

Type	Description
string

hiResOutputDpi

Hi-res output resolution in dots per inch (DPI). The default value is 300.

Declaration

hiResOutputDpi?: number

Property Value

Type	Description
number

hiResOutputFileFormat

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

hiResOutputFileFormat?: string

Property Value

Type	Description
string

hiResOutputFlipMode

The flip mode of the 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

hiResOutputFlipMode?: string

Property Value

Type	Description
string

hiResOutputGrayscaleColorProfileName

The name of a color profile for grayscale outputs. By default, the editor uses the Dot Gain 30% profile to render hi-res outputs in grayscale.

Declaration

hiResOutputGrayscaleColorProfileName?: string

Property Value

Type	Description
string

hiResOutputInStringPlaceholderHintsEnabled

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

Declaration

hiResOutputInStringPlaceholderHintsEnabled?: boolean

Property Value

Type	Description
boolean

hiResOutputJpegCompressionQuality

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

hiResOutputJpegCompressionQuality?: number

Property Value

Type	Description
number

hiResOutputPdfMetadata

PDF metadata to be saved in the hi-res output. You can save such data as a document title, author and creator names, keywords, and a document subject.

Declaration

hiResOutputPdfMetadata?: IPdfMetadata

Property Value

Type	Description
IPdfMetadata

hiResOutputRgbColorProfileName

The name of an RGB color profile for the hi-res output. By default, the editor uses the sRGB IEC61966-2.1 profile to render hi-res outputs in RGB.

Declaration

hiResOutputRgbColorProfileName?: string

Property Value

Type	Description
string

hiResOutputRotateMode

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

hiResOutputRotateMode?: string

Property Value

Type	Description
string

hiResOutputToSeparateFiles

If true, the hi-res output for each page of a multipage product will be put in a separate file. The default value is false.

Declaration

hiResOutputToSeparateFiles?: boolean

Property Value

Type	Description
boolean

proofImageCropSafetyLine

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. For details, see the Proof images topic.

Declaration

proofImageCropSafetyLine?: string

Property Value

Type	Description
string

proofImageFileFormat

The type of proof image files; it can be either "JPEG" or "PNG". The default value is "JPEG".

Declaration

proofImageFileFormat?: string

Property Value

Type	Description
string

proofImageFlipMode

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

Declaration

proofImageFlipMode?: string

Property Value

Type	Description
string

proofImageInStringPlaceholderHintsEnabled

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

Declaration

proofImageInStringPlaceholderHintsEnabled?: boolean

Property Value

Type	Description
boolean

proofImageInterpolationMode

An 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 others. By default, no interpolation algorithms are applied to resize proof images.

Declaration

proofImageInterpolationMode?: string

Property Value

Type	Description
string

proofImageMockupEnabled

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

Declaration

proofImageMockupEnabled?: boolean

Property Value

Type	Description
boolean

proofImageRgbColorProfileName

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.

Declaration

proofImageRgbColorProfileName?: string

Property Value

Type	Description
string

proofImageRotateMode

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

proofImageRotateMode?: string

Property Value

Type	Description
string

proofImageSafetyLinesEnabled

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

Declaration

proofImageSafetyLinesEnabled?: boolean

Property Value

Type	Description
boolean

proofImageShowStubContent

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

Declaration

proofImageShowStubContent?: boolean

Property Value

Type	Description
boolean

proofImageSpineAndFoldingLinesEnabled

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

Declaration

proofImageSpineAndFoldingLinesEnabled?: boolean

Property Value

Type	Description
boolean