IBoundedTextItemData
Interfaces
IBoundedTextItemData
A structure defining the basic parameters of bounded text.
Example
{
"defaultItemsConfig": {
"richText": {
"isVertical": true,
"verticalAlignment": "center",
"overflowStrategy": "fitToWidth",
"tracking": 12,
"maxLineCount": 2,
"maxLineLength": 20
}
}
}
Extends
IBaseTextItemData<TTextAlignment,TStrokeSettings,TShadowSettings>
Extended by
Type Parameters
| Type Parameter |
|---|
TTextAlignment |
TStrokeSettings |
TShadowSettings |
Properties
adjustSize?
optional adjustSize?: boolean;
Inherited from
alignment?
optional alignment?: TTextAlignment;
The text alignment.
Inherited from
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
characterLimit?
optional characterLimit?: number;
Limits the number of characters that the user can enter in the Rich text editor. By default, this number is not limited.
checkTextCrop?
optional checkTextCrop?: boolean;
Inherited from
IBaseTextItemData.checkTextCrop
color?
optional color?: string;
The text color. The default value is "rgba(0,0,0,1)".
Inherited from
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.
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
horizontalScale?
optional horizontalScale?: number;
Allows you to scale text horizontally. The default value is 1.
Inherited from
IBaseTextItemData.horizontalScale
isVariable?
optional isVariable?: boolean;
Marks a design element as a variable item. The default value is false.
Inherited from
isVertical?
optional isVertical?: boolean;
Enables the vertical orientation of bounded text. The default value is false.
itemPermissions?
optional itemPermissions?: IItemPermissionsData;
A structure defining the Item Menu and the Floating item toolbar for design elements.
Inherited from
IBaseTextItemData.itemPermissions
leading?
optional leading?: number;
The spacing between base lines, in points.
Inherited from
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
IBaseTextItemData.manipulationPermissions
maskOpacity?
optional maskOpacity?: number;
The mask opacity of an item. The default value is 0.45.
Inherited from
maxLineCount?
optional maxLineCount?: number;
The maximum number of lines which the user is allowed to enter into a specific point text or bounded text element. By default, this number is not limited.
maxLineLength?
optional maxLineLength?: number;
The maximum length of text lines which the user is allowed to enter into a specific point text or bounded text element. By default, this number is not limited.
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
overflowStrategy?
optional overflowStrategy?: OverflowStrategy;
The copyfitting strategy applied to a bounded text element when it overflows. By default, this property is "clip".
overlapLinesEnabled?
optional overlapLinesEnabled?: boolean;
Inherited from
IBaseTextItemData.overlapLinesEnabled
overprintFill?
optional overprintFill?: boolean;
Inherited from
IBaseTextItemData.overprintFill
overprintStroke?
optional overprintStroke?: boolean;
Inherited from
IBaseTextItemData.overprintStroke
overprintText?
optional overprintText?: boolean;
Inherited from
IBaseTextItemData.overprintText
paragraphSettings?
optional paragraphSettings?: IParagraphSettingsData;
The default parameters of paragraphs.
previewLeading?
optional previewLeading?: number;
The spacing between base lines on proof images, in points.
Inherited from
IBaseTextItemData.previewLeading
previewScale?
optional previewScale?: number;
The text scaling on proof images.
Inherited from
IBaseTextItemData.previewScale
shadow?
optional shadow?: TShadowSettings;
The shadow parameters.
Inherited from
shapePermissions?
optional shapePermissions?: IShapePermissionsData;
Defines permissions for shapes.
Inherited from
IBaseTextItemData.shapePermissions
stroke?
optional stroke?: TStrokeSettings;
The stroke parameters.
Inherited from
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.
Inherited from
textPermissions?
optional textPermissions?: ITextPermissionsData;
Defines permissions for new text elements.
Inherited from
IBaseTextItemData.textPermissions
textShrinkMode?
optional textShrinkMode?: ShrinkMode;
A mode defining how a bounded text element shrinks to its bounds when it overflows. By default, this property is "size".
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
IBaseTextItemData.textWrappingMode
themeBinding?
optional themeBinding?: IThemeBindingData;
A style or a color that applies to new design elements.
Inherited from
IBaseTextItemData.themeBinding
tracking?
optional tracking?: number;
The spacing between characters, in points. The default value is 0.
Inherited from
underline?
optional underline?: boolean;
Enables the underline. The default value is false.
Inherited from
verticalAlignment?
optional verticalAlignment?: VerticalAlignmentType;
Defines how the vertical bounded text is aligned. The default value is "top".
verticalScale?
optional verticalScale?: number;
Allows you to scale text vertically. The default value is 1.
Inherited from
IBaseTextItemData.verticalScale
violationSettings?
optional violationSettings?: IViolationSettings;
A structure defining the design validation parameters and warnings.
Inherited from
IBaseTextItemData.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
IBaseTextItemData.visualizationPermissions
width?
optional width?: string | number;
The width of design elements being added to the canvas, in points or percent.
Inherited from
wrappingMargin?
optional wrappingMargin?: number;
The spacing between an item and wrapping text, in points. The default value is 7.