---
title: "render-preview | Customer's Canvas Hub"
canonical: "https://customerscanvas.com/docs/hub/printer-guide/pipelines/tasks/render-preview/"
---

# render-preview

> Learn how the render-preview task creates real-size page previews of designs.

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

- `previewOutputPrintAreaFilter` (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"`).
- `previewOutputWidth` (number): The width of the preview image in pixels.
- `previewOutputHeight` (number): The height of the preview image in pixels.
- `previewOutputInterpolationMode` (string): _(optional)_ The [interpolation mode](https://www.graphicsmill.com/docs/gm/T_Aurigma_GraphicsMill_Transforms_ResizeInterpolationMode.htm) (`High`, `Medium`, `Low`, `NearestNeighbour`, `Linear`, `Cubic`, `Supersampling`, `Lanczos`, `Anisotropic4`, `Anisotropic9`, `Lanczos3`). The default value is `Anisotropic9`.
- `previewOutputFileFormat` (string): The output file format for the preview image, either `Jpeg` or `Png`.
- `previewOutputShowStubContent` (boolean): _(optional)_ Determines whether StubContent should be displayed for image placeholders. The default value is `true`.
- `previewOutputShowMockup` (boolean): _(optional)_ Determines whether a mockup should be displayed in the preview. The default value is `true`.
- `previewOutputVisualizePrintAreas` (boolean): _(optional)_ Determines whether to visualize print areas. The default value is `false`.

These parameters support [argument interpolation](https://customerscanvas.com/docs/hub/printer-guide/pipelines/concepts/interpolation.md) following the common rules.

## Input Artifacts

- A design file. **Note:** Only a single artifact can be provided as input. Collections are not supported, though the file itself can be single-page or multi-page.

## Output Artifacts

- A set of graphical files in the specified format. Output artifacts can be defined in the following ways:
    - As a list of individual artifacts (e.g., `["result1", "result2"]`). Any extra results are discarded.
    - As a collection of artifacts (e.g., `["result*"]`). **Note:** Only one collection can be specified in this task.

## Example

```json
{
    "description": "Prepare preview file",
    "name": "rendering preview",
    "type": "render-preview",
    "inputArtifacts": [
        "design"
    ],
    "parameters": {
        "previewOutputPrintAreaFilter" : "1,2-1000",
        "previewOutputWidth": 500,
        "previewOutputHeight": 500,
        "previewOutputInterpolationMode": "Anisotropic9",
        "previewOutputFileFormat": "Jpeg",
        "previewOutputShowStubContent": true,
        "previewOutputShowMockup": false
    },
    "outputArtifacts": [
        "preview*"
    ]
}
```