Documentation

This is machine translation

Translated by Microsoft
Mouse over text to see original. Click the button below to return to the English verison of the page.

Annotation Line Properties

Control annotation line appearance and behavior

Annotation line properties control the appearance and behavior of an annotation line object. By changing property values, you can modify certain aspects of the line.

Starting in R2014b, you can use dot notation to query and set properties.

h = annotation('line');
c = h.Color;
h.Color = 'red';

If you are using an earlier release, use the get and set functions instead.

Appearance

expand all

Line style, specified as one of the line styles listed in this table.

Line StyleDescriptionResulting Line
'-'Solid line

'--'Dashed line

':'Dotted line

'-.'Dash-dotted line

'none'No lineNo line

Line width, specified as a positive value in point units. One point equals 1/72 inch.

Example: 0.75

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Line color, specified as an RGB triplet or a character vector of a color name. The default RGB triplet value of [0 0 0] corresponds to black.

An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7]. This table lists the long and short color name options and the equivalent RGB triplet values.

Long NameShort NameRGB Triplet
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black''k'[0 0 0]

Example: 'blue'

Example: [0 0 1]

Location and Size

expand all

Beginning and ending x-coordinates, specified as a two-element vector of the form [x_begin x_end].

By default, the units are normalized to the figure. The lower-left corner of the figure maps to (0,0) and the upper-right corner maps to (1,1). To change the units, use the Units property.

Example: [0.2 0.3]

Beginning and ending y-coordinates, specified as a two-element vector of the form [y_begin y_end].

By default, the units are normalized to the figure. The lower-left corner of the figure maps to (0,0) and the upper-right corner maps to (1,1). To change the units, use the Units property.

Example: [0.2 0.3]

Size and location, specified as a four-element vector of the form [x_begin y_begin dx dy]. The first two elements specify the coordinates of the starting point of the line. The second two elements specify the slope of the line.

By default, the units are normalized to the figure. The lower-left corner of the figure maps to (0,0) and the upper-right corner maps to (1,1). To change the units, use the Units property. To change the units, use the Units property.

Example: [0.2 0.2 0.3 0.3]

Position units, specified as one of the values in this table.

UnitsDescription
'normalized' (default)Normalized with respect to the figure, uipanel, or uitab that contains the annotation. The lower-left corner of the container maps to (0,0) and the upper-right corner maps to (1,1).
'inches'Inches.
'centimeters'Centimeters.
'characters'Based on the default system font character size.
  • Character width = width of letter x.

  • Character height = distance between the baselines of two lines of text.

'points'Points. One point equals 1/72 inch.
'pixels'

Pixels.

Starting in R2015b, distances in pixels are independent of your system resolution on Windows® and Macintosh systems:

  • On Windows systems, a pixel is 1/96th of an inch.

  • On Macintosh systems, a pixel is 1/72nd of an inch.

On Linux® systems, the size of a pixel is determined by your system resolution.

All units are measured from the lower-left corner of the figure window.

This property affects the Position property. If you change the units, then it is good practice to return it to the default value after completing your computation to prevent affecting other functions that assume Units is set to the default value.

If you specify the Position and Units properties as Name,Value pairs when creating the annotation line, then the order of specification matters. If you want to define the position with particular units, then you must set the Units property before the Position property.

Was this topic helpful?