The text field ui options extend the base ui options

Hierarchy

Properties

helpText: string

The editor can show a help text based on configuration settings. There are generic help texts for each field type, but also custom help texts can be defined for individual fields.

hideAdvancedTextOptions: boolean

Flag to control if the advanced text options should be hidden.

hideAlignmentOption: boolean

Flag to control if the text alignment option should be hidden.

hideBoldItalicOptions: boolean

Hide the bold and italic options.

hideBorder: boolean

Do not show the border options in the UI.

hideFontSizeOption: boolean

Hide the font size options.

hideFontsOptions: boolean

Hide the font selector

hideFormat: boolean

Flag to control if the format options should be hidden (font, bold and italic options, underline, strike through, font size, color)

hideShadow: boolean

Do not show the shadow options in the UI.

hideTextColorOption: boolean

Flag to control if the text color option should be hidden.

hideTextDecorationOption: boolean

Flag to control if the text decoration (underline, strike-through) option should be hidden.

margin: string

The margin option defines additional margin around the text field to increase the clipping area to avoid cut off text for certain fonts. The values are in points. Separation is done by a space.

It supports the following formats (similar to CSS margin options):

  • single number: all sides have the same margin - e.g. 5
  • two numbers: the first number is the top and bottom margin, the second number is the left and right margin - e.g. 5 10
  • three numbers: the first number is the top margin, the second number is the left and right margin, the third number is the bottom margin - e.g. 5 10 15
  • four numbers: the first number is the top margin, the second number is the right margin, the third number is the bottom margin, the fourth number is the left margin - e.g. 5 10 15 20
placeholderText: string

Placeholder text to display on the canvas in case the text is empty. This will not be part of the preview or output.

selectedGroupStyle: string

The selected style group by id - id. A style group then allows to select the style items within that group for that text field to quickly and easily adjust styles.

showBackgroundColorOption: boolean

Show the background color option in the UI.

showRenderMode: boolean

Show the rendering mode options (outline, full, etc.)

snapToObject: boolean

Flag to control if the editor would show snap lines and allow to snap to this field.

Generated using TypeDoc