render-preview

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

This task renders a real-size page preview 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

• previewImagePrintAreaFilter (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").
• previewImageWidth (number) - The width of the preview image in pixels.
• previewImageHeight (number) - The height of the preview image in pixels.
• previewImageInterpolationMode (string) - (optional) The interpolation mode (High, Medium, Low, NearestNeighbour, Linear, Cubic, Supersampling, Lanczos, Anisotropic4, Anisotropic9, Lanczos3). The default value is Anisotropic9.
• previewImageFileFormat (string) - The output file format for the preview image, either Jpeg or Png.
• previewShowStubContent (boolean) - (optional) Determines whether StubContent should be displayed for image placeholders. The default value is true.
• previewShowMockup (boolean) - (optional) Determines whether a mockup should be displayed in the preview. The default value is true.

These parameters support argument interpolation following the common rules.

Example

{
    "description": "Prepare preview file",
    "name": "rendering preview",
    "type": "render-preview",
    "inputArtifacts": [
        "design"
    ],
    "parameters": {
        "previewImagePrintAreaFilter" : "1,2-1000",
        "previewImageWidth": 500,
        "previewImageHeight": 500,
        "previewImageInterpolationMode": "Anisotropic9",
        "previewImageFileFormat": "Jpeg",
        "previewShowStubContent": true,
        "previewShowMockup": false
    },
    "outputArtifacts": [
        "preview*"
    ]
}