Interface IPlaceholderItemDefaultConfig
A structure defining the default parameters of image placeholders. 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.
Package: IframeApi
Properties
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.
Declaration
allowedSubfolder?: stringProperty Value
| Type | Description |
|---|---|
| string |
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.
Declaration
allowedTabs?: string[]Property Value
| Type | Description |
|---|---|
| string[] |
angle
An angle, which design elements are rotated to. By default, this value is 0.
Declaration
angle?: numberProperty Value
| Type | Description |
|---|---|
| number |
barcodeContent
Defines the barcode content type.
Declaration
barcodeContent?: BarcodeContentTypeProperty Value
| Type | Description |
|---|---|
| BarcodeContentType |
barcodeFormat
Defines the barcode format.
Declaration
barcodeFormat?: BarcodeFormatProperty Value
| Type | Description |
|---|---|
| BarcodeFormat |
blendMode
A blend mode that applies to design elements being added to the canvas.
Declaration
blendMode?: BlendModeProperty Value
| Type | Description |
|---|---|
| BlendMode |
borderColor
The border color. The default value is "rgba(0,0,0,1)".
Declaration
borderColor?: stringProperty Value
| Type | Description |
|---|---|
| string |
borderWidth
The border width, in points. The default value is 1.
Declaration
borderWidth?: numberProperty Value
| Type | Description |
|---|---|
| number |
contentBarcodeColor
Defines the barcode color. The default value is "rgb(0, 0, 0)".
Declaration
contentBarcodeColor?: stringProperty Value
| Type | Description |
|---|---|
| string |
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").
Declaration
contentImageUrl?: stringProperty Value
| Type | Description |
|---|---|
| string |
contentPermissions
Defines permissions for the content of placeholders.
Declaration
contentPermissions?: IContentPermissionsConfigProperty Value
| Type | Description |
|---|---|
| IContentPermissionsConfig |
contentResizeMode
Defines the resize mode for image placeholders. It can be either fill, fit, or original. The default value is fill.
Declaration
contentResizeMode?: ContentResizeModeProperty Value
| Type | Description |
|---|---|
| ContentResizeMode |
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.
Declaration
fillColor?: stringProperty Value
| Type | Description |
|---|---|
| string |
fixedStubContentSize
Maintains the size of stub images while resizing image placeholders. The default value is false.
Declaration
fixedStubContentSize?: booleanProperty Value
| Type | Description |
|---|---|
| boolean |
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.
Declaration
height?: string | numberProperty Value
| Type | Description |
|---|---|
| string | number |
isCoverMode
Enables the cover mode for image placeholders. The default value is true.
Declaration
isCoverMode?: booleanProperty Value
| Type | Description |
|---|---|
| boolean |
isStubContent
Defines whether this is a stub placeholder. The default value is false.
Declaration
isStubContent?: booleanProperty Value
| Type | Description |
|---|---|
| boolean |
isVariable
Marks a design element as a variable item. The default value is false.
Declaration
isVariable?: booleanProperty Value
| Type | Description |
|---|---|
| boolean |
itemPermissions
A structure defining the Item Menu and the Floating item toolbar for design elements.
Declaration
itemPermissions?: IItemPermissionsConfigProperty Value
| Type | Description |
|---|---|
| IItemPermissionsConfig |
location
The coordinates of design elements being added to the canvas. By default, you can add them to the center of your product.
Declaration
location?: ILocationDefaultConfigProperty Value
| Type | Description |
|---|---|
| ILocationDefaultConfig |
manipulationPermissions
A structure defining the manipulation permissions for design elements.
Declaration
manipulationPermissions?: IManipulationPermissionsConfigProperty Value
| Type | Description |
|---|---|
| IManipulationPermissionsConfig |
name
The name of design elements being added to the canvas.
Declaration
name?: stringProperty Value
| Type | Description |
|---|---|
| string |
opacity
An opacity that applies to design elements. This value can be from 0 to 1. By default, it is 1.
Declaration
opacity?: numberProperty Value
| Type | Description |
|---|---|
| number |
placeholderPermissions
Defines permissions for placeholders.
Declaration
placeholderPermissions?: IPlaceholderPermissionsConfigProperty Value
| Type | Description |
|---|---|
| IPlaceholderPermissionsConfig |
shapePermissions
Defines permissions for shapes.
Declaration
shapePermissions?: IShapePermissionsConfigProperty Value
| Type | Description |
|---|---|
| IShapePermissionsConfig |
textWrappingMode
A wrapping mode that applies to wrap text around design elements. By default, it is "none".
Declaration
textWrappingMode?: WrappingMode.WrappingModeTypeProperty Value
| Type | Description |
|---|---|
| WrappingModeType |
themeBinding
A style or a color that applies to new design elements.
Declaration
themeBinding?: IThemeBindingConfigProperty Value
| Type | Description |
|---|---|
| IThemeBindingConfig |
visualizationPermissions
A structure defining the visualization permissions for design elements.
Declaration
visualizationPermissions?: IVisualizationPermissionsConfigProperty Value
| Type | Description |
|---|---|
| IVisualizationPermissionsConfig |
width
The width of design elements being added to the canvas, in points or percent.
Declaration
width?: string | numberProperty Value
| Type | Description |
|---|---|
| string | number |