ILineItemData

Interfaces

ILineItemData

A structure containing default parameters of lines.

Remarks

You can apply these parameters to the line object through either clientConfig.json or IConfiguration https://customerscanvas.com/dev/editors/iframe-api/reference/design-editor-iframe/iconfiguration.html|IConfiguration.

Example

{
   "defaultItemsConfig": {
       "line": {
           "width": 8,
           "color": "rgb(255,0,0)",
           "point0": { "x": 10, "y": 10 },
           "point1": { "x": 100, "y": 10 },
           "linePermissions": {
               "allowChangeLineWidth": false,
               "allowChangeLineColor": false
           }
       }
   }
}

Extends

• IItemData

Properties

adjustSize?

optional adjustSize?: boolean;

Inherited from

IItemData.adjustSize

angle?

optional angle?: number;

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

Inherited from

IItemData.angle

blendMode?

optional blendMode?: BlendMode;

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

Inherited from

IItemData.blendMode

color?

optional color?: string;

A default color of lines. By default, this value is "rgba(0,0,0,1)".

fixedWidth?

optional fixedWidth?: boolean;

height?

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

Inherited from

IItemData.height

isVariable?

optional isVariable?: boolean;

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

Inherited from

IItemData.isVariable

itemPermissions?

optional itemPermissions?: IItemPermissionsData;

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

Inherited from

IItemData.itemPermissions

linePermissions?

optional linePermissions?: ILinePermissionsData;

A structure defining line permissions.

location?

optional location?: ILocationData;

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

Inherited from

IItemData.location

manipulationPermissions?

optional manipulationPermissions?: IManipulationPermissionsData;

A structure defining the manipulation permissions for design elements.

Inherited from

IItemData.manipulationPermissions

name?

optional name?: string;

The name of design elements being added to the canvas.

Inherited from

IItemData.name

opacity?

optional opacity?: number;

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

Inherited from

IItemData.opacity

overprintStroke?

optional overprintStroke?: boolean;

point0?

optional point0?: IPointF;

A default start point of lines.

point1?

optional point1?: IPointF;

A default end point of lines.

textWrappingMode?

optional textWrappingMode?: WrappingMode;

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

Inherited from

IItemData.textWrappingMode

themeBinding?

optional themeBinding?: IThemeBindingData;

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

Inherited from

IItemData.themeBinding

violationSettings?

optional violationSettings?: IViolationSettings;

A structure defining the design validation parameters and warnings.

Inherited from

IItemData.violationSettings

visible?

optional visible?: boolean;

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

Inherited from

IItemData.visible

visualizationPermissions?

optional visualizationPermissions?: IVisualizationPermissionsData;

A structure defining the visualization permissions for design elements.

Inherited from

IItemData.visualizationPermissions

width?

optional width?: number;

A default width of lines, in points. By default, this value is 1.

Overrides

IItemData.width