IEllipseItemData

Interfaces

IEllipseItemData

A structure defining the default parameters of ellipses.

Remarks

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

Example

{
  "defaultItemsConfig": {
    "ellipse": {
      "borderWidth": 2,
      "borderColor": "rgba(155,0,0,0.55)",
      "textWrappingMode": "tight",
      "shapePermissions": {
        "allowChangeBorderWidth": false
      },
      "location": {
        "x": "50%",
        "y": "0%",
        "originX": "right",
        "originY": "top"
      }
    }
  }
}

Extends

IShapeItemData

Properties

adjustSize?

optional adjustSize?: boolean;

Inherited from

IShapeItemData.adjustSize

angle?

optional angle?: number;

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

Inherited from

IShapeItemData.angle

blendMode?

optional blendMode?: BlendMode;

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

Inherited from

IShapeItemData.blendMode

borderColor?

optional borderColor?: string;

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

Inherited from

IShapeItemData.borderColor

borderWidth?

optional borderWidth?: number;

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

Inherited from

IShapeItemData.borderWidth

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.

Inherited from

IShapeItemData.fillColor

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

IShapeItemData.height

isVariable?

optional isVariable?: boolean;

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

Inherited from

IShapeItemData.isVariable

itemPermissions?

optional itemPermissions?: IItemPermissionsData;

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

Inherited from

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

IShapeItemData.location

manipulationPermissions?

optional manipulationPermissions?: IManipulationPermissionsData;

A structure defining the manipulation permissions for design elements.

Inherited from

IShapeItemData.manipulationPermissions

name?

optional name?: string;

The name of design elements being added to the canvas.

Inherited from

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

IShapeItemData.opacity

overprintFill?

optional overprintFill?: boolean;

Inherited from

IShapeItemData.overprintFill

overprintStroke?

optional overprintStroke?: boolean;

Inherited from

IShapeItemData.overprintStroke

shapePermissions?

optional shapePermissions?: IShapePermissionsData;

Defines permissions for shapes.

Inherited from

IShapeItemData.shapePermissions

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

IShapeItemData.textWrappingMode

themeBinding?

optional themeBinding?: IThemeBindingData;

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

Inherited from

IShapeItemData.themeBinding

violationSettings?

optional violationSettings?: IViolationSettings;

A structure defining the design validation parameters and warnings.

Inherited from

IShapeItemData.violationSettings

visible?

optional visible?: boolean;

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

Inherited from

IShapeItemData.visible

visualizationPermissions?

optional visualizationPermissions?: IVisualizationPermissionsData;

A structure defining the visualization permissions for design elements.

Inherited from

IShapeItemData.visualizationPermissions

width?

optional width?: string | number;

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

Inherited from

IShapeItemData.width

Interfaces​