Interface IItemData

A structure containing parameters of custom design elements.

Package: @aurigma/design-atoms-interfaces

Remarks

For details, you can refer to the Toolbox topic.

Examples

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

CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration);

Properties

adjustSize

Declaration

adjustSize?: boolean;

Property Value

Type	Description
boolean

angle

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

Declaration

angle?: number;

Property Value

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

blendMode

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

Declaration

blendMode?: BlendMode;

Property Value

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

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

Property Value

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

isVariable

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

Declaration

isVariable?: boolean;

Property Value

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

itemPermissions

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

Declaration

itemPermissions?: IItemPermissionsData;

Property Value

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

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?: ILocationData;

Property Value

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

manipulationPermissions

A structure defining the manipulation permissions for design elements.

Declaration

manipulationPermissions?: IManipulationPermissionsData;

Property Value

Type	Description
IManipulationPermissionsData	A structure defining the manipulation permissions for design elements.

name

The name of design elements being added to the canvas.

Declaration

name?: string;

Property Value

Type	Description
string	The name of design elements being added to the canvas.

opacity

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

Declaration

opacity?: number;

Property Value

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

textWrappingMode

A wrapping mode that applies to wrap text around design elements, one of "none", "square", or "tight". By default, it is "none".

Declaration

textWrappingMode?: WrappingMode;

Property Value

Type	Description
WrappingMode	A wrapping mode that applies to wrap text around design elements, one of "none", "square", or "tight". By default, it is "none".

themeBinding

A style or a color that applies to new design elements.

Declaration

themeBinding?: IThemeBindingData;

Property Value

Type	Description
IThemeBindingData	A style or a color that applies to new design elements.

violationSettings

A structure defining the design validation parameters and warnings.

Declaration

violationSettings?: IViolationSettings;

Property Value

Type	Description
IViolationSettings	A structure defining the design validation parameters and warnings.

visible

Indicates whether the design element is visible on the canvas. The default value is true.

Declaration

visible?: boolean;

Property Value

Type	Description
boolean	Indicates whether the design element is visible on the canvas. The default value is true.

visualizationPermissions

A structure defining the visualization permissions for design elements.

Declaration

visualizationPermissions?: IVisualizationPermissionsData;

Property Value

Type	Description
IVisualizationPermissionsData	A structure defining the visualization permissions for design elements.

width

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

Declaration

width?: string | number;

Property Value

Type	Description
string | number	The width of design elements being added to the canvas, in points or percent.