IArchedTextItemData
Interfaces
IArchedTextItemData
A structure defining the default parameters of arched text.
Remarks
You can apply these parameters to the archedText object through either clientConfig.json or IConfiguration https://customerscanvas.com/dev/editors/iframe-api/reference/design-editor-iframe/iconfiguration.html|IConfiguration.
Example
{
"defaultItemsConfig": {
"archedText": {
"font": {
"postScriptName": "Roboto-Regular",
"size": 24
},
"text": "Arched text",
"color": "cmyk(0%, 0%, 0%, 100%, 100%)",
"bend": 0.7,
"location": {
"x": "50%",
"y": "50%",
"originX": "center",
"originY": "center"
}
}
}
}
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
bend?
optional bend?: number;
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;
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
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
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;
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
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
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
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
warp?
optional warp?: boolean;
width?
optional width?: string | number;
The width of design elements being added to the canvas, in points or percent.