IBarcodeItemData
Interfaces
IBarcodeItemData
A structure defining the default parameters of barcodes.
Example
{
"widgets": {
"Toolbox": {
"buttons": [
"QrCode",
{
"action": "CustomBarcode",
"iconClass": "cc-icon-qr-code",
"itemConfig": {
"barcodeContent": {
"barcodeFormat": "QrUrl",
"url": "example.com"
},
"name": "Custom barcode",
"color": "rgb(255,0,0)",
"width": "100",
"location": {
"originX": "left",
"originY": "bottom",
"x": "0%",
"y": "100%"
},
"barcodeOptions": {
"margin": 0
},
"manipulationPermissions": {
"allowMoveHorizontal": false,
"allowMoveVertical": false,
"resizeGrips": {
"edge": false,
"corner": []
}
}
}
}
]
}
}
}
Extends
IImageItemData<TOverlayEffect>
Type Parameters
| Type Parameter |
|---|
TOverlayEffect |
TBarcodeFormat |
TBarcodeSubType |
Properties
addImageAsPlaceholder?
optional addImageAsPlaceholder?: boolean;
Allows adding images to the canvas as placeholders. The default value is false.
Inherited from
IImageItemData.addImageAsPlaceholder
adjustSize?
optional adjustSize?: boolean;
Inherited from
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>;
The content of barcodes.
barcodeOptions?
optional barcodeOptions?: IBarcodeOptions;
Defines encoding options.
barcodePermissions?
optional barcodePermissions?: IBarcodePermissionsData;
Defines permissions for barcodes.
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
color?
optional color?: string;
Defines the barcode color. The default value is "rgb(0, 0, 0)".
effect?
optional effect?: ImageEffect;
Defines an effect for images being added to the canvas.
Inherited from
fillColor?
optional fillColor?: string;
The fill color. The default value is "rgba(0, 0, 0, 0)".
Inherited from
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
imagePermissions?
optional imagePermissions?: IImagePermissionsData;
Defines permissions for images being added to the canvas.
Inherited from
IImageItemData.imagePermissions
imageUrl?
optional imageUrl?: string;
A link to the default image.
Inherited from
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
IImageItemData.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
IImageItemData.manipulationPermissions
maskOpacity?
optional maskOpacity?: number;
The mask opacity of an item. The default value is 0.45.
Inherited from
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
overlayColor?
optional overlayColor?: string;
Deprecated, use overlayEffect instead.
Inherited from
overlayEffect?
optional overlayEffect?: TOverlayEffect;
Defines an overlay color for images being added to the canvas.
Inherited from
overprintFill?
optional overprintFill?: boolean;
Inherited from
overprintStroke?
optional overprintStroke?: boolean;
Inherited from
IImageItemData.overprintStroke
shapePermissions?
optional shapePermissions?: IShapePermissionsData;
Defines permissions for shapes.
Inherited from
IImageItemData.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
IImageItemData.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
IImageItemData.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
IImageItemData.visualizationPermissions
width?
optional width?: string | number;
The width of design elements being added to the canvas, in points or percent.