render-image-preview-with-mockup

• Last updated on April 4, 2025
• •
• Less than a minute to read

This task prepares a preview for the specified artifact (image) using a mockup.

Note

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

Parameters

• mockupId (string) - The ID of the mockup in Asset Storage.
• previewWidth (number) - The width of the preview image in pixels.
• previewHeight (number) - The height of the preview image in pixels.
• previewFormat (string) - The output file format for the preview image, either Jpeg or Png.
• fitMode (string) - The mode for fitting the image, either Fit, Shrink, Resize, or Fill.

These parameters support argument interpolation following the common rules.

Example

{
    "description": "Prepare preview of image file with mockup",
    "name": "render-image-preview-with-mockup",
    "type": "render-image-preview-with-mockup",
    "inputArtifacts": [
        "design"
    ],
    "parameters": {
        "mockupId": "6565dac9c2807e72a406fb7a",
        "previewWidth": 500,
        "previewHeight": 500,
        "previewFormat": "Jpeg",
        "fitMode": "Shrink"
    },
    "outputArtifacts": [
        "preview*"
    ]
}