Skip to main content

IShapeItemData

Interfaces​

IShapeItemData​

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
      },
      "location": {
        "x": "100%",
        "y": "100%",
        "originX": "right",
        "originY": "bottom"
      }
    }
  }
}

Extends​

Extended by​

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

borderColor?​
optional borderColor?: string;

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

borderWidth?​
optional borderWidth?: number;

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

fillColor?​
optional 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.

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

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

overprintFill?​
optional overprintFill?: boolean;
overprintStroke?​
optional overprintStroke?: boolean;
shapePermissions?​
optional shapePermissions?: IShapePermissionsData;

Defines permissions for shapes.

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?: string | number;

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

Inherited from​

IItemData.width

Was this page helpful?