View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

Config Reference

Applies to: Customer's Canvas On-Premises; Preflight Tool 1.7.2, 1.0.0-1.8.3 (may differ) · Archived documentation

In the distribution package, you can find the config.json file. This file configures both the multistep editor (not covered in this topic) and the Preflight Tool widget. In this file, you must define such properties as the URL of the server component, preflight rules, and front-end parameters.

Note

You can load this configuration from an external file (as in the provided sample), define it as a variable in JavaScript code, or even read it from your database.

Front-end parameters allow you to set up the workflow and appearance of this tool. Now, let's see how you can configure the preflight widget. The following example represents the params.config object and shows how you can specify a 720 x 576 pt product with 300 dpi, configure the bleed zone, set a preflight rule to check the color space, and enable a button to upload the users' files.

JSON 
{
    "language": "en",
    "backendUrl": "https://pt.example.com/",
    "startFromUploader": true,
    "uploader": {
        "fileTypes": [".pdf", ".jpg", ".jpeg"],
        "multiple": true,
        "initialMode": "default"
    },
    "product": {
        "allowAddPages": true,
        "allowDeletePages": true,
        "pages": [{title: 'First'}, {title: 'Second'}],
        "dpi": 300,
        "bleed": 20,
        "size": {
            "width": 720,
            "height": 576
        },
        "safetyLines": [{
            "name": "bleed",
            "margin": 40
            "color": "#00ff00",
            "altColor": "#00ff00",
            "stepPx": 5,
            "widthPx": 1,
            "borderRadius": 0,
            "legend": {
                "title": 720,
                "description": 576
            }
        }]
    },
    "viewer": {
        "locked": false,
        "shadeBleedZone": false,
        "bleedZoneColor": "",
        "keepAspectRatio": false,
        "rulers": {
            "enabled": true,
            "unit": "inch",
            "customUnitScale": 1,
            "origin": { "x": 0, "y": 0 }
        },
        "zoom": {
            "min": 0.2,
            "max": 1.2,
            "default": 1,
            "step": 0.1
        }
    },
    "rules": [{
        "type": "colorspace",
        "severity": "error",
        "enableFix": true,
        "params": {
            "allowedColorSpaces": ["cmyk"]
        }
    }],
    "rendering": {
        "hiResOutputToSeparateFiles": false,
        "trimPreviewOnBleed": true,
        "previewSize": {
            "width": 800,
            "height": 800
        }
    },
    "interface": {
        "topToolbar": [{
            "name": "upload"
        }]
    }
}

Now, let's see the description of these configuration parameters and their values.

Name Data type Description
language string The language of the user interface, either "en" or "nl". The default value is "en".
backendUrl string The URL that links to the running back end.
startFromUploader boolean If true, displays the file uploader when opening the Preflight Tool. The default value is true.

The file uploader

object: uploader

Name Data type Description
fileTypes array containing any combination of ".pdf", ".ai", ".jpg", ".jpeg", ".tiff", ".eps", ".psd", ".png" Extensions of files that a user is allowed to upload to the Preflight Tool. The default value is [".pdf"].
multiple boolean If true, this parameter enables multiple selections of files to be uploaded. In this case, the Preflight Tool creates a multipage document, and the page order is the same as their upload order. The number of the uploaded pages cannot exceed the product.pages value. The default value is true.
initialMode "fitToBleed", "fitToTrim", "fillToTrim", "fillToBleed", "default" Defines how the file should be adjusted after it is uploaded. You can fit or fill the file to the product BleedBox and TrimBox. By default, the file is inserted as is.

Products

object: product

Name Data type Description
allowAddPages boolean Allows users to add new pages to the product. The default value is false.
allowDeletePages boolean Allows users to delete pages from the product. The default value is false.
pages number | Page[] | PageLimit Defines either an array of product pages or the number of pages. A Page object contains a title property and allows you to define page titles in the user interface. PageLimit contains the init, min, and max properties and allows you to set the initial number of pages as well as page number limits. The default value is 1. For details, see the Frequently Asked Questions.
dpi number The resolution of the output image. The default value is 300.
bleed number | IMarginLTRB | IMarginHV The bleed zone. This margin extends the resulting image. The default value is 0.
The product size
object: size
width number The width of the resulting image, in points.
height number The height of the resulting image, in points.
Safety lines on the previews
object: safetyLines
name string The name of the safety lines, an arbitrary string.
margin number The distance between safety lines and design bounds.
color string The main color of safety lines in the CSS format.
altColor string The alternative color of safety lines in the CSS format.
stepPx number The length of the safety line dashes.
widthPx number The width of safety lines.
borderRadius string or number The definition of rounded corners in the CSS format. For details, see the Safety Lines topic.
The safety line description
object: legend
title string The title of the safety line, which appears on the right panel.
description string The description of the safety line, which appears on the right panel.

The Viewer

object: viewer

Name Data type Description
locked boolean If true, does not allow for manipulating elements. The default value is false.
shadeBleedZone boolean If true, applies the bleedZoneColor to the bleed zone. The default value is false.
bleedZoneColor string The color of the bleed zone is applied when shadeBleedZone is true. The default value is "cmyk(0%,0%,0%,50%,50%)".
keepAspectRatio boolean If true, maintains the design aspect ratio. The default value is true.
Rulers
object: rulers
enabled boolean Displays the rulers. The default value is true.
unit "inch", "mm", "cm", "point", "custom" The measurement unit of the rulers. The default value is 'inch'.
customUnitScale number The ratio of the custom unit to points. This parameter is applied only if the unit parameter is set to "custom". For more details, you can refer to the Markings topic. The default value is 1.
origin object The point of origin relative to the upper-left corner of the design. The coordinates are measured in the units specified by the unit parameter. The default value is { "x": 0, "y": 0 }.
Viewer zoom
object: zoom
min number The minimum zoom of the viewer. The default value is 0.1.
max number The maximum zoom of the viewer. The default value is 1.5.
default number The initial zoom value of the viewer. The default value is 1.
step number The step of increasing or decreasing the zoom level of the viewer. The default value is 0.1.

Preflight rules

object: rules

Name Data type Description
type "colorspace", "spotcolors", "resolution", "safetyboxes", "nomargins", "insideBleedbox", "sameorientation", "forbiddenfonts", "allowedfonts", "fonttypes", "minfontsize", "textascurves", "embeddedfonts" The rule type.
severity "error", "warning" The rule severity. All errors must be fixed before rendering the resulting image, whereas warnings may remain on the design.
enableFix boolean If true, displays the Fix button to autofix errors.
params object Parameters of the rule depending on its type. For more details, see the Preflight Rules topic.

Rendering settings

object: rendering

Name Data type Description
hiResOutputToSeparateFiles boolean If true, the hi-res output for each page of a multipage product is put in a separate file. The default value is false.
trimPreviewOnBleed boolean If true, trims preview images and page thumbnails to the Bleed area. The default value is true.
The size of preview images.
object: previewSize
width number The width of preview images, in pixels.
height number The height of preview images, in pixels.

The user interface

object: interface

Name Data type Description
Top Toolbar buttons
array: topToolbar
name string The button name. In the current implementation, you can use the following button names: "upload", "fitToBleed", "fitToTrim", "center", "reset", "keepAspectRatio".

See Also

Manual