IImageItemData

Interfaces

IImageItemData

A structure containing default parameters of images.

Remarks

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

Example

{
  "defaultItemsConfig": {
    "image": {
      "name": "placeholder",
      "addImageAsPlaceholder": true,
      "overlayColor": "rgb(0,255,0)",
      "itemPermissions": {
        "allowZOrderChange": false
      }
    }
  }
}

Extends

• IContentItemData

Extended by

• IBarcodeItemData

Type Parameters

Type Parameter
TOverlayEffect

Properties

addImageAsPlaceholder?

optional addImageAsPlaceholder?: boolean;

Allows adding images to the canvas as placeholders. The default value is false.

adjustSize?

optional adjustSize?: boolean;

Inherited from

IContentItemData.adjustSize

angle?

optional angle?: number;

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

Inherited from

IContentItemData.angle

blendMode?

optional blendMode?: BlendMode;

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

Inherited from

IContentItemData.blendMode

borderColor?

optional borderColor?: string;

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

Inherited from

IContentItemData.borderColor

borderWidth?

optional borderWidth?: number;

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

Inherited from

IContentItemData.borderWidth

effect?

optional effect?: ImageEffect;

Defines an effect for images being added to the canvas.

fillColor?

optional fillColor?: string;

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

Inherited from

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

IContentItemData.height

imagePermissions?

optional imagePermissions?: IImagePermissionsData;

Defines permissions for images being added to the canvas.

imageUrl?

optional imageUrl?: string;

A link to the default image.

isVariable?

optional isVariable?: boolean;

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

Inherited from

IContentItemData.isVariable

itemPermissions?

optional itemPermissions?: IItemPermissionsData;

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

Inherited from

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

IContentItemData.location

manipulationPermissions?

optional manipulationPermissions?: IManipulationPermissionsData;

A structure defining the manipulation permissions for design elements.

Inherited from

IContentItemData.manipulationPermissions

maskOpacity?

optional maskOpacity?: number;

The mask opacity of an item. The default value is 0.45.

Inherited from

IContentItemData.maskOpacity

name?

optional name?: string;

The name of design elements being added to the canvas.

Inherited from

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

IContentItemData.opacity

overlayColor?

optional overlayColor?: string;

Deprecated, use overlayEffect instead.

overlayEffect?

optional overlayEffect?: TOverlayEffect;

Defines an overlay color for images being added to the canvas.

overprintFill?

optional overprintFill?: boolean;

Inherited from

IContentItemData.overprintFill

overprintStroke?

optional overprintStroke?: boolean;

Inherited from

IContentItemData.overprintStroke

shapePermissions?

optional shapePermissions?: IShapePermissionsData;

Defines permissions for shapes.

Inherited from

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

IContentItemData.textWrappingMode

themeBinding?

optional themeBinding?: IThemeBindingData;

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

Inherited from

IContentItemData.themeBinding

violationSettings?

optional violationSettings?: IViolationSettings;

A structure defining the design validation parameters and warnings.

Inherited from

IContentItemData.violationSettings

visible?

optional visible?: boolean;

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

Inherited from

IContentItemData.visible

visualizationPermissions?

optional visualizationPermissions?: IVisualizationPermissionsData;

A structure defining the visualization permissions for design elements.

Inherited from

IContentItemData.visualizationPermissions

width?

optional width?: string | number;

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

Inherited from

IContentItemData.width