Interface IImageItemDefaultConfig
A structure containing default parameters of images. You can apply these parameters to the image object through either clientConfig.json or IConfiguration. The following example shows how you can add image placeholders to the canvas and disallow changing of the z-order for them.
Package: IframeApi
Properties
addImageAsPlaceholder
Allows adding images to the canvas as placeholders. The default value is false.
Declaration
addImageAsPlaceholder?: booleanProperty Value
| Type | Description |
|---|---|
| boolean |
angle
An angle, which design elements are rotated to. By default, this value is 0.
Declaration
angle?: numberProperty Value
| Type | Description |
|---|---|
| number |
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 |
fillColor
The fill color. The default value is "rgba(0, 0, 0, 0)".
Declaration
fillColor?: stringProperty Value
| Type | Description |
|---|---|
| string |
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 |
imagePermissions
Defines permissions for images being added to the canvas.
Declaration
imagePermissions?: IImagePermissionsConfigProperty Value
| Type | Description |
|---|---|
| IImagePermissionsConfig |
imageUrl
A link to the default image.
Declaration
imageUrl?: stringProperty Value
| Type | Description |
|---|---|
| string |
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 |
maskOpacity
The mask opacity of an item. The default value is 0.45.
Declaration
maskOpacity?: numberProperty Value
| Type | Description |
|---|---|
| number |
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 |
overlayColor
Defines an overlay color for images being added to the canvas.
Declaration
overlayColor?: stringProperty Value
| Type | Description |
|---|---|
| string |
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 |