Interface IBoundedTextItemData

A structure defining the basic parameters of bounded text.

Inheritance

IBaseTextItemData<TTextAlignment, TStrokeSettings, TShadowSettings>

IBoundedTextItemData

Package: @aurigma/design-atoms-interfaces

Examples

{
   "defaultItemsConfig": {
       "boundedText": {
           "isVertical": true,
           "verticalAlignment": "center",
           "overflowStrategy": "fitToWidth",
           "tracking": 12,
           "maxLineCount": 2,
           "maxLineLength": 20
       }
   }
}

Properties

characterLimit

Limits the number of characters that the user can enter in the Rich text editor. By default, this number is not limited.

Declaration

characterLimit?: number;

Property Value

Type	Description
number	Limits the number of characters that the user can enter in the Rich text editor. By default, this number is not limited.

isVertical

Enables the vertical orientation of bounded text. The default value is false.

Declaration

isVertical?: boolean;

Property Value

Type	Description
boolean	Enables the vertical orientation of bounded text. The default value is false.

maxLineCount

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.

Declaration

maxLineCount?: number;

Property Value

Type	Description
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

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.

Declaration

maxLineLength?: number;

Property Value

Type	Description
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.

overflowStrategy

The copyfitting strategy applied to a bounded text element when it overflows. By default, this property is "clip".

Declaration

overflowStrategy?: OverflowStrategy;

Property Value

Type	Description
OverflowStrategy	The copyfitting strategy applied to a bounded text element when it overflows. By default, this property is "clip".

paragraphSettings

The default parameters of paragraphs.

Declaration

paragraphSettings?: IParagraphSettingsData;

Property Value

Type	Description
IParagraphSettingsData	The default parameters of paragraphs.

textShrinkMode

A mode defining how a bounded text element shrinks to its bounds when it overflows. By default, this property is "size".

Declaration

textShrinkMode?: ShrinkMode;

Property Value

Type	Description
ShrinkMode	A mode defining how a bounded text element shrinks to its bounds when it overflows. By default, this property is "size".

verticalAlignment

Defines how the vertical bounded text is aligned. The default value is "top".

Declaration

verticalAlignment?: VerticalAlignmentType;

Property Value

Type	Description
VerticalAlignmentType	Defines how the vertical bounded text is aligned. The default value is "top".

wrappingMargin

The spacing between an item and wrapping text, in points. The default value is 7.

Declaration

wrappingMargin?: number;

Property Value

Type	Description
number	The spacing between an item and wrapping text, in points. The default value is 7.