IPlaceholderItemData
Interfaces
IPlaceholderItemData
A structure defining the default parameters of image placeholders.
Remarks
You can apply these parameters to the placeholder object through either clientConfig.json or IConfiguration https://customerscanvas.com/dev/editors/iframe-api/reference/design-editor-iframe/iconfiguration.html|IConfiguration.
Example
{
"defaultItemsConfig": {
"placeholder": {
"allowedSubfolder": "europe_photos",
"isCoverMode": false
}
}
}
Extends
Type Parameters
| Type Parameter |
|---|
TBarcodeFormat |
TBarcodeSubType |
TOverlayEffect |
Properties
adjustSize?
optional adjustSize?: boolean;
Inherited from
allowedSubfolder?
optional allowedSubfolder?: string;
Defines a subfolder of /assets/images/ from which the user can select images for placeholders. When you specify this property, the gallery shows images only from the corresponding public subfolder. By default, your users can select images from any gallery tab or public subfolder.
allowedTabs?
optional allowedTabs?: string[];
Defines an array of gallery tab names from which the user can select images for placeholders. For example, to open only the Public files and My files tabs for image placeholders, set allowedTabs to ["Public files", "My files"]. By default, your users can select images from any gallery tab.
angle?
optional angle?: number;
An angle, which design elements are rotated to. By default, this value is 0.
Inherited from
barcodeContent?
optional barcodeContent?: BarcodeContentType<TBarcodeFormat, TBarcodeSubType>;
Defines the barcode content type.
barcodeFormat?
optional barcodeFormat?: TBarcodeFormat;
Defines the barcode format.
blendMode?
optional blendMode?: BlendMode;
A blend mode that applies to design elements being added to the canvas.
Inherited from
borderColor?
optional borderColor?: string;
The border color. The default value is "rgba(0,0,0,1)".
Inherited from
borderWidth?
optional borderWidth?: number;
The border width, in points. The default value is 1.
Inherited from
contentBarcodeColor?
optional contentBarcodeColor?: string;
Defines the barcode color. The default value is "rgb(0, 0, 0)".
contentBarcodeOptions?
optional contentBarcodeOptions?: IBarcodeOptions;
contentFillColor?
optional contentFillColor?: string;
Defines the content fillColor.
contentImageUrl?
optional contentImageUrl?: string;
Defines a link to an image used as the placeholder's content. You can define URLs, links to private images ("user:someprivateimage.png"), and images from the public gallery ("public:logos/logo.png").
contentOverlayEffect?
optional contentOverlayEffect?: TOverlayEffect;
contentPermissions?
optional contentPermissions?: IContentPermissionsData;
Defines permissions for the content of placeholders.
contentResizeMode?
optional contentResizeMode?: ContentResizeMode;
Defines the resize mode for image placeholders. It can be either fill, fit, or original. The default value is fill.
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
fixedStubContentSize?
optional fixedStubContentSize?: boolean;
Maintains the size of stub images while resizing image placeholders. The default value is false.
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
isCoverMode?
optional isCoverMode?: boolean;
Enables the cover mode for image placeholders. The default value is true.
isStubContent?
optional isStubContent?: boolean;
Defines whether this is a stub placeholder. The default value is false.
isVariable?
optional isVariable?: boolean;
Marks a design element as a variable item. The default value is false.
Inherited from
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
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
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
overprintFill?
optional overprintFill?: boolean;
Inherited from
overprintStroke?
optional overprintStroke?: boolean;
Inherited from
IShapeItemData.overprintStroke
placeholderPermissions?
optional placeholderPermissions?: IPlaceholderPermissionsData;
Defines permissions for placeholders.
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
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
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.