clientConfig.json

This topic describes the Customer's Canvas configuration settings. The ~\Configuration\clientConfig.json configuration file allows you to specity settings of the web-to-print editor.

Note

The default measurement units in Customer's Canvas are points. If a parameter accepts other units, then the unit name is specified in the parameter name, for example, lineWidthPx accepts pixels. The unit shortcuts are px for pixels, pc for percents, etc.

Parameter names are case sensitive.

The clientConfig.json file contains the following default settings. You can click a setting name to get its description.

JSON
{
    "spellCheckEnabled": false,
    "initialMode": "Simple",
    "fontList": ["Arial", "Browallia New", ... ],
    "fontListMode": "Advanced",
    "defaultLanguage": "en",
    "loadUserInfoButtonEnabled": false,
    "autoLoadUserInfo": false,
    "revertProductConfirmationEnabled": true,
    "imageEditorEnabled": true,
    "deleteItemConfirmationEnabled": true,
    "restoreProductOnReloadEnabled": true,
    "alignToSafetyLineName": "bleed",
    "newImageName": null,
    "arbitraryResizeForImageItemEnabled": false,
    "variableItemsMaskSymbol": "%",
    "galleryOnly": false,
    "backgroundUpdateParams": {
        "foldedMode": {
            "enabled": false,
            "flip": false
        }
    },
    "canvas": {
        "containerColor": "",
        "color": "",
        "shadowEnabled": true,
        "paddingPct": 5,
        "zoomStep": 0.15,
        "pinchZoomEnabled": true,
        "maskedPlaceholderUnderscoreEnabled": true,
        "suppressOutOfRegionManipulation": true,
        "rulers": {
            "enabled": true,
            "unit": "inch",
            "customUnitScale": "1",
            "origin": "{ "X": 0, "Y": 0 }"
        },
        "snapLines": {
            "enabled": true,
            "color": "rgb(255,0,255)",
            "tolerance": 5
        }
    },
    "grid": {
        "enabled": true,
        "horizontalColor": "rgb(208, 224, 227)",
        "verticalColor": "rgb(208, 224, 227)",
        "stepX": 1,
        "stepY": 1,
        "lineWidthPx": 1
    },
    "rendering": {
        "hiResOutputDpi": 300,
        "hiResOutputFileFormat": "pdf",
        "hiResOutputColorSpace": "RGB",
        "hiResOutputToSeparateFiles": false,
        "hiResOutputBackgroundColor": "rgba(255,255,255,0)",
        "hiResOutputCompression": "zip",
        "hiResOutputJpegCompressionQuality": 90,
        "hiResOutputFlipMode": "none",
        "hiResOutputPdfMetadata": {
            "author": "",
            "creator": "",
            "keywords": "",
            "subject": "",
            "title": ""
        },
        "proofImageFileFormat": "PNG",
        "proofImageWatermarkEnabled": true,
        "proofImageWatermarkFontPostScriptName": "ArialMT",
        "proofImageWatermarkFontSize": 35,
        "proofImageWatermarkText": "watermark",
        "proofImageCropSafetyLine": "bleed",
        "proofImageSafetyLinesEnabled": false,
        "proofImageSpineAndFoldingLinesEnabled": true,
        "proofImageFlipMode": "none",
        "proofImageMockupEnabled": true
    },
    "watermark": {
        "text": {
            "text": "",
            "fontSettings": {
                "postScriptName": "ArialMT",
                "size": 8,
                "fauxBold": false,
                "fauxItalic": false
            },
            "scale": 0.28,
            "opacity": 0.1
        },
        "image": {
            "name": "",
            "repeat": true,
            "opacity": 0.1
        },
        "visibility": {
            "proof": true,
            "canvas": false
        }
    },
    "widgets": {
        "common": {
            "fontSize": {
                "max": 100,
                "min": 4,
                "step": 10
            },
            "tracking": {
                "max": 300,
                "min": -150,
                "step": 25
            },
            "leading": {
                "max": 100,
                "min": 6,
                "step": 10
            }
        },
        "LeftToolbar": {
            "buttons": null,
            "disabled": false,
            "imageButtonEnabled": true,
            "textButtonEnabled": true,
            "rectangleButtonEnabled": true,
            "ellipseButtonEnabled": true,
            "linearBarcodeButtonEnabled": true,
            "qrCodeButtonEnabled": true,
            "richTextButtonEnabled": true
        },
        "ObjectInspector": {
            "bgItemEnabled": true,
            "dndEnabled": true,
            "qualityMeterEnabled": true,
            "safetyLineViolationWarningEnabled": true,
            "regionViolationWarningEnabled": false,
            "variableItemsEnabled": false,
            "emptyListTextEnabled": true,
            "position": "Left",
            "aboveCanvasOnSmallScreenEnabled": false,
            "isHidden": false
        },
        "ItemMenu": {
            "objectManipulationEnabled": true,
            "verticalAlignmentEnabled": true,
            "horizontalAlignmentEnabled": true,
            "changeZOrderEnabled": true
        },
        "TopToolbar": {
            "alignButtonsEnabled": true,
            "displayAlignButtonsAsDropdown": false,
            "historyButtonsEnabled": true,
            "deleteButtonEnabled": false,
            "revertButtonEnabled": true,
            "zOrderButtonsEnabled": false,
            "displayZOrderButtonsAsDropdown": false,
            "cloneButtonEnabled": false,
            "textVAlignmentButtonsEnabled": true,
            "textAlignmentButtonsEnabled": true,
            "textEmphasisButtonsEnabled": true,
            "textFontFamilyButtonEnabled": true,
            "textFontStyleButtonEnabled": true,
            "textFontSizeButtonEnabled": true,
            "textFontColorButtonEnabled": true,
            "textShadowButtonEnabled": true,
            "textStrokeButtonEnabled": true,
            "closeFontMenuOnClickEnabled": true,
            "opacitySliderEnabled": true,
            "textLeadingButtonEnabled": true,
            "textTrackingButtonEnabled": true,
            "multiRowModeEnabled": false,
            "borderColorButtonEnabled": true,
            "imageEditButtonEnabled": true,
            "imageSelectButtonEnabled": true,
            "placeholderSelectButtonEnabled": true,
            "placeholderScaleButtonEnabled": true,
            "placeholderResetContentButtonEnabled": true,
            "fontPreviewSize": 17,
            "fontSize": {
                "max": 100,
                "min": 4,
                "step": 0.5
            }
        },
        "BottomToolbar": {
            "safetyLinesCheckboxEnabled": true,
            "gridCheckboxEnabled": true,
            "snapLinesCheckboxEnabled": true,
            "zoomValueEnabled": true,
            "zoomButtonsEnabled": true,
            "fullWindowButtonEnabled": true,
            "fullScreenButtonEnabled": true,
            "surfaceSwitchEnabled": true,
            "surfaceSwitch": {
                "enabled": true,
                "showThumbnails": true,
                "showSurfaceNames": false,
                "scrollPageButtonsEnabled": true,
                "toggleSurfaceButtonsEnabled": false,
                "firstAndLastButtonsEnabled": true,
                "specificForSurfaceCount": { }
            }
        },
        "QrCodeDialog": {
            "defaultType": "QrVCard"
        },
        "LinearBarcodeDialog": {
            "defaultType": "LinearEan8"
        },
        "RichTextDialog": {
            "applyToAllTextMode": false,
            "bgColor": "white",
            "createMultiColumnText": false,
            "showHint": true,
            "ckeditorConfig": {
                "specialChars": ["!", """, "#", "$", "%", "&", ...]
			},
            "textOutline": {
                "enabled": false,
                "hueThreshold": 74,
                "brightnessThreshold": 5,
                "color": "rgba(0, 0, 0, 0.2)"
            },
            "zoom": {
                "enabled": false,
                "minZoomPct": 10,
                "maxZoomPct": 500,
                "autoZoom": {
                    "enabled": false,
                    "minFontSizeThresholdPt": 12,
                    "maxFontSizeThresholdPt": 36
                }
            }
        },
        "FinishButton": {
            "mode": "Download"
        },
        "GalleryDialog": {
            "defaultTabName": "",
            "tabs": null,
            "publicTabEnabled": true,
            "publicFolderName": "",
            "userTabEnabled": true,
            "defaultTab": "user",
            "downloadPsdAsImage": true,
            "allowedExtensions": ["jpeg", "gif", "png", "jpg", "bmp", "pdf"],
            "overwriteExistingFiles": false,
            "showTabsInRestrictedMode": false,
            "backgroundColorPickerEnabled": false,
            "insertToAllButtonEnabled": false,
            "socialNetworkAppIds": {
                "instagram": "",
                "facebook": ""
            }
        },
        "ImageEditorDialog": {
            "colorAdjustButtonEnabled": true,
            "cropButtonEnabled": true,
            "backgroundEraseButtonEnabled": true
        },
        "ColorPicker": {
            "showPaletteOnly": false,
            "palette": [["rgb(0, 0, 0)","rgb(67, 67, 67)",...],...]
        }
    }
}

Common Parameters

Name Description Possible values
spellCheckEnabled Enables spell checking for product text fields and for the Rich text dialog. The default value is false. boolean
initialMode The initial mode of the web-to-print editor, simple or advanced. If you want to disable the advanced mode, set this parameter to "SimpleOnly". The default value is "Simple". "Simple", "Advanced", "SimpleOnly"
fontList A list of fonts available for the user in the editor. All these fonts should be uploaded to the font folder on the server; by default it is ~\Fonts\. The default list is ["Arial", "Browallia New", ... ]. array of font names
fontListMode A mode of the font list, simple or advanced. The simple mode allows users to select a font and set a font size. The advanced mode also provides the ability to change the font style. The default value is "Advanced". "Simple", "Advanced"
defaultLanguage The default interface language. The default value is "en". string
loadUserInfoButtonEnabled Displays the Load my info button. The default value is false. boolean
autoLoadUserInfo If true, then a product is automatically populated with predefined data when it is loaded into the editor; the Load my info button is not displayed in this case. The default value is false. boolean
revertProductConfirmationEnabled Enables the confirmation dialog when reverting a product to its initial state. The default value is true. boolean
imageEditorEnabled Enables the Image Editor. The default value is true. boolean
deleteItemConfirmationEnabled Enables the confirmation dialog when deleting an item from a product. The default value is true. boolean
restoreProductOnReloadEnabled Enables restoring a product state when the design page is reloaded. If false, then the product is reverted on reloading. The default value is true. boolean
alignToSafetyLineName The name of a safety line to which an item will be aligned. If there is no safety line with a name, then the item will be aligned to the first safety line in the safety lines array. The default value is "bleed". string
newImageName The default name for a new image layer: the first layer is named newImageNameValue, the second one is newImageNameValue_1, the third layer is newImageNameValue_2, etc. By default, it is null, and the name of the image file is used. string
arbitraryResizeForImageItemEnabled If it is true, a user can resize added images in the editor without keeping the original aspect ratio. Otherwise, images can only be resized proportionally. The default value is false. boolean
variableItemsMaskSymbol A symbol marking design elements as variable items. By default, it is "%". string
galleryOnly Displays only the Image Gallery containing the private tab; the web-to-print editor is not displayed in this mode. The default value is false. boolean

Background

object: backgroundUpdateParams
The background folded mode
object: foldedMode
enabled Enables the folded mode for backgrounds. The default value is false. boolean
flip Enables the background flip if the folded mode is enabled. The default value is false. boolean

Canvas Settings

Object: canvas

Name Description Possible values
containerColor The color of the HTML element placed under the canvas. The default value is "". color in the css-compatible format
color The canvas color. This color is visible if a transparent object is placed on the canvas. The default value is "". color in the css-compatible format
shadowEnabled Enables the canvas shadow. The default value is true. boolean
paddingPct Padding between the canvas and the canvas viewer, in percent. The default value is 5. integer
zoomStep A step of increasing or decreasing the zoom level. The default value is 0.15. number
pinchZoomEnabled Allows users to zoom the canvas using the pinch gesture on mobile devices. The default value is true. boolean
maskedPlaceholderUnderscoreEnabled Enables displaying underscores in blank masked text layers. If it is set to false and the user has partially filled the text placeholder in, then the rest blank symbols are displayed as spaces. If true, the blank portion of the text layer displays underscores. The default value is true. boolean
suppressOutOfRegionManipulation Disallows the user to drag elements out of the region on the canvas. If true, your users cannot manipulate items out of regions. The default value is true. boolean
Rulers
object: rulers
enabled Displays rulers. The default value is true. boolean
unit The rulers measurement unit. The default value is "inch". "inch", "mm", "cm", "point", "custom"
customUnitScale The ratio of the custom unit to points. This parameter is applied only if the unit parameter described above is set to "custom". The default value is 1. number
origin 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 }. object
Snap Lines
object: snapLines
enabled Displays snap lines. The default value is true. boolean
color The color of snap lines. The default value is "rgb(255,0,255)". string
tolerance The distance between an object and a snap line where the object clings to the line. It is measured in pixels. The default value is 5. number

Grid

Object: grid

Name Description Possible values
enabled Enables the grid. If the grid is enabled it can be toggled by the Grid button. The default value is true. boolean
horizontalColor The color of the horizontal grid lines. The default value is "rgb(208, 224, 227)". color in the css-compatible format
verticalColor The color of the vertical grid lines. The default value is "rgb(208, 224, 227)". color in the css-compatible format
stepX The distance between vertical grid lines. The default value is 1. integer
stepY The distance between horizontal grid lines. The default value is 1. integer
lineWidthPx The width of grid lines in pixels. The default value is 1. integer

Rendering

Object: rendering

Name Description Possible values
hiResOutputDpi Hi-res output resolution in dots per inch (DPI). The default value is 300. integer
hiResOutputFileFormat The type of the hi-res output. The default value is "pdf". "pdf", "jpeg", "png", "tiff"
hiResOutputColorSpace The color space of the hi-res output. The default value is "RGB". "RGB", "CMYK", "Grayscale"
hiResOutputToSeparateFiles If it is true, then the hi-res output for each side of a multipage product is put in a separate file. The default value is false. boolean
hiResOutputBackgroundColor The background color for the hi-res output. The default value is "rgba(255,255,255,0)". color in the css-compatible format
hiResOutputCompression The type of hi-res output compression. "jpeg" and "zip" are supported for PDF files only, whereas "lzw" is supported for TIFF files. The default value is "zip". "jpeg", "zip", "none", "lzw"
hiResOutputJpegCompressionQuality JPEG compression quality in percent. This parameter makes sense only for the JPEG and PDF formats. For PDF it should be used along with hiResOutputCompression="jpeg". The default value is 90. integer from 0 to 100.
hiResOutputFlipMode The flip mode for hi-res outputs. The default value is "none". "none", "vertical", "horizontal", "both"
proofImageFileFormat The type of proof image files. The default value is "PNG". "JPEG", "PNG"
proofImageWatermarkEnabled Displays the watermark on proof images. The default value is true. boolean
proofImageWatermarkFontPostScriptName The watermark font name. The default value is "ArialMT". PostScript font name
proofImageWatermarkFontSize The watermark font size in points. The default value is 35. integer
proofImageWatermarkText Watermark text. The default value is "watermark". string
proofImageCropSafetyLine The name of a safety line which proof images are cropped to. If there is no safety line with the given name, proof images are not cropped. The default value is "bleed". string
proofImageSafetyLinesEnabled Displays safety lines on proof images. The default value is false. boolean
proofImageSpineAndFoldingLinesEnabled Displays spines and folding lines on proof images. The default value is true. boolean
proofImageFlipMode The flip mode for proof images. The default value is "none". "none", "vertical", "horizontal", "both"
proofImageMockupEnabled Displays mockups on proof images. If it is true, then the editor renders a mockup with a print area. If it is false, then the editor renders only print areas to proof images. The default value is true. boolean
PDF metadata
object: hiResOutputPdfMetadata
author The author of the PDF document. string
creator The creator of the PDF document. string
keywords Keywords of the PDF document. string
subject The subject of the PDF document. string
title The title of the PDF document. string

Watermark

Object: watermark

Name Description Possible values

Text Parameters

object: text
text Watermark text. string
scale The font size scale. This parameter specifies how much space the watermark text will occupy relative to the product size. The default value is 0.28. number
opacity The opacity of the watermark text. The default value is 0.1. number
Font parameters
object: fontSettings
postScriptName The watermark font name. The default value is "ArialMT". string
size The font size of the watermark text. number
fauxBold Applies the faux bold effect to the watermark. The default value is false. boolean
fauxItalic Applies the faux italic effect to the watermark. The default value is false. boolean

Image Parameters

object: image
name The filename of the watermark image. This file should be uploaded to the ~\ProductTemplates\watermarks\ folder on the server. string
repeat If false, displays the watermark image in the center of the canvas or proof images. If true, repeats the image. The default value is true. boolean
opacity The opacity of the watermark image. The default value is 0.1. number

Watermark Visibility

object: visibility
proof Displays the watermark on proof images. The default value is true. boolean
canvas Displays the watermark on the canvas. The default value is false. boolean

Widgets

Object: widgets

Name Description Possible values

Common Text Parameters

object: common
Font size parameters
object: fontSize
max The maximum font size. This value is used in the Rich Text dialog. Also, if you do not define font size box parameters for the Top Toolbar, then this value is applied to point text. number
min The minimum font size used in the Rich Text dialog. Also, if you do not define font size box parameters for the Top Toolbar, then this value is applied to point text. number
step The step to change the font size in the Rich Text dialog. number
Tracking parameters
object: tracking
max The maximum tracking value. The default value is 300. number
min The minimum tracking value. The default value is -150. number
step The step to change the tracking value. The default value is 25. number
Leading parameters
object: leading
max The maximum leading value. The default value is 100. number
min The minimum leading value. The default value is 6. number
step The step to change the leading value. The default value is 10. number

Left Toolbar

object: LeftToolbar
buttons Defines configuration of the Left Toolbar buttons. If you define the buttons array, then all properties, which enable and disable buttons (marked as Outdated here), are ignored. The default value is null. For the example, refer to the Using the Image Gallery topic. array
disabled Hides the Left Toolbar. The default value is false. boolean
imageButtonEnabled Outdated. Displays the Add image button in the advanced editing mode. The default value is true. boolean
textButtonEnabled Outdated. Displays the Add text button in the advanced editing mode. The default value is true. boolean
rectangleButtonEnabled Outdated. Displays the Rectangle button in the advanced editing mode. The default value is true. boolean
ellipseButtonEnabled Outdated. Displays the Ellipse button in the advanced editing mode. The default value is true. boolean
linearBarcodeButtonEnabled Outdated. Displays the Barcode option in the advanced editing mode. The default value is true. boolean
qrCodeButtonEnabled Outdated. Displays the QR code option in the advanced editing mode. The default value is true. boolean
richTextButtonEnabled Outdated. Displays the Rich text option in the advanced editing mode. The default value is true. boolean

Object Inspector

object: ObjectInspector
bgItemEnabled Displays the background element in the Object Inspector. The default value is true. boolean
dndEnabled Enables drag-and-drop for elements in the Object Inspector. The default value is true. boolean
qualityMeterEnabled Enables a warning displayed if the selected image has a resolution that is too low. The default value is true. boolean
safetyLineViolationWarningEnabled Enables a warning displayed when the user places an element beyond a safety line. The default value is true. boolean
regionViolationWarningEnabled Enables a warning displayed when the user places an element out of a region. The default value is false. boolean
variableItemsEnabled Enables variable data printing for texts and images. If true, you can mark design elements as variable items in the editor and then personalize them in your e-commerce system. The default value is false. boolean
emptyListTextEnabled Enables text, displayed when a loaded template has no customizable layers. The default value is true. boolean
position Displays the Object Inspector from the right or left side of the canvas. The default value is "Left". "Left", "Right"
aboveCanvasOnSmallScreenEnabled If true, the Object Inspector appears above the canvas when you work on small-screen devices. Otherwise, it appears from the left side of the canvas. The default value is false. boolean
isHidden If it is true, then the editor hides the Object Inspector and expands the canvas to the available width. The default value is false. boolean

Item Menu

object: ItemMenu
objectManipulationEnabled Enables deleting and cloning items in a product. The default value is true. boolean
verticalAlignmentEnabled Enables the vertical alignment of items to the safe area and group alignment (to select several items, use Ctrl). The default value is true. boolean
horizontalAlignmentEnabled Enables the horizontal alignment of items to the safe area and group alignment (to select several items, use Ctrl). The default value is true. boolean
changeZOrderEnabled Enables changing the Z-order of items. The default value is true. boolean

Top Toolbar

object: TopToolbar
alignButtonsEnabled Displays the vertical aligment buttons. The default value is true. boolean
displayAlignButtonsAsDropdown Displays the aligment buttons as a drop-down list. The default value is false. boolean
historyButtonsEnabled Displays the Undo and Redo buttons. The default value is true. boolean
deleteButtonEnabled Displays the Delete button. The default value is false. boolean
revertButtonEnabled Displays the Revert button. The default value is true. boolean
zOrderButtonsEnabled Displays the z-Order buttons. The default value is false. boolean
displayZOrderButtonsAsDropdown Displays the drop-down z-order buttons. The default value is false. boolean
cloneButtonEnabled Displays the Clone object button. The default value is false. boolean
textVAlignmentButtonsEnabled Displays the vertical text alignment buttons. The default value is true. boolean
textAlignmentButtonsEnabled Displays the text alignment buttons. The default value is true. boolean
textEmphasisButtonsEnabled Displays the faux text style buttons (bold, italic, and underlined). The default value is true. boolean
textFontFamilyButtonEnabled Displays the font list. The default value is true boolean
textFontStyleButtonEnabled Displays the font style button. The default value is true. boolean
textFontSizeButtonEnabled Displays the font size spin box. The default value is true. boolean
textFontColorButtonEnabled Displays the text color picker. The default value is true. boolean
textShadowButtonEnabled Displays the Shadow button. The default value is true. boolean
textStrokeButtonEnabled Displays the Stroke button. The default value is true. boolean
closeFontMenuOnClickEnabled If true, the Select font drop-down list closes after a user selects a font. Otherwise, it closes only when a user clicks anywhere outside the list. The default value is true. boolean
opacitySliderEnabled Provides the ability to change layer opacity via the Opacity slider in the Top Toolbar. The default value is true. boolean
textLeadingButtonEnabled Displays the text leading button. The default value is true. boolean
textTrackingButtonEnabled Displays the text tracking button. The default value is true. boolean
multiRowModeEnabled Displays the Top Toolbar menu in the multi-row mode to fit all buttons to the screen. The default value is false. boolean
borderColorButtonEnabled Displays the Border color button in the Top Toolbar. The default value is true. boolean
imageEditButtonEnabled Displays the Edit button for images in the Top toolbar. The default value is true. boolean
imageSelectButtonEnabled Displays the Select image button for images. The default value is true. boolean
placeholderSelectButtonEnabled Displays the Select image button for image placeholders. The default value is true. boolean
placeholderScaleButtonEnabled Displays the Select placeholder content scale button for image placeholders. The default value is true. boolean
placeholderResetContentButtonEnabled Displays the Reset placeholder content button for image placeholders. The default value is true. boolean
fontPreviewSize The font size used to display font names in the Select font list. The default value is 17. number
Font size box parameters
object: fontSize
max The maximum font size. The default value is 100. number
min The minimum font size. The default value is 4. number
step The step for changing a font size when using the spin box. The default value is 0.5. number

Bottom Toolbar

object: BottomToolbar
safetyLinesCheckboxEnabled Displays the Safety lines check box. The default value is true. boolean
gridCheckboxEnabled Displays the Grid check box. The default value is true. boolean
snapLinesCheckboxEnabled Displays the Snap lines check box. The default value is true boolean
zoomValueEnabled Displays the current zoom value. The default value is true. boolean
zoomButtonsEnabled Displays the Zoom in and Zoom out buttons. The default value is true. boolean
fullWindowButtonEnabled Displays the Full window button. The default value is true. boolean
fullScreenButtonEnabled Displays the Full screen button. The full screen mode is not supported in Internet Explorer and Safari, so the related button is not displayed in these browsers even if it is enabled. The default value is true. boolean
surfaceSwitchEnabled Outdated. Define a new surface (page) selector through the surfaceSwitch parameter. This selector is either a swiper for multipage products or the Front side and Back side buttons for double-sided products. The default value is true. boolean
Surface selector
object: surfaceSwitch
enabled Enables the pagination control. The default value is true. boolean
showThumbnails Displays page thumbnails. The default value is true. boolean
showSurfaceNames Displays page names in the pagination control. If it is true and you name your product surfaces, then these names are shown in the navigation area. Otherwise, surface indexes are shown. The default value is false. boolean
scrollPageButtonsEnabled Displays the Next and Previous buttons, which allow for scrolling the page selector. The default value is true. boolean
toggleSurfaceButtonsEnabled Displays the Next and Previous buttons, which allow for switching between pages. The default value is false. boolean
firstAndLastButtonsEnabled Displays the First and Last buttons for the page navigation. The default value is true. boolean
specificForSurfaceCount Defines the pagination control for products consisting of the certain number of pages. You can find an example of using this property in the Multipage Products topic. object

Qr Code Dialog

object: QrCodeDialog
defaultType The default type of a QR code, "QrVCard". "QrVCard", "QrUrl", "QrPhone"

Linear Barcode Dialog

object: LinearBarcodeDialog
defaultType The default type of a barcode, "LinearEan8". "LinearEan8", "LinearEan13"

Rich Text Dialog

object: RichTextDialog
applyToAllTextMode Allows you to apply formatting to a whole rich text field despite a text selection. The default value is false. boolean
bgColor The text background color in the Rich Text dialog. The default value is "white". color in the css-compatible format
createMultiColumnText Allows for creating multicolumn text. If true, the Columns drop-down list appears in the Top Toolbar for rich text fields. The default value is false. boolean
showHint Enables hints in the drop-down lists. The default value is true. boolean
Special characters
object: ckeditorConfig
specialChars An array defining the Special character list. For an example and the default character list, refer to IRichTextDialogConfig. array
Text outline parameters
object: textOutline
enabled Enables text outline. The text is outlined in the Rich Text dialog if the difference between the text color and the background color is below the hue or brightness threshold. The default value is false. boolean
hueThreshold The hue threshold. The default value is 74. number
brightnessThreshold The brightness threshold. The default value is 5. number
color The outline color. The default value is "rgba(0, 0, 0, 0.2)". color in the css-compatible format
Rich text dialog zoom
object: zoom
enabled Enables the zoom slider in the Rich Text dialog. The default value is false. boolean
minZoomPct The least value of the zoom slider, must be less than 100. The default value is 10. number
maxZoomPct The most value of the zoom slider, must be more than 100. The default value is 500. number
Rich text auto-zoom
object: autoZoom
enabled Enables auto-zoom at opening the Rich Text dialog. The default value is false. boolean
minFontSizeThresholdPt The font size threshold in points. If the text font size is less than this threshold, the text is auto-zoomed in. The default value is 12. number
maxFontSizeThresholdPt The font size threshold in points. If the text font size is more than this threshold, the text is auto-zoomed out. The default value is 36. number

Finish Button

object: FinishButton
mode The mode of the Finish design button. "Disabled" hides the button and enables the callback that could be handled like it is discussed in the Handling Product Customization topic. "Download" is the debug mode that shows the button and disables the callback, but allows you to download the hi-res output. The default value is "Download". "Download", "Disabled"

Gallery Dialog

object: GalleryDialog
defaultTabName The default tab opened in the Gallery. It is the name property of an element of the tabs array. The default value is "". string
tabs The array of tabs available in the Gallery. If you define the tabs array, then other properties that define the tabs, marked as Outdated here, are ignored. The default value is null. array
publicTabEnabled Outdated. Displays the Public files tab in the Gallery. The default value is true. boolean
publicFolderName Outdated. Sets a subfolder of the ~\PublicGalleryFolder\ folder containing graphics files, which is displayed in the Public files tab in the Gallery. By default, it is "", and the entire ~\PublicGalleryFolder\ folder content is displayed. string
userTabEnabled Outdated. Displays the My files tab in the Gallery. The default value is true. boolean
defaultTab Outdated. The default tab opened in the Gallery. The default value is "user". "user", "public", "facebook", "instagram"
downloadPsdAsImage Allows for uploading PSD files as either a raster image or a set of PSD layers. The default value is true. boolean
allowedExtensions Extensions of files that a user is allowed to upload to the Gallery. The default value is ["jpeg", "gif", "png", "jpg", "bmp", "pdf"]. array
overwriteExistingFiles Allows for overwriting images with existing names in the Gallery. The default value is false. boolean
showTabsInRestrictedMode Enables the ability to upload photos and select private photos even if the <IAPSF> marker is used. The default value is false. boolean
backgroundColorPickerEnabled Enables the Color Picker when selecting a background. The default value is false. boolean
insertToAllButtonEnabled Enables the Insert to all button allowing your users to change backgrounds of all product surfaces at once. The default value is false. boolean
Social Networks
object: socialNetworkAppIds
instagram Outdated. The identifier of your Instagram application. The default value is "". string
facebook Outdated. The identifier of your Facebook application. The default value is "". string

Image Editor Dialog

object: ImageEditorDialog
colorAdjustButtonEnabled Displays the Adjust button in the Image Editor. The default value is true. boolean
cropButtonEnabled Displays the Crop button in the Image Editor. The default value is true. boolean
backgroundEraseButtonEnabled Displays the Background button in the Image Editor. The default value is true. boolean

Color Picker

object: ColorPicker
showPaletteOnly Shows only the palette specified via the palette parameter in the color picker. The default value is false. boolean
palette The palette displayed in the color picker. The default value is [["rgb(0, 0, 0)","rgb(67, 67, 67)",...],...] two-dimensional array: array of palettes, where each pallete is an array of colors in css-compatible format

See Also

Manual

IFrame API Reference