Contenu principal

Simulink.Annotation

Créer et spécifier les propriétés des annotations de texte, d’image et de zone

Description

Les annotations sont des éléments visuels que vous pouvez utiliser pour ajouter des notes descriptives et des légendes à votre modèle. Vous pouvez y accéder et les convertir en objets Simulink.Annotation de manière programmatique.

Pour obtenir un objet Simulink.Annotation existant, sélectionnez l’annotation. Ensuite, utilisez la fonction getCurrentAnnotation.

Création

Plusieurs méthodes sont disponibles pour la création d’un objet Simulink.Annotation.

  • Pour créer un objet Annotation de manière programmatique, utilisez la fonction Simulink.Annotation décrite sur cette page.

  • Pour créer un objet Annotation de manière interactive, consultez Annotate Models.

Description

a = Simulink.Annotation(sys,name) crée une annotation avec le nom et les propriétés par défaut spécifiés dans le système ou sous-système indiqué.

exemple

a = Simulink.Annotation(path,Name,Value) crée une annotation avec les propriétés spécifiées à l’aide de paires nom-valeur. Par exemple, Simulink.Annotation('model/annotation','BackgroundColor','yellow') crée une annotation avec un arrière-plan jaune. Vous pouvez spécifier plusieurs paires nom-valeur. Placez chaque nom de propriété entre guillemets.

exemple

Arguments en entrée

développer tout

Système ou sous-système dans lequel l’annotation doit être incluse, spécifié en tant que vecteur de caractères ou string scalar.

Types de données : char | string

Nom de la nouvelle annotation, spécifié en tant que vecteur de caractères.

Types de données : char

Chemin d’accès de la nouvelle annotation, spécifié en tant que vecteur de caractères ou string scalar et composé du nom du système et du nom de l’annotation.

Exemple : Simulink.Annotation('model/annotation')

Types de données : char | string

Propriétés

développer tout

Interaction

Option permettant de sélectionner ou désélectionner l’annotation, spécifiée en tant que 'on' ou 'off', en tant que valeur numérique ou en tant que valeur logique 1 (true) ou 0 (false). La valeur 'on' est équivalente à true, et la valeur 'off' est équivalente à false. Vous pouvez donc utiliser la valeur de cette propriété comme une valeur logique. La valeur est stockée sous forme de valeur logique on/off de type OnOffSwitchState.

  • 'on' : sélectionner l’annotation.

  • 'off' : désélectionner l’annotation.

Types de données : logical | char | string

Texte

Texte de l’annotation, spécifié en tant que vecteur de caractères ou string scalar.

Identique à Text.

Types de données : char | string

Texte de l’annotation, spécifié en tant que vecteur de caractères ou string scalar.

Identique à Name.

Types de données : char | string

Option permettant de formater le style du texte, spécifiée en tant que 'off' pour le texte brut, en tant que 'rich' pour le texte enrichi, ou en tant que 'tex' pour le texte contenant des commandes LaTeX. Lorsque vous formatez une annotation en texte brut à l’aide de la barre d’outils de formatage, l’annotation se transforme en annotation en texte enrichi.

Option permettant d’effectuer le rendu du balisage TeX, spécifiée en tant que 'on' ou 'off', en tant que valeur numérique ou en tant que valeur logique 1 (true) ou 0 (false). La valeur 'on' est équivalente à true, et la valeur 'off' est équivalente à false. Vous pouvez donc utiliser la valeur de cette propriété comme une valeur logique. La valeur est stockée sous forme de valeur logique on/off de type OnOffSwitchState.

  • 'on' : effectuer le rendu du balisage TeX.

  • 'off' : ne pas effectuer le rendu du balisage TeX.

Option permettant d’effectuer une annotation de balisage, spécifiée en tant que 'model' ou 'markup'.

Remarque

Définissez le paramètre de modèle 'ShowMarkup' sur 'on' pour afficher les annotations de balisage ou sur 'off' pour les masquer.

Police

Cette propriété n’affecte que les annotations en texte brut.

Nom de la police, spécifié en tant que vecteur de caractères ou string scalar. La valeur par défaut ('auto') utilise la police par défaut spécifiée pour les annotations dans la boîte de dialogue Font Styles. Pour ouvrir la boîte de dialogue Font Styles, dans l’onglet Format, cliquez sur la flèche du bouton Font Properties, puis sur Fonts for Model.

Types de données : char | string

Cette propriété n’affecte que les annotations en texte brut.

Taille de la police, en points, spécifiée comme un scalaire numérique. La valeur par défaut (-1) utilise la taille de police par défaut spécifiée pour les annotations dans la boîte de dialogue Font Styles. Pour ouvrir la boîte de dialogue Font Styles, dans l’onglet Format, cliquez sur la flèche du bouton Font Properties, puis sur Fonts for Model.

Types de données : single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Cette propriété n’affecte que les annotations en texte brut.

Épaisseur des caractères, spécifiée comme l’une des valeurs répertoriées dans le tableau.

ValeurDescription
'auto' Poids par défaut des annotations spécifié dans la boîte de dialogue Font Styles. Pour ouvrir la boîte de dialogue Font Styles, dans l’onglet Format, cliquez sur la flèche du bouton Font Properties, puis sur Fonts for Model.
'normal'Épaisseur de police standard.
'bold'Épaisseur de police gras.
'light'Non recommandée.
'demi'Non recommandée.

Cette propriété n’affecte que les annotations en texte brut.

Angle de la police de l’annotation, spécifié comme l’une des valeurs répertoriées dans le tableau.

ValeurDescription
'auto' Angle de police par défaut spécifié pour les annotations dans la boîte de dialogue Font Styles. Pour ouvrir la boîte de dialogue Font Styles, dans l’onglet Format, cliquez sur la flèche du bouton Font Properties, puis sur Fonts for Model.
'normal'Police standard.
'italic'Police italique.
'oblique'Police oblique (généralement identique à la police italique).

Couleurs et effets

Couleur d’arrière-plan de l’annotation, spécifiée comme l’une des valeurs répertoriées dans le tableau ci-dessous.

ValeurDescription
'automatic'Transparent
'black'Noir
'white'Blanc
'red'Rouge
'green'Vert
'blue'Bleu
'cyan'Cyan
'magenta'Magenta
'yellow'Jaune
'gray'Gris
'lightBlue'Bleu clair
'orange'Orange
'darkGreen'Vert foncé
Tableau de valeurs RGB, spécifié en tant que '[r,g,b]'r, g et b correspondent aux valeurs rouge, vert et bleu de la couleur normalisée sur la plage allant de 0.0 à 1.0.Couleur personnalisée entièrement opaque

Types de données : char | string

Couleur de premier plan de l’annotation, spécifiée comme l’une des valeurs répertoriées dans le tableau ci-dessous.

ValeurDescription
'black'Noir
'white'Blanc
'red'Rouge
'green'Vert
'blue'Bleu
'cyan'Cyan
'magenta'Magenta
'yellow'Jaune
'gray'Gris
'lightBlue'Bleu clair
'orange'Orange
'darkGreen'Vert foncé
Tableau de valeurs RGB, spécifié en tant que '[r,g,b]'r, g et b correspondent aux valeurs rouge, vert et bleu de la couleur normalisée sur la plage allant de 0.0 à 1.0.Couleur personnalisée entièrement opaque

Types de données : char | string

Option permettant d’afficher une ombre portée, spécifiée en tant que 'on' ou 'off', en tant que valeur numérique ou en tant que valeur logique 1 (true) ou 0 (false). La valeur 'on' est équivalente à true, et la valeur 'off' est équivalente à false. Vous pouvez donc utiliser la valeur de cette propriété comme une valeur logique. La valeur est stockée sous forme de valeur logique on/off de type OnOffSwitchState.

  • 'on' : afficher une ombre portée.

  • 'off' : ne pas afficher d’ombre portée.

Taille et position

Option permettant de contrôler la hauteur de l’annotation, spécifiée en tant que 'on' ou 'off', en tant que valeur numérique ou en tant que valeur logique 1 (true) ou 0 (false). La valeur 'on' est équivalente à true, et la valeur 'off' est équivalente à false. Vous pouvez donc utiliser la valeur de cette propriété comme une valeur logique. La valeur est stockée sous forme de valeur logique on/off de type OnOffSwitchState.

  • 'on' : l’annotation n’est pas redimensionnée pour afficher toutes les modifications apportées au texte. Il se peut que le texte visible soit tronqué.

  • 'off' : l’annotation est automatiquement redimensionnée pour afficher toutes les modifications apportées au texte.

Le redimensionnement interactif de l’annotation définit ce paramètre sur 'on'.

Point d’ancrage vertical de l’annotation, spécifié comme l’une des valeurs répertoriées dans le tableau ci-dessous.

ValeurDescription
'top'

Le haut de l’annotation reste fixe lorsque celle-ci s’agrandit ou rétrécit.

'middle'

Le milieu de l’annotation reste fixe lorsque celle-ci s’agrandit ou rétrécit.

'bottom'

Le bas de l’annotation reste fixe lorsque celle-ci s’agrandit ou rétrécit.

'cap'

Non recommandée.

'baseline'

Non recommandée.

Dépendances

Pour activer VerticalAlignment, définissez FixedHeight sur 'off'.

Option permettant de contrôler la largeur de l’annotation, spécifiée en tant que 'on' ou 'off', en tant que valeur numérique ou en tant que valeur logique 1 (true) ou 0 (false). La valeur 'on' est équivalente à true, et la valeur 'off' est équivalente à false. Vous pouvez donc utiliser la valeur de cette propriété comme une valeur logique. La valeur est stockée sous forme de valeur logique on/off de type OnOffSwitchState.

  • 'on' : l’annotation n’est pas redimensionnée pour afficher toutes les modifications apportées au texte. Lorsque le texte ne tient pas dans les limites de l’annotation, il passe à la ligne suivante.

  • 'off' : l’annotation est automatiquement redimensionnée pour afficher toutes les modifications apportées au texte.

Le redimensionnement interactif de l’annotation définit ce paramètre sur 'on'.

Alignement horizontal du texte dans l’annotation, spécifié comme l’une des valeurs répertoriées dans le tableau.

ValeurRésultat
'left' Le texte de l’annotation est aligné à gauche.
'center'Le texte de l’annotation est centré.
'right'Le texte de l’annotation est aligné à droite.

Espace entre la boîte englobante du texte et les bordures de l’annotation, spécifié sous la forme d’un tableau 1x4. Le tableau indique l’espace entre le texte et chaque côté de l’annotation. Les éléments du tableau spécifient l’espace à gauche, en haut, à droite et en bas dans l’ordre ([left top right bottom]).

Les coordonnées supportées sont comprises entre -1073740824 et 1073740823, tous deux inclus.

Types de données : double

Position de l’annotation, spécifiée sous la forme d’un tableau 1x4. Le tableau indique les positions des côtés de l’annotation, en pixels. Les éléments du tableau spécifient les positions à gauche, en haut, à droite et en bas dans l’ordre ([left top right bottom]).

L’origine est le coin supérieur gauche du canevas Simulink® Editor avant tout redimensionnement du canevas. Les valeurs positives se trouvent à droite et en bas de l’origine. Les valeurs négatives se trouvent à gauche et en haut de l’origine. Les coordonnées supportées sont comprises entre -1073740824 et 1073740823, tous deux inclus.

Dépendances

  • Pour déplacer la position du côté droit de manière programmatique sans déplacer le côté gauche de la même distance, FixedWidth doit être défini sur 'on'.

  • Pour déplacer la position du côté inférieur de manière programmatique sans déplacer le côté supérieur de la même distance, FixedHeight doit être défini sur 'on'.

Types de données : double

Métadonnées

Description de l’annotation, spécifiée en tant que vecteur de caractères ou string scalar.

Types de données : char | string

Libellé de texte de l’annotation, spécifié en tant que vecteur de caractères ou string scalar.

Types de données : char | string

Données à associer à l’annotation.

Types de données : single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string | struct | table | cell | function_handle | categorical | datetime | duration | calendarDuration | fi

Fonctions de callback

Code MATLAB qui s’exécute lorsque vous cliquez sur l’annotation, spécifié en tant que vecteur de caractères ou string scalar.

Pour plus d’informations, consultez Add Hyperlinks to Annotations.

Dépendances

Lorsque UseDisplayTextAsClickCallback est défini sur 'on', la valeur ClickFcn correspond aux valeurs Name et Text.

Types de données : char | string

Option permettant d’utiliser le texte comme fonction de clic, spécifiée en tant que 'on' ou 'off', en tant que valeur numérique ou en tant que valeur logique 1 (true) ou 0 (false). La valeur 'on' est équivalente à true, et la valeur 'off' est équivalente à false. Vous pouvez donc utiliser la valeur de cette propriété comme une valeur logique. La valeur est stockée sous forme de valeur logique on/off de type OnOffSwitchState.

  • 'on' : cliquer sur l’annotation exécute le texte de l’annotation spécifié par Text, qui est interprété comme une expression MATLAB valide.

  • 'off' : cliquer sur l’annotation exécute la fonction spécifiée par ClickFcn, si disponible. Si aucune fonction de clic n’est spécifiée, cliquer sur l’annotation n’exécute aucune fonction.

Pour plus d’informations, consultez Add Hyperlinks to Annotations.

Code MATLAB à exécuter lors du chargement du modèle contenant l’annotation, spécifié en tant que vecteur de caractères ou string scalar. Pour plus d’informations, consultez Add Hyperlinks to Annotations.

Types de données : char | string

Code MATLAB à exécuter avant de supprimer l’annotation de manière programmatique, spécifié en tant que vecteur de caractères ou string scalar.

Pour plus d’informations, consultez Add Hyperlinks to Annotations.

Types de données : char | string

Informations (lecture seule)

Ce propriété est en lecture seule.

Type d’annotation, renvoyé en tant que 'annotation'.

Ce propriété est en lecture seule.

Type d’annotation, spécifié en tant que 'note_annotation' pour une note textuelle, en tant que 'area_annotation' pour une zone, ou en tant que 'image_annotation' pour une image.

Pour créer une zone de manière programmatique, consultez Create Area.

Pour créer une annotation d’image seulement de manière programmatique, consultez setImage.

Ce propriété est en lecture seule.

Vérifier si l’annotation est une annotation d’image seulement, renvoyée en tant que 'on' ou 'off'.

Ce propriété est en lecture seule.

Texte dans l’annotation (sans mise en forme), renvoyé en tant que vecteur.

Ce propriété est en lecture seule.

Handle d’annotation, renvoyé en tant que double.

Ce propriété est en lecture seule.

Système qui contient l’annotation, renvoyé en tant que vecteur de caractères.

Ce propriété est en lecture seule.

Chemin d’accès de l’annotation, renvoyé en tant que vecteur de caractères.

Fonctions d'objet

viewFind annotation
setImageSpecify image to display as annotation
deleteDelete annotation

Exemples

réduire tout

Cet exemple indique comment créer, modifier et afficher une annotation de manière programmatique.

Ouvrez un nouveau modèle.

open_system(new_system)

Créez une annotation avec les propriétés par défaut à l’aide de la fonction Simulink.Annotation.

a = Simulink.Annotation(gcs,'This is an annotation.');

Annotation with the text "This is an annotation"

Après avoir créé l’annotation, utilisez la notation pointée pour définir la valeur des propriétés. Par exemple, appliquez une police de 18 points et un arrière-plan jaune à l’annotation.

a.FontSize = 18;
a.BackgroundColor = 'yellow';

Pour afficher et mettre brièvement en évidence la nouvelle annotation, utilisez la fonction view.

view(a)

The annotation with the text "This is an annotation" is highlighted in yellow.

Créez un nouveau modèle nommé CreateAnnotationModel et ouvrez-le.

new_system('CreateAnnotationModel')
open_system('CreateAnnotationModel')

Utilisez la fonction Simulink.Annotation pour créer une annotation avec une taille de police de 18 points et un arrière-plan bleu clair.

a = Simulink.Annotation(...
    'CreateAnnotationModel/This is an annotation.', ...
    'FontSize',18, ...
    'BackgroundColor','lightblue');

Conseils

  • Pour modifier une annotation existante de manière programmatique, utilisez la fonction find_system pour obtenir le handle d’annotation, puis la fonction get_param pour obtenir l’objet. Par exemple :

    h = find_system(gcs,'FindAll','on','Type','annotation');
    a1 = get_param(h(1),'Object');
  • Si une annotation a invoqué une fonction de callback en cours d’exécution actuellement, utilisez getCallbackAnnotation pour l’identifier. La fonction renvoie l’objet Annotation correspondant. Cette fonction est également utile si vous écrivez une fonction de callback dans un fichier MATLAB distinct qui contient plusieurs appels de callback.

Fonctionnalité alternative

Vous pouvez également créer des annotations à l’aide de la fonction add_block. Par exemple :

  • add_block('built-in/Note','model/This is a note.','BackgroundColor','yellow') crée une annotation de note avec un arrière-plan jaune.

  • add_block('built-in/Area','model/This is an Area.','Position',[120,100,230,200]) crée une annotation de zone à la position spécifiée.

Pour créer une annotation et modifier ses propriétés de manière interactive, consultez Annotate Models.

Historique des versions

Introduit avant R2006a