Editor config reference
This topic describes all the parameters that allows you to configure the Design Editor. These parameters are represented in the same way as they defined in the ~/Configuration/clientConfig.json file. For an alternative description, you can refer to the JS API reference.
note
The default measurement units in the Design Editor 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, pct for percents, etc.
Parameter names are case sensitive.
You can click a parameter name to get its description.
{
"spellCheckEnabled": true,
"initialMode": "Simple",
"fontList": { "appFonts": ["*"] },
"fontListMode": "Advanced",
"assetSources": { ... },
"defaultLanguage": "en",
"loadUserInfoButtonEnabled": false,
"autoLoadUserInfo": true,
"createGroupsAs": "smart",
"autoImageUploadModeEnabled": false,
"revertProductConfirmationEnabled": true,
"imageEditorEnabled": true,
"deleteItemConfirmationEnabled": true,
"restoreProductOnReloadEnabled": false,
"alignToSafetyLineName": "bleed",
"variableItemsMaskSymbol": "%",
"canvasOnlyMode": false,
"defaultProductTheme": "",
"productThemes": null,
"themeConfiguration": null,
"canvas": {
"color": "#fff",
"shadowEnabled": false,
"paddingPct": 5,
"maskedPlaceholderUnderscoreEnabled": true,
"suppressOutOfRegionManipulation": true,
"violationWarningButtonsEnabled": true,
"qualityChangeContainersEnabled": true,
"floatingItemToolbarCommon Parameters
| Name | Description | Possible values |
|---|---|---|
| spellCheckEnabled | Enables spell checking for product text fields and for the Rich text dialog. The value in the config is true. | 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 value in the config 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 ../assets/fonts/. If not specified, the Design Editor enables all the fonts from this folder. The value in the config is { "appFonts": ["*"] }. | 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 value in the config is "Advanced". | "Simple", "Advanced" |
| assetSources | Configuration of asset sources available in the Asset Manager. By default, only the private user gallery is defined. For config examples, you can refer to the image-manager topic. | object |
| defaultLanguage | The default interface language. The value in the config is "en". | string |
| loadUserInfoButtonEnabled | Displays the Load my info button. The value in the config is false. | boolean |
| autoLoadUserInfo | If true, the 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 value in the config is true. | boolean |
| createGroupsAs | Enables either the "smart" or "base" type for new groups of design elements. So-called smart groups support the auto layout. Your users can change the group type and its properties by using the Smart group button. The value in the config is "smart". | "smart", "base" |
| autoImageUploadModeEnabled | If true, opens a dialog box for selecting a private image to insert it into the placeholder. If false, the Asset Manager opens for selection. The value in the config is false. | boolean |
| revertProductConfirmationEnabled | Enables the confirmation dialog when reverting a product to its initial state. The value in the config is true. | boolean |
| imageEditorEnabled | Enables the Image Editor. The value in the config is true. | boolean |
| deleteItemConfirmationEnabled | Enables the confirmation dialog when deleting an item from a product. The value in the config is true. | boolean |
| restoreProductOnReloadEnabled | Enables restoring a product state when the design page is reloaded in the browser. If false, the product is reverted on reloading. The value in the config is false. | 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 value in the config is "bleed". | string |
| variableItemsMaskSymbol | A symbol marking design elements as variable items. By default, it is "%". | string |
| canvasOnlyMode | Hides all interface elements and displays only the canvas in the editor. The value in the config is false. | boolean |
| defaultProductTheme | The name of the default color theme. For an example, you can refer to the change-theme topic. | string |
| productThemes | The color sets containing the color name - color value pairs. You can define as many themes as you need. For an example, you can refer to the change-theme topic. | object |
| themeConfiguration | Properties that redefine the appearance of the UI theme. In the current implementation, you can change the primary theme color and set a new image for the standard preloader. For an example, you can refer to the IThemeConfiguration topic. | object |
Canvas
Object: canvas
| Name | Description | Possible values |
|---|---|---|
| color | The canvas color. This color is visible if a transparent object is placed on the canvas. The value in the config is "#fff". | color in css-compatible format |
| shadowEnabled | Enables the canvas shadow. The value in the config is false. | boolean |
| paddingPct | Padding between the canvas and the canvas viewer, in percent. The value in the config is 5. | integer |
| maskedPlaceholderUnderscoreEnabled | Enables displaying underscores in blank masked text layers. If 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 displays underscores. The value in the config 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 value in the config is true. | boolean |
| violationWarningButtonsEnabled | Enables preflight warnings on the canvas. If true, notifying icons appear on low-resolution images, safety line violation, region violation, and text clipping. The value in the config is true. | boolean |
| qualityChangeContainersEnabled | Enables the DPI bar when resizing images. This bar displays the actual DPI of images and the resolution specified in the hiResOutputDpi property. The value in the config is true. | boolean |
| floatingItemToolbarEnabled | Enables the Floating Item Toolbar with the Select Image, Edit and Delete buttons right on the canvas. The value in the config is true. | boolean |
| autoItemSelectionEnabled | Allows you to automatically select the first design element in the simple and advanced editing modes. If an element is selected, you can switch between elements using Tab and Shift+Tab. The value in the config is true. | boolean |
| autoPlaceholderEditModeEnabled | Allows your users to work with the content of image placeholders by clicking a placeholder in either simple or advanced edit mode. If true, the Handle does not appear. The value in the config is false. | boolean |
| gridVisible | Displays the grid when the canvas opens. The value in the config is false. | boolean |
| safetyLinesVisible | Displays safety lines when the canvas opens. The value in the config is true. | boolean |
| snapLinesVisible | Displays snap lines when the canvas opens. The value in the config is true. | boolean |
| canvasItemHoverEnabled | Enables text labels for editable design elements. The value in the config is false. | boolean |
| historySize | The number of actions that can be reverted by using the Undo button. The value in the config is 10. Recommended to specify a value less than 100. | number |
| pinchZoomEnabled | Allows users to zoom the canvas using the pinch gesture on mobile devices. The value in the config is true. | boolean |
| textEditor | Specifies the text editor mode when the WYSIWYG editor is active. "default" (platform dependent), "html" (allows IME), "none" (Classic and Rich text editor). | "default", "html", "none" |
| curvedTextBaselineDrawStates | Specifies an array of states in which the path of curved text will be displayed. The value in the config is ["edit", "select", "hover", "move", "rotate", "resize"]. | array of "idle", "edit", "select", "hover", "move", "resize", "rotate" |
| rotatedTextInPlaceEditEnabled | If true, text in rotated and arched elements is edited on the canvas. If false, enables editing in popup boxes. The default value is true. | boolean |
| inactiveContainerTransparencyEnabled | If true, displays the content of spot containers transparent. The default value is true. See Post Press Finishing. | boolean |
| inactiveContainerTransparencyLevel | Defines transparency for inactive containers in range [0, 1]. 0 is opaque, 1 is 100% transparent. The value in the config is 0.8. See Post Press Finishing. | number |
| scrollbarEnabled | Enables scrollbars when the design does not fit the canvas at the current zoom level. The default value is false. | boolean |
Canvas Zoom
Object: canvas.zoom
Rulers
Object: canvas.rulers
| Name | Description | Possible values |
|---|---|---|
| enabled | Displays the canvas rulers. The value in the config is true. | boolean |
| unit | The measurement unit of the rulers. The value in the config is "inch". | "inch", "mm", "cm", "point", "custom" |
| customUnitScale | The ratio of the custom unit to points. Applied only if the unit parameter is set to "custom". The value in the config is 1. | number |
| origin | The point of origin relative to the upper-left corner of the design. The value in the config is { "X": 0, "Y": 0 }. | object |
Canvas Rotation
Object: canvas.rotation
| Name | Description | Possible values |
|---|---|---|
| type | The angle to which the canvas is rotated when clicking the Rotate button in the Bottom Toolbar. The value in the config is "Rotate90". | "Rotate90", "Rotate180", "Rotate270" |
Snap Lines
Object: canvas.snapLines
The snap line type
Objects: items, printArea, safetyLines, region, grid
Bleed and Trim Lines
Object: canvas.printZone
| Name | Description | Possible values |
|---|---|---|
Marking typeobjects:bleed, trim, or region | ||
| color | The main color of lines. The value in the config is "rgb(255,0,0)". | color in css-compatible format |
| altColor | The alternative color. The value in the config is "rgba(255,0,0,0)". | color in css-compatible format |
| step | The step of dashed lines, in pixels. The value in the config is 5. | number |
| width | The width of dashed lines, in pixels. The value in the config is 1. | number |
| visible | If true, displays lines denoting the bleed zone, trim lines, or region, correspondingly. The value in the config is true for bleed and trim and false for region. | boolean |
Item processing rules
Object: canvas.handlers
| Name | Description | Possible values |
|---|---|---|
| placeholderEditingViewMode | Defines how the product will appear on the canvas when editing image placeholders. If "normal", the content that is outside its image placeholder appears transparent when the placeholder is in the edit mode. The "overlay" mode moves the placeholder content to the highest z-order and fades out the area outside this content when entering the edit mode. The value in the config is "overlay". | "overlay", "normal" |
| placeholderCropMode | Enables Adobe Express-like cropping mode for placeholders, allowing intuitive scaling and cropping via grip handles. The default value is true. | boolean |
| placeholderFitMode | Controls the behavior of placeholder resizing since version 7.1.55. If set to "Always", the fit position is preserved regardless of resizing (new behavior in 7.1.55). If set to "Insert", the legacy behavior (pre-7.1.55) is restored, where the fit position may change when resizing. The default value is "Always". | "Always", "Insert" |
| imageMinDpi | The minimum allowable DPI value that can be achieved when resizing images. By default, this limit is not set. | number |
Limit on the minimum item sizeobject:canvas.handlers.resizeLimits | ||
| common | Defines the smallest size, in points, to which items on the canvas can be downsized. You can limit either width, height, or both: {"width":100, "height":50}. The "common" size limit is applicable to all items. In the same way, you can define the limitation separately to "image", "shape", "barcode", "text", "archedText", "rectangle", "ellipse", and "placeholder". Note that these limits only apply to user manipulations on the canvas and do not affect the use of APIs. By default, this limit is not set. | object |
Text Lists
Object: canvas.listSettings
| Name | Description | Possible values |
|---|---|---|
| maxLevel | The maximum number of levels in multilevel lists. The value in the config is 3. | number |
| firstLineIndent | The distance between the bullet and text in the first line of a list item, in points. The value in the config is -20. | number |
| listIndent | The distance between the left edge of the text element and the leftmost line of list items in this text element, in points. The value in the config is 30. | number |
| levelIndent | The offset of each next level of the list relative to the previous level, in points. The value in the config is 40. | number |
| tabOffset | The offset that will appear before text on the first line if this text may overlap the bullet, in points. If this value is not enough to create an indent, it will be added again. The value in the config is 10. | number |
| numberingFormat | The numbered list marker format. If "none", then list items will represent paragraphs without numbers. This marker format will be used when creating lists through the Top toolbar. The value in the config is "number". | "none", "number", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman" |
| bulletChar | The bulleted list marker that will be used when creating lists through the Top toolbar. The value in the config is "•". | symbol |
Default Item Parameters
Object: defaultItemsConfig
| Name | Description | Possible values |
|---|---|---|
| barcode | Default parameters of barcodes, which users add to the canvas. For an example, refer to the IBarcodeItemData topic. | object |
| ellipse | Default parameters of ellipses, which users add to the canvas. For an example, refer to the IEllipseItemData topic. | object |
| image | Default parameters of images, which users add to the canvas. For an example, refer to the IImageItemData topic. | object |
| line | Default parameters of lines, which users add to the canvas. For an example, refer to the ILineItemData topic. | object |
| placeholder | Default parameters of placeholders, which users add to the canvas. For an example, refer to the IPlaceholderItemData topic. | object |
| rectangle | Default parameters of rectangles, which users add to the canvas. For an example, refer to the IRectangleItemData topic. | object |
| richText | Default parameters of rich formatted texts, which users add to the canvas. For an example, refer to the IBoundedTextItemData topic. | object |
| shape | Default parameters of shapes, which users add to the canvas. For an example, refer to the IShapeItemData topic. | object |
| text | Default parameters of texts, which users add to the canvas. For an example, refer to the ITextItemData topic. | object |
| group | Default parameters of SVG, PDF, and PSD assets loaded to the canvas in the group mode. For an example, refer to the IGroupItemData topic. | object |
| clipart | Default parameters of SVG, PDF, and PSD assets loaded to the canvas in the clipart mode. For an example, refer to the IClipartItemData topic. When this object is not defined, the group properties will be applied to clipart. | object |
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 value in the config is true. | boolean |
| horizontalColor | The color of the horizontal grid lines. The value in the config is "rgba(0, 255, 255, 0.2)". | color in css-compatible format |
| verticalColor | The color of the vertical grid lines. The value in the config is "rgba(0, 255, 255, 0.2)". | color in css-compatible format |
| stepX | The distance between vertical grid lines, in the ruler units. The value in the config is 0.25 in. | integer |
| stepY | The distance between horizontal grid lines, in the ruler units. The value in the config is 0.25 in. | integer |
| lineWidthPx | The width of grid lines in pixels. The value in the config is 1. | integer |
Rendering
Object: rendering
| Name | Description | Possible values |
|---|---|---|
| hiResOutputDpi | Hi-res output resolution in dots per inch (DPI). The value in the config is 300. | integer |
| hiResOutputFileFormat | The type of the hi-res output. The value in the config is "pdf". | "pdf", "jpeg", "png", "tiff" |
| hiResOutputColorSpace | The color space of the hi-res output. The value in the config is "cmyk". | "rgb", "cmyk", "grayscale" |
| hiResOutputRgbColorProfileName | The name of an RGB color profile for hi-res outputs. By default, the editor uses the sRGB IEC61966-2.1 profile to render hi-res outputs in RGB. | string |
| hiResOutputCmykColorProfileName | The name of a CMYK color profile for hi-res outputs. By default, the editor uses the SWOP (Coated) 20%, GCR, Medium profile to render hi-res outputs in CMYK. | string |
| hiResOutputGrayscaleColorProfileName | The name of a color profile for grayscale outputs. By default, the editor uses the Dot Gain 30% profile to render hi-res outputs in grayscale. | string |
| hiResOutputToSeparateFiles | If true, the hi-res output for each page of a multipage product is put in a separate file. The value in the config is false. | boolean |
| hiResOutputChannelContainersToSeparateFiles | Renders spot colors and textures to separate PDF files. The value in the config is false. | boolean |
| hiResOutputChannelContainersRenderEmptyPage | Adds empty pages to PDF files when the corresponding pages of the base design have neither spot colors nor textures. The value in the config is true. | boolean |
| hiResOutputBackgroundColor | The background color for the hi-res output. The value in the config is "rgba(255,255,255,0)". | color in 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 value in the config is "jpeg". | "jpeg", "zip", "none", "lzw" |
| hiResOutputJpegCompressionQuality | JPEG compression quality in percent. This parameter makes sense only for the JPEG and PDF formats. For PDF outputs, set hiResOutputCompression to "jpeg". The value in the config is 90. | integer from 0 to 100. |
| hiResOutputFlipMode | Flips hi-res outputs. The value in the config is "none". | "none", "vertical", "horizontal", "both" |
| hiResOutputRotateMode | Rotates hi-res outputs to the specified angle clockwise. By default, the Design Editor does not rotate the original design, and this value is "none". | "none", "rotate90", "rotate180", "rotate270" |
| hiResOutputInStringPlaceholderHintsEnabled | Displays hints for unfilled in-string placeholders in hi-res outputs. The value in the config is false. | boolean |
| hiResOutputPdfFormat | If "X4", enables DeviceCMYK and does not embed any color profile into the resulting PDF file in the PDF/X-4 standard. By default, print files are generated in PDF 1.4. | "Default", "X4" |
| hiResOutputDestinationColorProfileName | Defines the color profile name to preview CMYK colors on the canvas. To enable this preview mode, the AutoTargetDevicePreviewMode param must be True or not included in AppSettings.config. By default, the preview mode is enabled and uses the default destination profile. | string |
| proofImageFileFormat | The type of proof image files. The value in the config is "jpeg". | "jpeg", "png" |
| proofImageRgbColorProfileName | The name of an RGB color profile for proof images. By default, the editor uses the sRGB IEC61966-2.1 profile to render proof images. | 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. By default, proof images appear uncropped. | string |
| proofImageSafetyLinesEnabled | Displays safety lines on proof images. The value in the config is true. | boolean |
| proofImageSpineAndFoldingLinesEnabled | Displays spines and folding lines on proof images. The value in the config is true. | boolean |
| proofImageFlipMode | The flip mode for proof images. The value in the config 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 value in the config is true. | boolean |
| proofImageShowStubContent | Enables the stub images and text hints in unfilled placeholders. The value in the config is false. | boolean |
| proofImageInterpolationMode | An interpolation algorithm used for resizing proof images. You can find the list of supported algorithms in the specification of the Aurigma Graphics Mill library. For example, you can use "Lanczos", "NearestNeighbour", and others. By default, no interpolation algorithms are applied to resize proof images. | string |
| proofImageRotateMode | Rotates proof images to the specified angle clockwise. If "auto" | |
| proofImageRotateMode | Rotates proof images to the specified angle clockwise. If "auto", rotates proof images at the same angle that the canvas is rotated. By default, the Design Editor does not rotate the original design, and this value is "none". | "none", "auto", "rotate90", "rotate180", "rotate270" |
| proofImageInStringPlaceholderHintsEnabled | Displays hints for unfilled in-string placeholders on proof images. The value in the config is false. | boolean |
PDF metadata
Object: rendering.hiResOutputPdfMetadata
| Name | Description | Possible values |
|---|---|---|
| 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 |
Preflight Warnings
Object: violationWarningsSettings
| Name | Description | Possible values |
|---|---|---|
| regionViolationWarningEnabled | Enables a warning displayed if an item goes out of a region. The value in the config is true. | boolean |
| safetyLineViolationWarningEnabled | Outdated. Instead, define the safetyLines object with the "InsideAll" mode. Enables a warning displayed if an item crosses a safety line. The value in the config is true. | boolean |
| textCropViolationWarningEnabled | Enables a warning displayed if the text is too long for the bounding rectangle, and some strings are clipped. The value in the config is true. | boolean |
| shapeViolationsEnabled | Enables a warning displayed if the Asset Manager can import PDF and SVG vector graphics only with losses. The value in the config is true. | boolean |
| tolerance | The distance, in points, within which no warnings about violations of safety lines or the bleed zone will be displayed. The value in the config is 0.001. | number |
| inPlaceNotSupportedWarningEnabled | Enables warnings displayed when text elements have properties that are not supported in the WYSIWYG text engine and when the Classic text engine will render this text. The value in the config is false. | boolean |
Safety lines
Object: violationWarningsSettings.safetyLines
Quality meter
Object: violationWarningsSettings.qualityMeter
| Name | Description | Possible values |
|---|---|---|
| enabled | Enables the quality meter and low DPI warnings. The value in the config is true. | boolean |
| Image quality levels | object: violationWarningsSettings.qualityMeter.qualityLevels | |
| warning | The warning image quality level, comparing to the hi-res output DPI, in percent. This value should be greater than or equal to the bad value. The default is 100. | number |
| bad | The bad image quality level, comparing to the hi-res output DPI, in percent. This value should be less than or equal to the warning value. The default is 50. | number |
Watermark
Object: watermark
Text Parameters
Object: watermark.text
Image Parameters
Object: watermark.image
Watermark Visibility
Object: watermark.visibility
| Name | Description | Possible values |
|---|---|---|
| proof | Displays the watermark on proof images. The value in the config is false. | boolean |
| canvas | Displays the watermark on the canvas. The value in the config is false. | boolean |
Image Resize Requests
Object: imageResizeRequestConfig
| Name | Description | Possible Values |
|---|---|---|
| defaultRequestRatio | Image size increase ratio to request a new image. The value in the config is 0.5. | number |
| rules | List of rules for image resize requests. | array |
Image Resize Rules
Object: imageResizeRequestRule
Widgets
Object: widgets
Common Text Parameters
Object: widgets.common
| Name | Description | Possible values |
|---|---|---|
| textFormattingEnabled | If true, the top toolbar displays the buttons for changing layer properties, and when the user double-clicks a text layer and enters the editing mode, it allows for changing the rich text format on the canvas or Rich Text editor. If false, the top toolbar displays buttons for both changing the layer properties and editing the text, and the user can edit text on the canvas and Object Inspector. The <TATF> marker overrides this behavior for a single text layer, however, <TATF_null> will use the value of this parameter. The value in the config is true. | boolean |
| Font size parameters | object: widgets.common.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: widgets.common.tracking | |
| max | The maximum tracking value. The value in the config is 300. | number |
| min | The minimum tracking value. The value in the config is -300. | number |
| step | The step to change the tracking value. The value in the config is 25. | number |
| Leading parameters | object: widgets.common.leading | |
| max | The maximum leading value. The value in the config is 1296. | number |
| min | The minimum leading value. The value in the config is 6. | number |
| step | The step to change the leading value. The value in the config is 10. | number |
Toolbox
Object: widgets.Toolbox
| Name | Description | Possible values |
|---|---|---|
| enabled | Displays the Toolbox. The value in the config is true. | boolean |
| buttons | Configures the Toolbox buttons. By default, the Design Editor enables the following buttons in the Toolbox: "Text", "RichText", "Image", "Line", "Rectangle", "Ellipse", "QrCode", "LinearBarcode", "DataMatrixBarcode". For config examples, you can refer to the Toolbox topic. This topic also describes how you can predefine properties of design elements. | array |
| containerToolboxes | Configures the Toolbox buttons for channel containers. For config examples, you can refer to the Post Press Finishing topic. | array |
| insertOnTop | If true, each newly added image will appear on top of all the elements. If false, the new image will be considered the background for another image or shape on the top layer and will appear below. The value in the config is false. | boolean |
Asset Manager
Object: widgets.AssetManager
| Name | Description | Possible values |
|---|---|---|
| defaultTabName | The default tab is displayed when you open the Asset Manager; it should be one of the defined tabs. | string |
| enabledBackgroundChange | If true, allows you to open the Asset Manager to select an image for the background. In this case, when you click the background layer, both the Color and Image tabs will be available. If false, the Color picker will only be displayed to change the color. The value in the config is true. | boolean |
| maxUploadFileSize | The maximum size of files that can be uploaded through the Asset Manager, in bytes. This value must be 102400 (100 kB) or more. By default, this value is null, and the size of uploaded files is not limited. | number |
| saveAllowedTabAfterInsert | Allows you to restrict the image selection only to the asset tab from which an image was selected. If true, your users cannot open another tab. The value in the config is false. | boolean |
| tabs | Configures tabs available in the Asset Manager. Before configuring tabs, you must define asset sources for them. By default, the Design Editor enables only the My files tab. | array |
Object Inspector
Object: widgets.ObjectInspector
| Name | Description | Possible values |
|---|---|---|
| bgItemEnabled | Displays the background element in the Object Inspector. The value in the config is true. | boolean |
| dndEnabled | Enables drag-and-drop for elements in the Object Inspector. The value in the config is true. | boolean |
| violationWarningsEnabled | Enables preflight warnings in the Object Inspector. If true, notifying icons appear on low-resolution images, safety line violation, region violation, and text clipping. The value in the config is true. | boolean |
| variableItemsEnabled | Enables check boxes for text elements and images to select variable fields. If true, you can mark design elements as variable items at runtime and then personalize them in your e-commerce system. The value in the config is false. | boolean |
| emptyListTextEnabled | Enables text, displayed when a loaded template has no customizable layers. The value in the config is true. | boolean |
| position | Displays the Object Inspector from the right or left side of the canvas. The value in the config is "Right". | "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 value in the config is true. | boolean |
| isHidden | If it is true, then the editor hides the Object Inspector and expands the canvas to the available width. The value in the config is false. | boolean |
| toggleEnabled | If it is true, then the editor displays the Toggle object inspector button. The value in the config is false. | boolean |
| inStringPlaceholderMode | Defines the appearance of in-string placeholders in the Object Inspector. If "Single", all items appear at the top of the item list. In the "Multiple" mode, linked in-string placeholders appear separately and keep the order defined in PSD templates. The value in the config is "Multiple". | "Single", "Multiple" |
| showItemName | Enables text labels for design elements. The value in the config is false. | boolean |
| groupRenameEnabled | If true, the user can rename group names in the Object Inspector. The value in the config is true. | boolean |
| groupsExpandedByDefault | If true, automatically expands groups in the Object Inspector when loading a product. If false, groups of design elements appear collapsed. The value in the config is false. | boolean |
| expandNestedGroups | If true, allows the user to expand all nested groups when clicking the parent group in the Object Inspector. If false, the user has to click the groups one by one to expand them all. The value in the config is false. | boolean |
| containerTabsEnabled | If true, displays the container tabs. If false, hides the tabs. The value in the config is true. For more details, refer to the Post Press Finishing topic. | boolean |
Item Menu
Object: widgets.ItemMenu
Top Toolbar
Object: widgets.TopToolbar
Bottom Toolbar
Object: widgets.BottomToolbar
| Name | Description | Possible values |
|---|---|---|
| safetyLinesCheckboxEnabled | Displays the Safety lines command on the Marking menu. The value in the config is true. | boolean |
| gridCheckboxEnabled | Displays the Grid command on the Marking menu. The value in the config is true. | boolean |
| previewModeCheckboxEnabled | Displays the Preview mode command on the Marking menu. In the Preview mode, the Design Editor hides safety lines and the bleed and slug areas on the canvas. The value in the config is true. | boolean |
| snapLinesItemsCheckboxEnabled | Displays the Snap to items command on the Marking menu. The value in the config is true. This parameter also supports an ICheckboxConfig object. | boolean |
| snapLinesPrintAreaCheckboxEnabled | Displays the Snap to page command on the Marking menu. The value in the config is true. This parameter also supports an ICheckboxConfig object. | boolean |
| snapLinesSafetyLinesCheckboxEnabled | Displays the Snap to safety lines command on the Marking menu. The value in the config is true. This parameter also supports an ICheckboxConfig object. | boolean |
| snapLinesInteractiveZonesCheckboxEnabled | Displays the Snap to interactive zones command on the Marking menu. The value in the config is true. This parameter also supports an ICheckboxConfig object. | boolean |
| zoomValueEnabled | Enables a button displaying the current zoom level. When your users click this button, they can set a predefined zoom level or zoom the canvas to fit safety lines. The value in the config is true. | boolean |
| zoomButtonsEnabled | Displays the Zoom in and Zoom out buttons. The value in the config is true. | boolean |
| rotateButtonEnabled | Displays the Rotate button allowing your users to rotate the canvas at the specified angle when editing their products. The value in the config is true. | boolean |
| fullWindowButtonEnabled | Displays the Full window button. The value in the config is false. | 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 value in the config is true. | boolean |
| Surface selector | object: widgets.BottomToolbar.surfaceSwitch | |
| enabled | Enables the pagination control. The value in the config is true. | boolean |
| showThumbnails | Displays page thumbnails. The value in the config is false. | 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 value in the config is true. | boolean |
| scrollPageButtonsEnabled | Displays the Next and Previous buttons, which allow for scrolling the page selector. The value in the config is true. | boolean |
| toggleSurfaceButtonsEnabled | Displays the Next and Previous buttons, which allow for switching between pages. The value in the config is false. | boolean |
| firstAndLastButtonsEnabled | Displays the First and Last buttons for the page navigation. The value in the config 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 multiple-pages topic. | object |
Qr Code
Object: widgets.QrCodeDialog
Linear Barcode
Object: widgets.LinearBarcodeDialog
Rich Text Editor
Object: widgets.RichTextDialog
| Name | Description | Possible values |
|---|---|---|
| applyToAllTextMode | Allows you to apply formatting to a whole text element despite a text selection. The value in the config is false. | boolean |
| bgColor | The text background color in the Rich Text dialog. The value in the config is "white". | color in css-compatible format |
| createMultiColumnText | Allows for creating multicolumn text. If true, the Columns drop-down list appears in the Top Toolbar for rich formatted text elements. The value in the config is false. | boolean |
| showHint | Enables hints in the following drop-down lists: "font", "style", "size", "tracking", "leading", "firstLineIndent", "paddingTop", "paddingBottom", "paddingLeft", "paddingRight". By default, all properties of this object are set to true. | object |
| User input boxes | object: widgets.RichTextDialog.showInput | |
| size | Enables user input in the Font size drop-down list. The value in the config is true. | boolean |
| Special characters | object: widgets.RichTextDialog.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: widgets.RichTextDialog.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 value in the config is false. | boolean |
| hueThreshold | The hue threshold. The value in the config is 74. | number |
| brightnessThreshold | The brightness threshold. The value in the config is 5. | number |
| color | The outline color. The value in the config is "rgba(0, 0, 0, 0.2)". | color in css-compatible format |
| Rich text dialog zoom | object: widgets.RichTextDialog.zoom | |
| enabled | Enables the zoom slider in the Rich Text dialog. The value in the config is false. | boolean |
| minZoomPct | The least value of the zoom slider, must be less than 100. The value in the config is 10. | number |
| maxZoomPct | The most value of the zoom slider, must be more than 100. The value in the config is 500. | number |
| Rich text auto-zoom | object: widgets.RichTextDialog.autoZoom | |
| enabled | Enables auto-zoom at opening the Rich Text dialog. The value in the config 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 value in the config 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 value in the config is 36. | number |
Finish Button
Object: widgets.FinishButton
Image Editor
Object: widgets.ImageEditorDialog
Color Picker
Object: widgets.ColorPicker
| Name | Description | Possible values |
|---|---|---|
| showPaletteOnly | If true, shows the predefined palettes and hides the color field in the Color picker. If false, shows both the predefined palettes and the field. The value in the config is false. | boolean |
| sectionCollapseEnabled | If true, allows users to collapse the sections of predefined palettes when they click headers of these sections in the Color picker. The value in the config is false. | boolean |
| colorTypeDropdownEnabled | Enables the Color type drop-down list, where your users can select between CMYK, RGB, and HEX input formats when defining their colors. The value in the config is true. | boolean |
| eyeDropperEnabled | Enables the eyedropeer to select colors on the canvas. The value in the config is true. | boolean |
| defaultColorType | The initial color input format of the Color picker. The value in the config is "cmyk". | "rgb", "cmyk", "hex" |
| availableColorTypes | Specifies the color input formats that will be available to your users in the Color picker. The value in the config is ["cmyk", "rgb", "hex"]. | array |
| paletteHintsEnabled | Displays names of color swatches. You can find an example of defining these names in the Color Picker topic. The value in the config is true. | boolean |
| cmykDecimalsEnabled | Displays decimal places for CMYK values. If true, the Color picker displays the first decimal place in the CMYK color fields. Otherwise, CMYK values are displayed as integers. The value in the config is false. | boolean |
| colorSpace | Outdated, use defaultColorType instead. When both colorSpace and defaultColorType are defined, then colorSpace will be applied. The color space which the user can select a swatch from. The value in the config is "cmyk". | "rgb", "cmyk" |
| colorSpaceDropdownEnabled | Outdated, use colorTypeDropdownEnabled instead. When both colorSpaceDropdownEnabled and colorTypeDropdownEnabled are defined, then colorSpaceDropdownEnabled will be applied. Enables the Color space drop-down list, where your users can select between CMYK and RGB palettes when defining their colors. The value in the config is false. | boolean |
| Sections of color swatches | array: widgets.ColorPicker.sections | |
| type | The palette type. | "NoColorSection", "RecentSection", "ThemeSection", "PaletteSection" |
| translationKey | The palette name. You can use either a string or an identifier of a string defined in the ~\Configuration\translations.json file. | string |
| viewType | The appearance of the palette. The value in the config is "Block". | "Block", "Line" |
| targets | An item property that you can specify a color for. The value in the config is ["All"]. | array containing any combination of "All", "Background", "Border", "Fill", "Line", "RichText", "Shadow", "Stroke", "Text" |
| palette | The predefined palette displayed in the color picker. The value in the config is [["cmyk(0%,100%,100%,0%,100%)", "cmyk(0%,0%,100%,0%,100%)",...],...] | two-dimensional array: array of palettes, where each pallete is an array of colors in css-compatible format |