Interface IImageItemData

A structure containing default parameters of images.

Inheritance

IItemData

IShapeItemData

IRectangleItemData

IContentItemData

IImageItemData

Package: @aurigma/design-atoms-interfaces

Remarks

You can apply these parameters to the image object through either **clientConfig.json** or IConfiguration.

Examples

The following example shows how you can add image placeholders to the canvas and disallow changing of the z-order for them.

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

Properties

addImageAsPlaceholder

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

Declaration

addImageAsPlaceholder?: boolean;

Property Value

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

effect

Defines an effect for images being added to the canvas.

Declaration

effect?: ImageEffect;

Property Value

Type	Description
ImageEffect	Defines an effect for images being added to the canvas.

imagePermissions

Defines permissions for images being added to the canvas.

Declaration

imagePermissions?: IImagePermissionsData;

Property Value

Type	Description
IImagePermissionsData	Defines permissions for images being added to the canvas.

imageUrl

A link to the default image.

Declaration

imageUrl?: string;

Property Value

Type	Description
string	A link to the default image.

overlayColor

_Deprecated, use overlayEffect instead_.

Declaration

overlayColor?: string;

Property Value

Type	Description
string	_Deprecated, use overlayEffect instead_.

overlayEffect

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

Declaration

overlayEffect?: TOverlayEffect;

Property Value

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