render-hires

• Last updated on May 27, 2025
• •
• 4 minutes to read

This task renders a state file from the Design Editor with the specified parameters.

Note

The rendering is performed based on the settings specified in this task. The rendering settings configured in the editor will be ignored.

Parameters

General

• hiResOutputPdfTextMode (string) - Determines the text rendering mode in PDF. Possible values: Outlines | Text. Default is Outlines.
• hiResOutputPrintAreaFilter (string) - Filters print areas that need to be rendered. Single pages (for example, "1, 3, 7") and ranges (e.g., "2-9, 11-22") are supported. To define a maximum value, you can pass a deliberately large number (e.g., "2-1000") or the marker "N" (e.g., "2-N").
• hiResOutputArchiveType (string) - If specified, the rendering result will be packed into an archive. Possible values are Zip | SevenZip. By default, this value is not specified.
• hiResOutputArchiveCompressionType (string) - An archive compression type. Possible values are None | Copy | Default | Deflate | Deflate64 | Lzma | Lzma2. The default value is Default.
• hiResOutputPdfKeepOriginalColors (boolean) - When True, the color profile is ignored, and the original colors of the images loaded into the design are preserved. Possible values: True or False. Default is False.

Rendering Parameters

• hiResOutputDpi (integer) - Defines the image resolution in dots per inch (DPI). Default is 300.
• hiResOutputFileFormat (string) - Specifies the type of the hi-res output. Possible values: "PDF", "JPG", "PNG", "TIFF". Default is "PDF".
• hiResOutputColorSpace (string) - Determines the color space of the hi-res output. Possible values: "cmyk", "rgb", "grayscale". Default is "cmyk".
• hiResOutputBackgroundColor (string) - Specifies the background color for the hi-res output. Default is "rgba(255,255,255,0)".
• hiResOutputCompression (string) - Specifies the type of hi-res output compression. Possible values: "jpeg", "zip", "none", "lzw". Default is "jpeg".
• hiResOutputJpegCompressionQuality (integer) - Specifies JPEG compression quality in percent. Default is 90.
• hiResOutputInStringPlaceholderHintsEnabled (boolean) - Displays hints for unfilled in-string placeholders in hi-res outputs. Default is false.
• hiResOutputPdfFormat (string) - If "X4", enables DeviceCMYK and does not embed any color profile into the resulting PDF file in the PDF/X-4 standard. Default is "Default".

Color Profiles

• hiResOutputRgbColorProfileName (string) - Specifies the name of an RGB color profile. Default is "sRGB IEC61966-2.1".
• hiResOutputCmykColorProfileName (string) - Specifies the name of a CMYK color profile. Default is "SWOP (Coated) 20%, GCR, Medium".
• hiResOutputGrayscaleColorProfileName (string) - Specifies the name of a color profile for grayscale outputs. Default is "Dot Gain 30%".
• hiResOutputDestinationColorProfileName (string) - Specifies the name of a color profile for the CMYK preview mode. Default is "SWOP (Coated) 20%, GCR, Medium".

Multipage Products

• hiResOutputToSeparateFiles (boolean) - If true, the hi-res output for each side of a multipage product will be put in a separate file. Default is false.

Flipping Hi-res Outputs

• hiResOutputFlipMode (string) - Defines the page reflection mode for the print file. Possible values: None, Horizontal, Vertical, or Both. Default is None.
• hiResOutputRotateMode (string) - Determines the page rotation mode for the print file. Possible values: None | Rotate90 | Rotate180 | Rotate270 | Auto. Default is None.

Channel Containers

• hiResOutputChannelContainersToSeparateFiles (boolean) - Enables rendering spot colors and textures to separate PDF files. Default is false.

• 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. Default is true.

• hiResOutputExplicitContainerVisibility (object) - Defines what containers must be hidden or shown during rendering. For example, you can hide the Background container and render the Main container as follows:

  "hiResOutputExplicitContainerVisibility": {
      "Background": false,
      "Main": true
  }
  

Setting up PDF Metadata

• hiResOutputPdfAuthor (string) - Metadata property "Author" for the PDF format.
• hiResOutputPdfCreator (string) - Metadata property "Creator" for the PDF format.
• hiResOutputPdfKeywords (string) - Metadata property "Keywords" for the PDF format.
• hiResOutputPdfSubject (string) - Metadata property "Subject" for the PDF format.
• hiResOutputPdfTitle (string) - Metadata property "Title" for the PDF format.

Note

If a single artifact (result) is expected as output, all generated print files will be packed into one archive.

If a collection of artifacts (result*) is expected as output, each generated print file will be packed into a separate archive.

Example

{
    "description": "Prepare print file",
    "name": "rendering hires",
    "type": "render-hires",
    "inputArtifacts": [
        "design"
    ],
    "parameters": {
        "hiResOutputPrintAreaFilter": "1,2-1000",
        "hiResOutputDpi": 200,
        "hiResOutputFileFormat": "png",
        "hiResOutputColorSpace": "rgb",
        "hiResOutputRgbColorProfileName": "",
        "hiResOutputCmykColorProfileName": "",
        "hiResOutputGrayscaleColorProfileName": "",
        "hiResOutputToSeparateFiles": true,
        "hiResOutputChannelContainersToSeparateFiles": false,
        "hiResOutputChannelContainersRenderEmptyPage": true,
        "hiResOutputCompression": "Jpeg",
        "hiResOutputJpegCompressionQuality": 90,
        "hiResOutputArchiveType": "Zip",
        "hiResOutputArchiveCompressionType": "LZMA",
        "hiResOutputFlipMode": "None",
        "hiResOutputPdfAuthor": "",
        "hiResOutputPdfCreator": "",
        "hiResOutputPdfKeywords": "",
        "hiResOutputPdfSubject": "",
        "hiResOutputPdfTitle": "",
        "hiResOutputInStringPlaceholderHintsEnabled": false
    },
    "outputArtifacts": [
        "result*"
    ]
}