render-proof

• Last updated on December 29, 2023
• •
• 1 minute to read

This task prepares proof images for the design specified in artifacts.

Note

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

Parameters

• proofImagePrintAreaFilter (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").
• proofImageWidth (number) - The width of the preview image in pixels.
• proofImageHeight (number) - The height of the preview image in pixels.
• proofImageInterpolationMode - (optional) The interpolation mode (High, Medium, Low, NearestNeighbour, Linear, Cubic, Supersampling, Lanczos, Anisotropic4, Anisotropic9, Lanczos3). The default value is Anisotropic9.
• proofImageFileFormat (string) - (optional) The output file format for the proof image, one of Jpeg, Png, Tiff, or Pdf. The default value is Png.
• proofImageSafetyLinesEnabled (boolean) - (optional) Displays safety lines. The default value is false.
• proofImageWatermarkEnabled (boolean) - (optional) Displays a watermark. The default value is true.
• proofImageSeparateFiles (boolean) - (optional) If true, splits the rendering result into separate files. If false, merges the results into one file for multipage formats like PDF or TIFF. The default value is true.

These parameters support argument interpolation following the common rules.

Example

{
    "description": "Prepare proof image file",
    "name": "rendering proof",
    "type": "render-proof",
    "inputArtifacts": [
        "design"
    ],
    "parameters": {
        "proofImagePrintAreaFilter" : "1,2-1000",
        "proofImageWidth": 500,
        "proofImageHeight": 500,
        "proofImageInterpolationMode": "Anisotropic9",
        "proofImageFileFormat": "Pdf",
        "proofImageSafetyLinesEnabled": false,
        "proofImageWatermarkEnabled": true,
        "proofImageSeparateFiles": false
    },
    "outputArtifacts": [
        "proof*"
    ]
}