TrophyCustomer's Canvas is honored with a 2020 InterTech Technology Award! Learn more 
  1. Customer's Canvas 6.0.4
  2. APIs
  3. IFrame API
  4. IframeApi Module
  5. Configuration Module
  6. DefaultConfig Module

IShapeItemDefaultConfig Interface

A structure defining common shape parameters and parameters of SVG images imported in the Shape mode.

example
{
    "defaultItemsConfig": {
        "shape": {
            "borderWidth": 2,
            "fillColor": "cmyk(0%, 0%, 0%, 25%, 100%)",
            "shapePermissions": {
                "allowChangeBorderWidth": false
            }
        }
    }
}

Properties

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