Documentation Center

  • Trials
  • Product Updates

Simulink.Annotation

Specify properties of model annotation

Description

Instances of this class specify the properties of annotations. You can use getCallbackAnnotation in an annotation callback function to get the Simulink.Annotation instance for the annotation associated with the callback function. You can use find_system and get_param to get the Simulink.Annotation instance associated with any annotation in a model. For example, the following code gets the annotation object for the first annotation in the currently selected model and turns on its drop shadow

ah = find_system(gcs, 'FindAll', 'on', 'type', 'annotation');
ao = get_param(ah(1), 'Object');
ao.DropShadow = 'on';

Children

None.

Property Summary

PropertyDescriptionValues
Text

String specifying text of annotation. Same as Name.

string

ClickFcn

Specifies MATLAB® code to be executed when a user single-clicks this annotation. Simulink® software stores the code entered in this field with the model. See Associate Click Functions with Annotations for more information.

string

Description

String that describes this annotation.

string

FontAngle

String specifying the angle of the annotation font. The default value, 'auto', specifies use of the model preference for the font angle.

'normal' | 'italic' | 'oblique' | {'auto'}

FontName

String specifying name of annotation's font. The default value, 'auto', specifies use of the model preference for the font.

string

FontSize

Integer specifying size of annotation's font in points. The default value, -1, specifies use of the model preference for the font size.

real {'-1'}

FontWeight

String specifying the weight of the annotation font. The default value, 'auto', specifies use of the model preference for font weight.

'light' | 'normal' | 'demi' | 'bold' | {'auto'}

Handle

Annotation handle.

real

HiliteAncestors

For internal use.

 
Name

String specifying text of annotation. Same as Text.

string

Selected

String specifying whether this annotation is currently selected ('on') or not selected ('off').

'on' | 'off'

Parent

String specifying parent name of annotation object.

string

Path

Path to the annotation.

string

Position

Array specifying the location of the annotation

1x4 array [left top right bottom].

The maximum value for a coordinate is 32767.

HorizontalAlignment

String specifying the horizontal alignment of this annotation, e.g., 'center'.

'center' | {'left'}|'right'

VerticalAlignment

String specifying the vertical alignment of this annotation (for example, 'middle'.

'middle' | {'top'}|'cap'|'baseline'|'bottom'

ForegroundColor

String specifying foreground color of this annotation.

RGB value array string | [r,g,b,a] where r, g, b, and a are the red, green, blue, and alpha values of the color normalized to the range 0.0 to 1.0, delineated with commas. The alpha value is optional and ignored.

Annotation background color can also be 'black', 'white', 'red', 'green', 'blue', 'cyan', 'magenta', 'yellow', 'gray', 'lightBlue', 'orange', 'darkGreen'.

BackgroundColor

String specifying background color of this annotation.

RGB value array string | [r,g,b,a] where r, g, b, and a are the red, green, blue, and alpha values of the color normalized to the range 0.0 to 1.0, delineated with commas. The alpha value is optional and ignored.

Annotation background color can also be 'black', 'white', 'red', 'green', 'blue', 'cyan', 'magenta', 'yellow', 'gray', 'lightBlue', 'orange', 'darkGreen'.

DropShadow

String specifying whether to display a drop shadow. Options are 'on' or 'off'.

'on' | {'off'}

TeXMode

String specifying whether to render TeX markup. Options are 'on' or 'off'.

'on' | {'off'}

Type

Annotation type. This is always 'annotation'

string

LoadFcn

String specifying MATLAB code to be executed when the model containing this annotation is loaded. See Annotation Callback Functions.

string

DeleteFcnString specifying MATLAB code to be executed before deleting this annotation. See Annotation Callback Functions.

string

RequirementInfo

For internal use.

string

Tag

User-specified text that is assigned to the annotation Tag parameter and saved with the annotation.

string

UseDisplayTextAsClickCallback

String specifying whether to use the contents of the Text property as the click function for this annotation. Options are 'on' or 'off'.

If set to 'on', the text of the annotation is interpreted as a valid MATLAB expression and run. If set to 'off', clicking the annotation runs the click function, if there is one. If there is no click function, clicking the annotation has no effect.

See Associate Click Functions with Annotations for more information.

'on' | {'off'}

UserData

Any data that you want to associate with this annotation.

vector

Interpreter

Type of annotation

'rich' | 'tex' | {'off'}

IsImage

Only 'on' if the annotation is an image annotation

'on' | {'off'}

InternalMargins

Array specifying the space from the bounding box of text to the borders of the annotation.

1x4 array [left top right bottom] . The default is [1 1 1 1].

The maximum value for a coordinate is 32767.

PlainText

Read-only display of the text in the annotation, without formatting

vector

FixedHeight

String specifying whether the bottom border of the annotation resizes as you add content

'on' | {'off'}, where 'off' means that the bottom border resizes as you add content

FixedWidth

String specifying whether or not to use wordwrap or to have the width of the annotation expand to accommodate text

'on' | {'off'}, where 'off' means to use wordwrap

Method Summary

Method

Description

delete

Delete this annotation from the Simulink model.

dialog

Display the Annotation properties dialog box.

disp

Display the property names and their settings for this Annotation object.

fitToView

Zoom in on this annotation and highlight it in the model.

get

Return the specified property settings for this annotation.

help

Display a list of properties for this Annotation object with short descriptions.

insertImage

Insert image from clipboard or image file into an annotation.

methods

Display all nonglobal methods of this Annotation object.

set

Set the specified property of this Annotation object with the specified value.

struct

Return and display a MATLAB structure containing the property settings of this Annotation object.

view

Display this annotation in the Simulink Editor with this annotation highlighted.

Was this topic helpful?