Accelerating the pace of engineering and science

• Trials

# Annotation Textbox Properties

Define annotation textbox properties

## Modifying Properties

You can set and query annotation object properties using the set and get functions and the Property Editor (displayed with the propertyeditor command).

Use the annotation function to create annotation objects and obtain their handles. For an example of its use, see Annotation Objects in the MATLAB® Graphics documentation.

## Annotation Textbox Property Descriptions

This section provides a description of properties. Curly braces { } enclose default values.

BackgroundColor

ColorSpec | {none}

Color of text background rectangle. A three-element RGB vector or one of the MATLAB predefined names, specifying the rectangle background color. The default value is none.

Color

ColorSpec

Text color. A three-element RGB vector or one of the predefined names, specifying the text color. The default value is black. See ColorSpec for more information on specifying color.

EdgeColor

ColorSpec | {none}

Color of edge of text rectangle. A three-element RGB vector or one of the MATLAB predefined names, specifying the color of the rectangle that encloses the text.

See the ColorSpec reference page for more information on specifying color. Setting the Color property also sets this property.

FaceAlpha

Scalar alpha value in range [0 1]

Transparency of object background. Defines the degree to which the object's background color is transparent. A value of 1 (the default) makes the background opaque, a value of 0 makes the background completely transparent (that is, invisible). The default value is 1.

FitBoxToText

{on} | off

Automatically adjust text box width and height to fit text. When this property is on (the default), MATLAB automatically resizes textboxes to fit the x-extents and y-extents of the text strings they contain. When it is off, text strings are wrapped to fit the width of their textboxes, which can cause them to extend below the bottom of the box.

If you resize a textbox in plot edit mode or change the width or height of its Position property directly, MATLAB sets the object's FitBoxToText property to off. You can toggle this property with set, with the Property Inspector, or in plot edit mode via the object's context menu.

FitHeightToText

on | off

Automatically adjust text box width and height to fit text. MATLAB automatically wraps text strings to fit the width of the text box. However, if the text string is long enough, it can extend beyond the bottom of the text box.

 Note:   The property is obsolete. To control line wrapping behavior in textboxes, use FitBoxToText instead.

When you set this mode to on, MATLAB automatically adjusts the height of the text box to accommodate the string, doing so as you create or edit the string.

The fit-size-to-text behavior turns off if you resize the text box programmatically or manually in plot edit mode.

However, if you resize the text box from any other handles, the position you set is honored without regard to how the text fits the box.

FontAngle

{normal} | italic | oblique

Character slant. MATLAB uses this property to select a font from those available on your particular system. Generally, setting this property to italic or oblique selects a slanted font.

FontName

string

Font family. A string specifying the name of the font to use for the text. To display and print properly, this font must be supported on your system. The default font is Helvetica.

FontSize

size in points

Approximate size of text characters. Specify in points. 1 point = 1/72 inch. The default size is 10.

FontUnits

{points} | normalized | inches | centimeters | pixels

Font size units. MATLAB uses this property to determine the units used by the FontSize property. Normalized units interpret FontSize as a fraction of the height of the parent axes. When you resize the axes, MATLAB modifies the screen FontSize accordingly. pixels, inches, centimeters, and points are absolute units. 1 point = 1/72 inch.

FontWeight

{normal} | bold | light | demi

Weight of text characters. MATLAB uses this property to select a font from those available on your system. Generally, setting this property to bold or demi causes MATLAB to use a bold font.

HorizontalAlignment

{left} | center | right

Horizontal alignment of text. Specifies the horizontal justification of the text string within the textbox. It determines where MATLAB places the string horizontally with regard to the points specified by the Position property.

Interpreter

latex | {tex} | none

Interpret TeX instructions. This property controls whether MATLAB interprets certain characters in the String property as TeX instructions (default) or displays all characters literally. The options are:

• latex — Supports a basic subset of the LaTeX markup language.

• tex — Supports a subset of plain TeX markup language. See the String property for a list of supported TeX instructions.

• none — Displays literal characters.

LineStyle

{-} | -- | : | -. | none

Line style of annotation textbox object.

LineWidth

size in points

Width of linear objects and edges of filled areas. Specify in points. 1 point = 1/72 inch. The default is 0.5 points.

Margin

size in pixels

Space around text. A value in pixels that defines the space around the text string, but within the rectangle. Default value is 5 pixels.

Position

four-element vector [x, y, width, height]

Size and location of the object. Specify the lower left corner of the object with the first two elements of the vector defining the point x, y in units normalized to the figure (when Units property is normalized). width and height specify the object's dx and dy, respectively, in units normalized to the figure. The default value is [0.3 0.3 0.1 0.1].

String

string

Text string. Specify this property as a quoted string for single-line strings, or as a cell array of strings, or a padded string matrix for multiline strings. MATLAB displays this string at the specified location. Vertical slash characters are not interpreted as line breaks in text strings, and are drawn as part of the text string. See Mathematical Symbols, Greek Letters, and TeX Characters for an example.

 Note:   The words default, factory, and remove are reserved words that will not appear in a figure when quoted as a normal string. In order to display any of these words individually, type '\reserved_word' instead of 'reserved_word'.

When the text Interpreter property is tex (the default), you can use a subset of TeX commands embedded in the string to produce special characters such as Greek letters and mathematical symbols. The following table lists these characters and the character sequences used to define them.

You can also specify stream modifiers that control font type and color. The first four modifiers are mutually exclusive. However, you can use \fontname in combination with one of the other modifiers.

Units

{normalized} | inches | centimeters | characters | points | pixels

Position units. MATLAB uses this property to determine the units used by the Position property. All positions are measured from the lower left corner of the figure window.

• normalized — Interpret Position as a fraction of the width and height of the parent axes. When you resize the axes, MATLAB modifies the size of the object accordingly.

• pixels, inches, centimeters, and points — Absolute units. 1 point = 1/72 inch.

• characters — Based on the size of characters in the default system font. The width of one characters unit is the width of the letter x, and the height of one characters unit is the distance between the baselines of two lines of text.

VerticalAlignment

top | cap | {middle} | baseline |
bottom

Vertical alignment of text. Specifies the vertical justification of the text string within the textbox. It determines where MATLAB places the string vertically with regard to the points specified by the Position property.

Note that top and cap both place the text at the top of the box, while baseline and bottom both align the text on the bottom.