Skip to main content

Interface: IRenderingProperty

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

Remarks​

For details, see Configuring Print Files topic.

Example​

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

Properties​

hiResOutputToSeparateFiles?​

optional hiResOutputToSeparateFiles?: boolean

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.

hiResOutputChannelContainersToSeparateFiles?​

optional hiResOutputChannelContainersToSeparateFiles?: boolean

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

hiResOutputChannelContainersRenderEmptyPage?​

optional hiResOutputChannelContainersRenderEmptyPage?: boolean

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.

hiResOutputDpi?​

optional hiResOutputDpi?: number

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

hiResOutputFileFormat?​

optional hiResOutputFileFormat?: 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".

hiResOutputColorSpace?​

optional hiResOutputColorSpace?: string

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

hiResOutputBackgroundColor?​

optional hiResOutputBackgroundColor?: string

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

hiResOutputCompression?​

optional hiResOutputCompression?: 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". The default value is "jpeg".

hiResOutputJpegCompressionQuality?​

optional hiResOutputJpegCompressionQuality?: 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.

hiResOutputFlipMode?​

optional hiResOutputFlipMode?: string

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

hiResOutputRotateMode?​

optional hiResOutputRotateMode?: 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".

hiResOutputPdfMetadata?​

optional hiResOutputPdfMetadata?: IPdfMetadata

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.

hiResOutputInStringPlaceholderHintsEnabled?​

optional hiResOutputInStringPlaceholderHintsEnabled?: boolean

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

hiResOutputRgbColorProfileName?​

optional hiResOutputRgbColorProfileName?: string

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.

hiResOutputCmykColorProfileName?​

optional hiResOutputCmykColorProfileName?: string

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.

hiResOutputGrayscaleColorProfileName?​

optional hiResOutputGrayscaleColorProfileName?: string

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.

hiResOutputDestinationColorProfileName?​

optional hiResOutputDestinationColorProfileName?: string

The name of the destination color profile for hi-res outputs. If present then cmyk-mode is enabled with the corresponding destination color profile.

proofImageFileFormat?​

optional proofImageFileFormat?: string

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

proofImageSafetyLinesEnabled?​

optional proofImageSafetyLinesEnabled?: boolean

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

proofImageCropSafetyLine?​

optional proofImageCropSafetyLine?: 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. For details, see the Configuring Proof Images topic.

proofImageFlipMode?​

optional proofImageFlipMode?: string

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

proofImageRotateMode?​

optional proofImageRotateMode?: 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".

proofImageSpineAndFoldingLinesEnabled?​

optional proofImageSpineAndFoldingLinesEnabled?: boolean

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

proofImageMockupEnabled?​

optional proofImageMockupEnabled?: boolean

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

proofImageShowStubContent?​

optional proofImageShowStubContent?: boolean

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

proofImageInterpolationMode?​

optional proofImageInterpolationMode?: string

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.

proofImageInStringPlaceholderHintsEnabled?​

optional proofImageInStringPlaceholderHintsEnabled?: boolean

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

proofImageRgbColorProfileName?​

optional proofImageRgbColorProfileName?: string

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.

proofImageUsePrintAreasAsClippingMasks?​

optional proofImageUsePrintAreasAsClippingMasks?: boolean

When rendering proof, the print area is overlaid on the content as a clipping mask.. The default value is false.

Was this page helpful?