Documentation

Annotate Models

Describe models by adding and text and image annotations

Add text, images, TeX commands, and buttons that perform an action to your model to help others better understand the model. For an overview of how to create these types of annotations, see Describe Models Using Annotations. To learn about other techniques for improving model readability, see Adjust Visual Presentation to Improve Model Readability.

Blocks

DocBlock Create text that documents model and save text with model
Model Info Display model properties and text in model

Functions

add_block Add block to model
docblock Get or set editor invoked by Simulink DocBlock
hilite_system Highlight block, signal line, port, or annotation
getCallbackAnnotation Get information about annotation

Classes

Simulink.Annotation Specify properties of model annotation

Examples and How To

Describe Models Using Annotations

To help others to understand a model, add visual elements, such as descriptive text, images, or buttons that perform an action such as open a link.

Create an Annotation

This example shows how to create and format an annotation that includes a bullet list, numbered list, image, and a hyperlink.

Show or Hide Annotations

By converting an annotation to markup, you can control whether to hide or display it.

Add an Annotation Callback

Associate a callback with an annotation for when you load, delete, or click an annotation.

Create an Annotation Programmatically

The annotation API enables you to work with annotations programmatically.

Was this topic helpful?