View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IItemDefaultConfig Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure containing parameters of custom design elements. These parameters apply to those elements that the user adds to the canvas.

For details, you can refer to the Custom Design Elements topic.

example
itemConfig = {
    angle: 90,
    opacity: 0.5,
    textWrappingMode: "tight",
    themeBinding: {
        styles: [ "DimImages" ]
    },
    manipulationPermissions: {
        allowMoveHorizontal: false,
        allowMoveVertical: false
    },
    itemPermissions: {
        allowZOrderChange: false,
        allowOpacityChange: true
    }
};

Properties

Optional angle

angle: number

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

Optional blendMode

blendMode: BlendMode

A blend mode that applies to design elements being added to the canvas.

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 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

location: ILocationDefaultConfig

The coordinates 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 name

name: string

The name of design elements being added to the canvas.

Optional opacity

opacity: number

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

Optional textWrappingMode

textWrappingMode: WrappingModeType

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

Optional themeBinding

themeBinding: IThemeBindingConfig

A style or a color that applies 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.