IBaseTextItemData
Interfaces
IBaseTextItemData
A structure defining the basic text parameters.
Example
{
"defaultItemsConfig": {
"text": {
"font": {
"postScriptName": "Impact",
"size": 33,
"fauxBold": true,
"fauxItalic": true
},
"color": "rgb(30,30,30)",
"shadow": {
"color": "rgb(255,0,0)",
"size": 0.4,
"angle": 45,
"distance": 2
},
"stroke": {
"size": 0.3
},
"overflowStrategy": "FitToWidth",
"textPermissions": {
"allowChangeFontColor": false,
"allowChangeShadow": false,
"allowChangeStroke": false
}
}
}
}
Extends
Extended by
Type Parameters
| Type Parameter |
|---|
TTextAlignment |
TStrokeSettings |
TShadowSettings |
Properties
adjustSize?
optional adjustSize?: boolean;
Inherited from
alignment?
optional alignment?: TTextAlignment;
The text alignment.
angle?
optional angle?: number;
An angle, which design elements are rotated to. By default, this value is 0.
Inherited from
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
checkTextCrop?
optional checkTextCrop?: boolean;
color?
optional color?: string;
The text color. The default value is "rgba(0,0,0,1)".
fillColor?
optional fillColor?: string;
The fill color. The default value is "rgba(0, 0, 0, 0)".
Inherited from
font?
optional font?: IFontSettingsData;
The font parameters.
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
horizontalScale?
optional horizontalScale?: number;
Allows you to scale text horizontally. The default value is 1.
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
IContentItemData.itemPermissions
leading?
optional leading?: number;
The spacing between base lines, in points.
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
IContentItemData.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
overlapLinesEnabled?
optional overlapLinesEnabled?: boolean;
overprintFill?
optional overprintFill?: boolean;
Inherited from
IContentItemData.overprintFill
overprintStroke?
optional overprintStroke?: boolean;
Inherited from
IContentItemData.overprintStroke
overprintText?
optional overprintText?: boolean;
previewLeading?
optional previewLeading?: number;
The spacing between base lines on proof images, in points.
previewScale?
optional previewScale?: number;
The text scaling on proof images.
shadow?
optional shadow?: TShadowSettings;
The shadow parameters.
shapePermissions?
optional shapePermissions?: IShapePermissionsData;
Defines permissions for shapes.
Inherited from
IContentItemData.shapePermissions
stroke?
optional stroke?: TStrokeSettings;
The stroke parameters.
text?
optional text?: string;
The default content for new text elements. It is an empty string for text with rich formatting and "Text" for plain text.
textPermissions?
optional textPermissions?: ITextPermissionsData;
Defines permissions for new text elements.
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
tracking?
optional tracking?: number;
The spacing between characters, in points. The default value is 0.
underline?
optional underline?: boolean;
Enables the underline. The default value is false.
verticalScale?
optional verticalScale?: number;
Allows you to scale text vertically. The default value is 1.
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
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.