Documentation

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

Text of annotation. Same as Name.

character vector

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 a Click Function with an Annotation for more information.

character vector

Description

Description of this annotation.

character vector

FontAngle

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

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

FontName

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

character vector

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

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

Text of annotation. Same as Text.

character vector

Selected

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

'on' | 'off'

Parent

Parent name of annotation object.

character vector

Path

Path to the annotation.

character vector

Position

Array specifying the location of the annotation

1x4 array [left top right bottom].

The maximum value for a coordinate is 32767.

HorizontalAlignment

Horizontal alignment of this annotation, e.g., 'center'.

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

VerticalAlignment

Vertical alignment of this annotation (for example, 'middle'.

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

ForegroundColor

Foreground color of this annotation.

RGB value array | [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

Background color of this annotation.

RGB value array | [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

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

'on' | {'off'}

TeXMode

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

'on' | {'off'}

Type

Annotation type. This is always 'annotation'.

character vector

LoadFcn

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

character vector

DeleteFcnMATLAB code to be executed before deleting this annotation. See Annotation Callback Functions.

character vector

RequirementInfo

For internal use.

character vector

Tag

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

character vector

UseDisplayTextAsClickCallback

Character vector 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 a Click Function with an Annotation 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

Character vector 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

Character vector specifying whether or not to use word wrap or to have the width of the annotation expand to accommodate text

'on' | {'off'}, where 'off' means to use word wrap

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.

methods

Display all nonglobal methods of this Annotation object.

set

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

setImage

Set the annotation contents to the specified image file. The resulting annotation is an image-only annotation.

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.

Introduced before R2006a

Was this topic helpful?