- Introduction
- What's New?
- Features
- Upgrading the Design Editor
- Breaking Changes in 6.0
- Getting Started
- Integration with E-commerce
- Integration with Remote Asset Sources
- Printable Files and Proof Images
- Configuring Products
- Creating Product Templates
- User Interface
- Configuration Files
- APIs
- IFrame API
- Getting Started with IFrame API
- Using the Design Atoms Framework in IFrame API
- Changing the Product Size
- BaseEditor Module
- IframeApi Module
- Commands Module
- Configuration Module
- BarcodeType Enumeration
- ColorSpace Module
- DefaultConfig Module
- BlendMode Enumeration
- IBarcodeDefaultConfig Interface
- IBarcodePermissionsConfig Interface
- IBaseTextItemConfig Interface
- IBoundedTextItemConfig Interface
- IContentItemDefaultConfig Interface
- IContentPermissionsConfig Interface
- IEllipseItemDefaultConfig Interface
- IEmptyBarcodeContent Interface
- IGalleryDefaultConfig Interface
- IGalleryItemConfig Interface
- IImageItemDefaultConfig Interface
- IImagePermissionsConfig Interface
- IItemDefaultConfig Interface
- IItemPermissionsConfig Interface
- IItemToolbarPermissionsConfig Interface
- ILinearBarcodeContent Interface
- ILineItemDefaultConfig Interface
- ILinePermissionsConfig Interface
- ILocationDefaultConfig Interface
- IManipulationPermissionsConfig Interface
- IParagraphSettingsConfig Interface
- IPlaceholderItemDefaultConfig Interface
- IPlaceholderPermissionsConfig Interface
- IPointF Interface
- IQrPhoneBarcodeContent Interface
- IQrUrlBarcodeContent Interface
- IQrVCardBarcodeContent Interface
- IRectangleItemDefaultConfig Interface
- IResizeGripsPermissions Interface
- IRichTextConfig Interface
- IShapeItemDefaultConfig Interface
- IShapePermissionsConfig Interface
- IStubBarcodeContent Interface
- ITextConfig Interface
- ITextPermissionsConfig Interface
- IThemeBindingConfig Interface
- IVisualizationPermissionsConfig Interface
- OriginPointType Enumeration
- TextAlignment Enumeration
- WrappingMode Module
- FinishButtonMode Module
- FontListMode Module
- GallerySource Module
- ICanvasConfig Interface
- IConfiguration Interface
- IDefaultItemsConfig Interface
- IFontSettings Interface
- IGridConfig Interface
- IHandlersConfiguration Interface
- IItemData Interface
- ImageSize Module
- InStringPlaceholderMode Module
- IPdfMetadata Interface
- IPrintZoneConfig Interface
- IPrintZoneConfiguration Interface
- IProductThemeConfig Interface
- IPublicApiConfig Interface
- IQualityLevelsConfig Interface
- IQualityMeterConfig Interface
- IRenderingProperty Interface
- IRotationConfig Interface
- IRulersConfig Interface
- IShadowSettings Interface
- ISnapElementConfiguration Interface
- ISnapLinesConfig Interface
- IStrokeSettings Interface
- IStubImagesBarcodeConfig Interface
- IStubImagesConfig Interface
- IUiConfig Interface
- IViolationWarningsSettingsConfig Interface
- IWatermarkConfig Interface
- IWatermarkImageConfig Interface
- IWatermarkTextConfig Interface
- IWatermarkVisibilityConfig Interface
- ModelMode Module
- ObjectInspectorPosition Module
- PdfActionMode Module
- PlaceholderEditingViewMode Enumeration
- PsdActionMode Module
- RotationAlgorithm Module
- RulersConfigUnit Module
- SvgActionMode Module
- TextAlignment Module
- TextEditorMode Enumeration
- Editor Class
- loadEditor Function
- ObjectModel Module
- PostMessage Module
- preload Function
- RuntimeConfiguration Class
- Web API
- Design Atoms Framework
- UI Framework
- Dynamic Image API
- IFrame API
- Add-ons
- System Requirements
- Troubleshooting
- Migrating Your Applications
- Licensing
- Copyright Notices
IPlaceholderItemDefaultConfig Interface
Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation
A structure defining the default parameters of image placeholders. These parameters apply to those image placeholders that the user adds to the canvas.
You can apply these parameters to the placeholder object through either clientConfig.json or IConfiguration. The following example shows how you can allow your users to select images only from the europe_photos subfolder of the public folder and disable the cover mode.
Properties
Optional allowedSubfolder
Defines a subfolder of \assets\images\ from which the user can select images for placeholders. When you specify this property, the gallery shows images only from the corresponding public subfolder. By default, your users can select images from any gallery tab or public subfolder.
Optional allowedTabs
Defines an array of gallery tab names from which the user can select images for placeholders. For example, to open only the Public files and My files tabs for image placeholders, set allowedTabs to ["Public files", "My files"]. By default, your users can select images from any gallery tab.
Optional angle
An angle, which design elements are rotated to. By default, this value is 0.
Optional barcodeContent
Defines the barcode content type.
Optional barcodeFormat
Defines the barcode format.
Optional blendMode
A blend mode that applies to design elements being added to the canvas.
Optional borderColor
The border color. The default value is "rgba(0,0,0,1)".
Optional borderWidth
The border width, in points. The default value is 1.
Optional contentBarcodeColor
Defines the barcode color. The default value is "rgb(0, 0, 0)".
Optional contentImageUrl
Defines a link to an image used as the placeholder's content. You can define URLs, links to private images ("user:someprivateimage.png"), and images from the public gallery ("public:logos/logo.png").
Optional contentPermissions
Defines permissions for the content of placeholders.
Optional contentResizeMode
Defines the resize mode for image placeholders. It can be either fill, fit, or original. For details, refer to the Image Placeholders topic. The default value is fill.
Optional fillColor
The fill color for shapes and placeholders. The default value is "rgba(112,112,112,1)" for shapes and is "rgba(0,0,0,0)" for image placeholders.
Optional fixedStubContentSize
Maintains the size of stub images while resizing image placeholders. The default value is false.
Optional height
The height of design elements being added to the canvas, in points or percent. For QR codes, the width value is used for both width and height.
Optional isCoverMode
Enables the cover mode for image placeholders. The default value is true.
Optional isStubContent
Defines whether this is a stub placeholder. The default value is false.
Optional isVariable
Marks a design element as a variable item. The default value is false.
Optional itemPermissions
A structure defining the Item Menu and the Floating item toolbar for design elements.
Optional location
The coordinates of design elements being added to the canvas. By default, you can add them to the center of your product.
Optional manipulationPermissions
A structure defining the manipulation permissions for design elements.
Optional name
The name of design elements being added to the canvas.
Optional opacity
An opacity that applies to design elements. This value can be from 0 to 1. By default, it is 1.
Optional placeholderPermissions
Defines permissions for placeholders.
Optional shapePermissions
Defines permissions for shapes.
Optional textWrappingMode
A wrapping mode that applies to wrap text around design elements. By default, it is "none".
Optional themeBinding
A style or a color that applies to new design elements.
Optional visualizationPermissions
A structure defining the visualization permissions for design elements.
Optional width
The width of design elements being added to the canvas, in points or percent.