render-hires

• Last updated on February 29, 2024
• •
• 1 minute 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

• 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) - (optional) 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) - (optional) An archive compression type. Possible values are None | Copy | Default | Deflate | Deflate64 | Lzma | Lzma2. The default value is Default.

• hiResOutputPdfTextMode (string) - (optional) If Text, saves text elements as text. By default, this property is Outlines, and text is rendered as a set of vector paths.

• hiResOutputExplicitContainerVisibility (object) - (optional) 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
  }
  

For other rendering properties, refer to the Hi-res print files topic.

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*"
    ]
}