IImageItemDefaultConfig Interface

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.

example
{
    "defaultItemsConfig": {
        "image": {
            "addImageAsPlaceholder": true,
            "overlayColor": "rgb(0,255,0)",
            "itemPermissions": {
                "allowZOrderChange": false
            }
        }
    }
}

Properties

Optional addImageAsPlaceholder

addImageAsPlaceholder: boolean

Allows adding images to the canvas as placeholders. The default value is false.

Optional angle

angle: number

An angle, which design elements are rotated to. By default, this value is 0.

Optional borderColor

borderColor: string

The border color. The default value is "rgba(0,0,0,1)".

Optional borderWidth

borderWidth: number

The border width, in points. The default value is 1.

Optional fillColor

fillColor: string

The fill color. The default value is "rgba(0, 0, 0, 0)".

Optional height

height: string | number

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 imagePermissions

imagePermissions: IImagePermissionsConfig

Defines permissions for images being added to the canvas.

Optional imageUrl

imageUrl: string

A link to the default image.

Optional isVariable

isVariable: boolean

Marks a design element as a variable item. The default value is false.

Optional itemPermissions

itemPermissions: IItemPermissionsConfig

A structure defining the Item Menu and the Floating item toolbar for design elements.

Optional location

The location of design elements being added to the canvas. By default, you can add them to the center of your product.

Optional manipulationPermissions

manipulationPermissions: IManipulationPermissionsConfig

A structure defining the manipulation permissions for design elements.

Optional maskOpacity

maskOpacity: number

The mask opacity of an item. The default value is 0.45.

Optional name

name: string

The name of design elements being added to the canvas.

Optional opacity

opacity: number

An opacity applied to design elements. This value can be from 0 to 1. By default, it is 1.

Optional overlayColor

overlayColor: string

Defines an overlay color for images being added to the canvas.

Optional shapePermissions

shapePermissions: IShapePermissionsConfig

Defines permissions for shapes.

Optional textWrappingMode

textWrappingMode: WrappingModeType

A wrapping mode applied to wrap text around design elements. By default, it is "none".

Optional themeBinding

themeBinding: IThemeBindingConfig

A style or a color applied to new design elements.

Optional visualizationPermissions

visualizationPermissions: IVisualizationPermissionsConfig

A structure defining the visualization permissions for design elements.

Optional width

width: string | number

The width of design elements being added to the canvas, in points or percent.