Configuring High Resolution and Proof Images

Configuring Proof Images

For proof images, you can set their file format, specify whether to crop them to safety lines, add watermarks, and set up a preview mockup. The size of proof images is 500 x 500 pixels by default; you can change it using getProofImages or finishProductDesign like it is described in the Introducing the IFrame API topic. The resolution of proof images is 72 DPI and cannot be changed.

You can specify the file format and page orientation, and enable stubs of image and text placeholders by using the following properties:

Watermarks

You can add both text and graphic watermarks to proof images by using the IWatermarkConfig interface. To enable them on proof images, set the visibility.proof property to true.

configuration = {
    watermark: {
        text: {
            text: "watermark",
            fontSettings: {
                postScriptName: "ArialMT",
                size: 14,
                fauxBold: false,
                fauxItalic: false
            },
            opacity: 0.5
        },
        visibility: {
            proof: true
        }
    }
};

Fore more details, refer to the Watermarks topic.

Mockups

You can enable or disable mockups for proof images.

If you set proofImageMockupEnabled to false, then only print areas are rendered to proof images.

Mockups help visualize print products and they are not rendered into hi-res outputs. For example, the following code initializes the product with the envelopeLabel.psd design template and the underlying envelope.png mockup image.

productDefinition = {
    surfaces: [{
        printAreas: [{ designFile: "envelopeLabel" }],
        mockup: { down: "envelope" }
    }]
};

If a mockup is configured in the editor, then, by default, the same mockup is displayed on proof images. In our example, the proof image contains the envelope mockup if you do not specifically set up a different one for previews.

Using different mockups in the editor and for proof images can be useful. For example, if you want to give the user a better idea of what the real product will look like, you can create a proof image with a photographic picture of the product. However, a simpler version of the mockup can be used in the editor to allow the user to focus on the design instead of being distracted by a mockup with too many details.

To set a preview mockup or several preview mockups, do as follows:

productDefinition = {
    surfaces: [{
        printAreas: [{ designFile: "envelopeLabel" }],
        mockup: { down: "envelope" },
        previewMockups: [{ down: "coolEnvelope" }]
    }]
};

For more details, refer to the Mockups topic.

Safety Lines

There are products, like business cards, that are cut after printing. You can set one of the product's safety lines to represent the bleed line to which the product will be cut. If it is not enough to just display the bleed line, you can crop proof images to this line.

To crop proof images to a safety line instead of displaying this line, specify its name as the value of the proofImageCropSafetyLine configuration parameter in clientConfig.json or via the IConfiguration interface.

configuration = {
    rendering: {
        proofImageCropSafetyLine: "bleed"
    }
};
productDefinition = {
    surfaces: [{
        designFile: "calendar", 
        safetyLines: [{
            name: "bleed",
            margin: 8.5,
            color: "rgba(0,0,255,1)",
            altColor: "rgba(255,255,255,0)",
            pdfBox: "Trim"
        }]
    }]
};

If there is no safety line with the given name, proof images are not cropped.

To specify that hi-res outputs should be clipped to safety lines, you can set a PDF page box in the pdfBox property.

Flipping Proof Images

You can flip proof images vertically, horizontally, or in both directions.

There are two ways to set up a flip mode for your product. To set it for all products by default, you should change clientConfig.json or use the IConfiguration interface for a specific product/page as the following example shows.

configuration = {
    rendering: {
        proofImageFlipMode: "horizontal"
    }
};

In order to flip only one specific surface, use ISurfaceDefinition.

productDefinition = {
    surfaces: [
            { proofImage: { flipMode: "both" } }
    ]
}

Technically, flip mode is set for designs only, so neither mockups nor watermarks are flipped.

Configuring Hi-res Outputs

Customer's Canvas generates either vector PDF files or raster JPEG/PNG/TIFF images as the high-resolution output. To avoid any problem with fonts and render products as close as possible to the designs, text is saved to PDF files as vector paths.

For hi-res output, you can set their DPI, file format, image compression parameters, and color space. Color management is always enabled, and you can also specify color profiles for the hi-res output.

The color space and the file type of the hi-res output can also be specified through IFrame API using the IConfiguration interface. For example, the following snippet configures the system to render a product in CMYK PDF files.

configuration = { 
    rendering: {
        hiResOutputColorSpace: "CMYK",
        hiResOutputFileFormat: "PDF",
        hiResOutputDpi: 300
    } 
};

Note, since the PNG format was designed for transferring images on the Internet, it does not support the CMYK color space.

Color Profiles

Customer's Canvas supports both the device-independent and device-dependent color spaces. You can use the following parameters to set up device-independent profiles.

When rendering hi-res outputs, you can define a color space and a specific color profile. Note that the color profile should correspond to the specified color space.

At runtime, you can specify device-independent profiles in the hiResOutputRgbColorProfileName, hiResOutputGrayscaleColorProfileName, and hiResOutputCmykColorProfileFileName parameters of the rendering config, for example:

configuration = {
    rendering: {
        hiResOutputColorSpace: "rgb",
        hiResOutputRgbColorProfileName: "Adobe RGB (1998)",
        proofImageFileFormat: "png",
        proofImageRgbColorProfileName: "Adobe RGB (1998)"
    }
};

You can also specify color profiles for each output color space (grayscale, RGB, and CMYK) for all products in ~/Configuration/Aurigma.DesignAtoms.config, using the RgbColorProfileFileName, CmykColorProfileFileName, and GrayscaleColorProfileFileName parameters, as follows:

<Aurigma.DesignAtoms>
    <add key="ColorProfilesDirectory" value="..\assets\ColorProfiles" />
    <add key="GrayscaleColorProfileFileName" value="grayscaleColorProfile.icc" />
    <add key="RgbColorProfileFileName" value="rgbColorProfile.icc" />
    <add key="CmykColorProfileFileName" value="cmykColorProfile.icc" />
</Aurigma.DesignAtoms>

By default, ICCBased profiles specified with these three settings are used as destinations depending on the color space passed in the hiResOutputColorSpace parameter. For example, if you render the products to a CMYK hi-res output, the profile configured in CmykColorProfileFileName will be picked as the destination profile.

If a graphics object has its own embedded profile, it will be used as the source profile. If it does not have an embedded color profile, then a profile configured in Aurigma.DesignAtoms.config will be used as the source profile depending on the color space of the graphics objects. If the color profiles are not configured in Aurigma.DesignAtoms.config or specified files are missing, then the following standard profiles are applied:

• SWOP (Coated) 20%, GCR, Medium profile for CMYK
• sRGB IEC61966-2.1 profile for RGB
• Dot Gain 30% profile for Grayscale

To render high resolution outputs in a device-dependent color space, set the PdfRenderDeviceProfileEnabled parameter to True.

<Aurigma.DesignAtoms>
    <add key="PdfRenderDeviceProfileEnabled" value="True" />
</Aurigma.DesignAtoms>

In this case, hi-res outputs will not contain any associated color transformation data.

You can find more details in the Color Management in Customer's Canvas topic.

Flipping Hi-res Files

We have already seen how to flip proof images above; this feature is supported for hi-res outputs as well.

The same way as for proof images, in order to set it globally for any product, you should change clientConfig.json.

configuration = {
    rendering: {
        hiResOutputFlipMode: "horizontal"
    }
};

To flip only one surface, use IPrintAreaDefinition.

productDefinition = {
    surfaces: [
            { printAreas: [{ designFile: "BusinessCard2_side1", hiResOutput: { flipMode: "both" } }] }
    ]
}

Setting Up PDF Metadata

If you choose the PDF type of hi-res outputs, you can specify PDF metadata.

To set up metadata globally for any product, pass the following configuration to the loadEditor method or update clientConfig.json with this configuration.

configuration = {
    rendering: {
        hiResOutputPdfMetadata: {
            title: "The red postcard",
            keywords: "red,flower,postcard"
        }
    }
};

Also, you can specify PDF metadata at runtime by using the setPdfMetadata method. For such an example, refer to the Specifying Product Tags topic.

PDF Page Boxes

When you choose the PDF type of hi-res outputs, you can also specify page boxes to crop resulting PDF files. Customer's Canvas supports CropBox, TrimBox, and BleedBox. To specify one of these page boxes, you need to set the pdfBox property to either "Crop", "Trim", or "Bleed" when defining safetyLines. Margins of safety lines are applied to the corresponding PDF page boxes.

productDefinition = {
    surfaces: [{
        designFile: "invitation",
        safetyLines: [
            {
                margin: { horizontal: 8, vertical: 10 },
                color: "rgba(10,200,10,0.7)",
                pdfBox: "Crop"
            }
        ]
    }]
};

Channel Containers

You can design print embellishments in the editor through channel containers. Customer's Canvas allows you to render these channel containers and the base design to the same PDF output file or to separate PDF files.

You can specify how to render channel containers in clientConfig.json or through the IConfiguration interface, for example:

configuration = {
    rendering: {
        hiResOutputFileFormat: "PDF",
        hiResOutputChannelContainersToSeparateFiles: true,
        hiResOutputChannelContainersRenderEmptyPage: true
    }
};

See Also

Manual

• Integration with E-commerce Overview
• Mockups
• Safety Lines
• Color Management in Customer's Canvas
• Specifying Product Tags

IFrame API Reference

• IProductDefinition
• IMockupTemplate
• IConfiguration
• RuntimeConfiguration