Interface IBaseTextItemData

A structure defining the basic text parameters.

Inheritance

IItemData

IShapeItemData

IRectangleItemData

IContentItemData

IBaseTextItemData

Package: @aurigma/design-atoms-interfaces

Examples

{
   "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
           }
       }
   }
}

Properties

alignment

The text alignment.

Declaration

alignment?: TTextAlignment;

Property Value

Type	Description
TTextAlignment	The text alignment.

checkTextCrop

Declaration

checkTextCrop?: boolean;

Property Value

Type	Description
boolean

color

The text color. The default value is "rgba(0,0,0,1)".

Declaration

color?: string;

Property Value

Type	Description
string	The text color. The default value is "rgba(0,0,0,1)".

font

The font parameters.

Declaration

font?: IFontSettingsData;

Property Value

Type	Description
IFontSettingsData	The font parameters.

horizontalScale

Allows you to scale text horizontally. The default value is 1.

Declaration

horizontalScale?: number;

Property Value

Type	Description
number	Allows you to scale text horizontally. The default value is 1.

leading

The spacing between base lines, in points.

Declaration

leading?: number;

Property Value

Type	Description
number	The spacing between base lines, in points.

overlapLinesEnabled

Declaration

overlapLinesEnabled?: boolean;

Property Value

Type	Description
boolean

overprintText

Declaration

overprintText?: boolean;

Property Value

Type	Description
boolean

previewLeading

The spacing between base lines on proof images, in points.

Declaration

previewLeading?: number;

Property Value

Type	Description
number	The spacing between base lines on proof images, in points.

previewScale

The text scaling on proof images.

Declaration

previewScale?: number;

Property Value

Type	Description
number	The text scaling on proof images.

shadow

The shadow parameters.

Declaration

shadow?: TShadowSettings;

Property Value

Type	Description
TShadowSettings	The shadow parameters.

stroke

The stroke parameters.

Declaration

stroke?: TStrokeSettings;

Property Value

Type	Description
TStrokeSettings	The stroke parameters.

text

The default content for new text elements. It is an empty string for text with rich formatting and "Text" for plain text.

Declaration

text?: string;

Property Value

Type	Description
string	The default content for new text elements. It is an empty string for text with rich formatting and "Text" for plain text.

textPermissions

Defines permissions for new text elements.

Declaration

textPermissions?: ITextPermissionsData;

Property Value

Type	Description
ITextPermissionsData	Defines permissions for new text elements.

tracking

The spacing between characters, in points. The default value is 0.

Declaration

tracking?: number;

Property Value

Type	Description
number	The spacing between characters, in points. The default value is 0.

underline

Enables the underline. The default value is false.

Declaration

underline?: boolean;

Property Value

Type	Description
boolean	Enables the underline. The default value is false.

verticalScale

Allows you to scale text vertically. The default value is 1.

Declaration

verticalScale?: number;

Property Value

Type	Description
number	Allows you to scale text vertically. The default value is 1.