Simulink.Annotation

Text-, Bild- und Flächenanmerkungen erstellen und deren Eigenschaften festlegen

alle in Seite erweitern

Beschreibung

Anmerkungen sind visuelle Elemente, mit denen Sie Ihrem Modell Beschreibungen und Angaben hinzufügen können. Über Simulink.Annotation-Objekte können Sie programmatisch auf Anmerkungen zugreifen und diese modifizieren.

Wählen Sie die Anmerkung aus, um ein bestehendes Simulink.Annotation-Objekt abzurufen. Verwenden Sie daraufhin die getCurrentAnnotation-Funktion.

Erstellung

Sie können ein Simulink.Annotation-Objekt auf verschiedene Weisen erstellen.

  • Um ein Annotation-Objekt programmatisch zu erstellen, verwenden Sie die auf dieser Seite beschriebene Simulink.Annotation-Funktion.

  • Um ein Annotation-Objekt interaktiv zu erstellen, siehe Annotate Models.

Syntax

a = Simulink.Annotation(sys,name)
a = Simulink.Annotation(path,Name,Value)

Beschreibung

a = Simulink.Annotation(sys,name) erstellt eine Anmerkung mit dem angegebenen Namen und den Standardeigenschaften im angegebenen System oder Subsystem.

Beispiel

a = Simulink.Annotation(path,Name,Value) erstellt eine Anmerkung mit als Name-Wert-Paare angegebenen Eigenschaften. Simulink.Annotation('model/annotation','BackgroundColor','yellow') erstellt beispielsweise eine Anmerkung mit gelbem Hintergrund. Sie können mehrere Name-Wert-Paare angeben. Setzen Sie jeden Eigenschaftsnamen in Anführungszeichen.

Beispiel

Eingabeargumente

alle erweitern

System oder Subsystem, das die Anmerkung enthalten soll, angegeben als Zeichenvektor oder String-Skalar.

Datentypen: char | string

Name der neuen Anmerkung, als Zeichenvektor angegeben.

Datentypen: char

Pfad zur neuen Anmerkung, angegeben als Zeichenvektor oder String-Skalar aus dem Systemnamen und dem Anmerkungsnamen.

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

Datentypen: char | string

Eigenschaften

alle erweitern

Interaktion

Option zur Aktivierung oder Deaktivierung der Anmerkung, angegeben als 'on' oder 'off' oder numerisch oder logisch 1 (true) oder 0 (false). Der Wert 'on' entspricht true, und 'off' entspricht false. Sie können den Wert dieser Eigenschaft daher als logischen Wert verwenden. Der Wert wird als logischer Ein-/Aus-Wert mit dem Typ OnOffSwitchState gespeichert.

  • 'on' – Anmerkung auswählen.

  • 'off' – Auswahl aus der Anmerkung entfernen.

Datentypen: logical | char | string

Text

Text der Anmerkung, angegeben als Zeichenvektor oder String-Skalar.

Identisch zu Text.

Datentypen: char | string

Text der Anmerkung, angegeben als Zeichenvektor oder String-Skalar.

Identisch zu Name.

Datentypen: char | string

Option zur Formatierung des Textstils, angegeben als 'off' für Klartext, 'rich' für Rich Text oder 'tex' für Text mit LaTeX-Befehlen. Wenn Sie eine Klartext-Anmerkung mit der Formatierungs-Werkzeugleiste formatieren, wird die Anmerkung eine Rich-Text-Anmerkung.

Option zum Rendering von TeX-Markup, angegeben als 'on' oder 'off' oder numerisch oder logisch als 1 (true) oder 0 (false). Der Wert 'on' entspricht true, und 'off' entspricht false. Sie können den Wert dieser Eigenschaft daher als logischen Wert verwenden. Der Wert wird als logischer Ein-/Aus-Wert mit dem Typ OnOffSwitchState gespeichert.

  • 'on' – TeX-Markup rendern.

  • 'off' – TeX-Markup nicht rendern.

Option für Markup-Anmerkungen, angegeben als 'model' oder 'markup'.

Hinweis

Setzen Sie den Modellparameter 'ShowMarkup' auf 'on', um Markup-Anmerkungen anzuzeigen oder auf 'off', um Markup-Anmerkungen zu verbergen.

Schriftart

Diese Eigenschaft wirkt sich nur auf Klartext-Anmerkungen aus.

Name der Schriftart, angegeben als Zeichenvektor oder String-Skalar. Der Standardwert 'auto' verwendet die im Dialogfeld „Font Styles“ festgelegte Standardschriftart für Anmerkungen. Um das Dialogfeld „Font Styles“ zu öffnen, klicken Sie auf der Registerkarte Format auf die Schaltfläche Font Properties und daraufhin auf Fonts for Model.

Datentypen: char | string

Diese Eigenschaft wirkt sich nur auf Klartext-Anmerkungen aus.

Schriftgröße in Punkten, angegeben als numerischer Skalar. Der Standardwert -1 verwendet die im Dialogfeld „Font Styles“ festgelegte Standardschriftgröße für Anmerkungen. Um das Dialogfeld „Font Styles“ zu öffnen, klicken Sie auf der Registerkarte Format auf die Schaltfläche Font Properties und daraufhin auf Fonts for Model.

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

Diese Eigenschaft wirkt sich nur auf Klartext-Anmerkungen aus.

Zeichenstärke, angegeben als einer der Werte in der Tabelle.

WertBeschreibung
'auto' Die Standardstärke für Anmerkungen, festgelegt im Dialogfeld „Font Styles“. Um das Dialogfeld „Font Styles“ zu öffnen, klicken Sie auf der Registerkarte Format auf die Schaltfläche Font Properties und daraufhin auf Fonts for Model.
'normal'Normale Schriftstärke.
'bold'Fette Schriftstärke.
'light'Nicht empfohlen.
'demi'Nicht empfohlen.

Diese Eigenschaft wirkt sich nur auf Klartext-Anmerkungen aus.

Schrägneigung der Anmerkungsschriftart, angegeben als einer der Werte in der Tabelle.

WertBeschreibung
'auto' Die Standard-Schriftneigung für Anmerkungen, festgelegt im Dialogfeld „Font Styles“. Um das Dialogfeld „Font Styles“ zu öffnen, klicken Sie auf der Registerkarte Format auf die Schaltfläche Font Properties und daraufhin auf Fonts for Model.
'normal'Normale Schrift.
'italic'Kursive Schrift.
'oblique'Oblique Schrift (üblicherweise identisch zur kursiven Schrift).

Farben und Effekte

Hintergrundfarbe der Anmerkung, angegeben als einer der Werte in der Tabelle.

WertBeschreibung
'automatic'Transparent
'black'Schwarz
'white'Weiß
'red'Rot
'green'Grün
'blue'Blau
'cyan'Cyan
'magenta'Magenta
'yellow'Gelb
'gray'Grau
'lightBlue'Hellblau
'orange'Orange
'darkGreen'Dunkelgrün
RGB-Wert-Array, angegeben als '[r,g,b]', wobei r, g und b die Rot-, Grün- und Blauwerte der Farbe darstellen, normalisiert auf den Bereich 0.0 bis 1.0.Vollständig undurchsichtige benutzerdefinierte Farbe

Datentypen: char | string

Vordergrundfarbe der Anmerkung, angegeben als einer der Werte in der Tabelle.

WertBeschreibung
'black'Schwarz
'white'Weiß
'red'Rot
'green'Grün
'blue'Blau
'cyan'Cyan
'magenta'Magenta
'yellow'Gelb
'gray'Grau
'lightBlue'Hellblau
'orange'Orange
'darkGreen'Dunkelgrün
RGB-Wert-Array, angegeben als '[r,g,b]', wobei r, g und b die Rot-, Grün- und Blauwerte der Farbe darstellen, normalisiert auf den Bereich 0.0 bis 1.0.Vollständig undurchsichtige benutzerdefinierte Farbe

Datentypen: char | string

Option zum Anzeigen von Schlagschatten, angegeben als 'on' oder 'off' oder numerisch oder logisch als 1 (true) oder 0 (false). Der Wert 'on' entspricht true, und 'off' entspricht false. Sie können den Wert dieser Eigenschaft daher als logischen Wert verwenden. Der Wert wird als logischer Ein-/Aus-Wert mit dem Typ OnOffSwitchState gespeichert.

  • 'on' – Schlagschatten anzeigen.

  • 'off' – Schlagschatten nicht anzeigen.

Größe und Position

Option zur Steuerung der Anmerkungshöhe, angegeben als 'on' oder 'off' oder numerisch oder logisch als 1 (true) oder 0 (false). Der Wert 'on' entspricht true, und 'off' entspricht false. Sie können den Wert dieser Eigenschaft daher als logischen Wert verwenden. Der Wert wird als logischer Ein-/Aus-Wert mit dem Typ OnOffSwitchState gespeichert.

  • 'on' – Die Anmerkung ändert ihre Größe nicht bei Änderungen im Text. Der sichtbare Text könnte gekürzt dargestellt werden.

  • 'off' – Die Anmerkung ändert ihre Größe bei Änderungen im Text.

Wird die Größe der Anmerkung interaktiv geändert, wird dieser Parameter auf 'on' gesetzt.

Vertikaler Ankerpunkt der Anmerkung, angegeben als einer der Werte in der Tabelle.

WertBeschreibung
'top'

Der obere Abschnitt der Anmerkung bleibt fixiert, wenn die Anmerkung vergrößert oder verkleinert wird.

'middle'

Der mittlere Abschnitt der Anmerkung bleibt fixiert, wenn die Anmerkung vergrößert oder verkleinert wird.

'bottom'

Der untere Abschnitt der Anmerkung bleibt fixiert, wenn die Anmerkung vergrößert oder verkleinert wird.

'cap'

Nicht empfohlen.

'baseline'

Nicht empfohlen.

Abhängigkeiten

Um VerticalAlignment zu aktivieren, setzen Sie FixedHeight auf 'off'.

Option zur Steuerung der Anmerkungsbreite, angegeben als 'on' oder 'off' oder numerisch oder logisch als 1 (true) oder 0 (false). Der Wert 'on' entspricht true, und 'off' entspricht false. Sie können den Wert dieser Eigenschaft daher als logischen Wert verwenden. Der Wert wird als logischer Ein-/Aus-Wert mit dem Typ OnOffSwitchState gespeichert.

  • 'on' – Die Anmerkung ändert ihre Größe nicht bei Änderungen im Text. Wenn Text nicht in die Ränder der Anmerkung passt, wird er auf die nächste Zeile umgebrochen.

  • 'off' – Die Anmerkung ändert ihre Größe bei Änderungen im Text.

Wird die Größe der Anmerkung interaktiv geändert, wird dieser Parameter auf 'on' gesetzt.

Horizontale Ausrichtung von Text in der Anmerkung, angegeben als einer der Werte in der Tabelle.

WertErgebnis
'left' Der Anmerkungstext ist linksbündig.
'center'Der Anmerkungstext ist zentriert.
'right'Der Anmerkungstext ist rechtsbündig.

Abstand zwischen Rahmen des Texts und Rändern der Anmerkung, angegeben als 1x4-Array. Das Array legt den Abstand zwischen dem Text und den Rändern der Anmerkung fest. Die Elemente des Arrays legen den Abstand zum linken, oberen, rechten und unteren Rand in dieser Reihenfolge fest ([left top right bottom]).

Es werden Koordinaten von -1073740824 bis einschließlich 1073740823 unterstützt.

Datentypen: double

Position der Anmerkung, angegeben als 1x4-Array. Das Array legt die Position der Ränder der Anmerkung in Pixeln fest. Die Elemente des Arrays legen die Position des linken, oberen, rechten und unteren Rands in dieser Reihenfolge fest ([left top right bottom]).

Der Ursprung ist die obere linke Ecke des Simulink® Editor-Canvas vor Größenänderungen. Positive Werte laufen vom Ursprung aus nach rechts und unten. Negative Werte laufen vom Ursprung aus nach links und oben. Es werden Koordinaten von -1073740824 bis einschließlich 1073740823 unterstützt.

Abhängigkeiten

  • Um die Position des rechten Rands programmatisch zu verschieben, ohne den linken Rand um dieselbe Distanz zu bewegen, muss FixedWidth auf 'on' gesetzt sein.

  • Um die Position des unteren Rands programmatisch zu verschieben, ohne den oberen Rand um dieselbe Distanz zu bewegen, muss FixedHeight auf 'on' gesetzt sein.

Datentypen: double

Metadaten

Beschreibung der Anmerkung, angegeben als Zeichenvektor oder String-Skalar.

Datentypen: char | string

Text-Tag für Anmerkung, angegeben als Zeichenvektor oder String-Skalar.

Datentypen: char | string

Daten zur Verknüpfung mit Anmerkung.

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

Callback-Funktionen

MATLAB-Code, der beim Klick auf die Anmerkung ausgeführt wird, angegeben als Zeichenvektor oder String-Skalar.

Weitere Informationen finden Sie unter Add Hyperlinks to Annotations.

Abhängigkeiten

Wenn UseDisplayTextAsClickCallback auf 'on' gesetzt wird, entspricht der Wert ClickFcn der Eigenschaft Name und dem Wert Text.

Datentypen: char | string

Option, Text als Klick-Funktion zu verwenden, angegeben als 'on' oder 'off' oder numerisch oder logisch als 1 (true) oder 0 (false). Der Wert 'on' entspricht true, und 'off' entspricht false. Sie können den Wert dieser Eigenschaft daher als logischen Wert verwenden. Der Wert wird als logischer Ein-/Aus-Wert mit dem Typ OnOffSwitchState gespeichert.

  • 'on' – Ein Klick auf die Anmerkung führt den über Text festgelegten Anmerkungstext aus, der als gültiger MATLAB-Ausdruck interpretiert wird.

  • 'off' – Ein Klick auf die Anmerkung führt die von ClickFcn festgelegte Funktion aus, so vorhanden. Ist keine Klick-Funktion festgelegt, wird durch Klicken auf die Anmerkung keine Funktion ausgeführt.

Weitere Informationen finden Sie unter Add Hyperlinks to Annotations.

Auszuführender MATLAB-Code, wenn ein Modell mit der Anmerkung geladen wird, angegeben als Zeichenvektor oder String-Skalar. Weitere Informationen finden Sie unter Add Hyperlinks to Annotations.

Datentypen: char | string

Auszuführender MATLAB-Code, bevor die Anmerkung programmatisch gelöscht wird, angegeben als Zeichenvektor oder String-Skalar.

Weitere Informationen finden Sie unter Add Hyperlinks to Annotations.

Datentypen: char | string

Informationen (schreibgeschützt)

Diese Eigenschaft ist schreibgeschützt.

Anmerkungstyp, zurückgegeben als 'annotation'.

Diese Eigenschaft ist schreibgeschützt.

Typ der Anmerkung, angegeben als 'note_annotation' für einen textbasierten Hinweis, 'area_annotation' für eine Fläche oder 'image_annotation' für ein Bild.

Informationen zur programmatischen Erstellung einer Fläche finden Sie unter Create Area.

Informationen zur programmatischen Erstellung einer Bild-Anmerkung finden Sie unter setImage.

Diese Eigenschaft ist schreibgeschützt.

Prüfung, ob eine Anmerkung eine Bild-Anmerkung ist, zurückgegeben als 'on' oder 'off'.

Diese Eigenschaft ist schreibgeschützt.

Text der Anmerkung, ohne Formatierung, zurückgegeben als Vektor.

Diese Eigenschaft ist schreibgeschützt.

Anmerkungs-Handle, zurückgegeben als Double.

Diese Eigenschaft ist schreibgeschützt.

System, das die Anmerkung enthält, zurückgegeben als Zeichenvektor.

Diese Eigenschaft ist schreibgeschützt.

Pfad der Anmerkung, zurückgegeben als Zeichenvektor.

Objektfunktionen

viewFind annotation
setImageSpecify image to display as annotation
deleteDelete annotation

Beispiele

alle reduzieren

Live Script öffnen

Dieses Beispiel zeigt, wie Sie eine Anmerkung programmatisch erstellen, modifizieren und anzeigen.

Öffnen Sie ein neues Modell.

open_system(new_system)

Erstellen Sie mithilfe der Simulink.Annotation-Funktion eine Anmerkung mit Standardeigenschaften.

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

Annotation with the text "This is an annotation"

Verwenden Sie nach Erstellen der Anmerkung die Punktnotation, um die Eigenschaftswerte festzulegen. Stellen Sie für die Anmerkung beispielsweise Schriftgröße 18 und einen gelben Hintergrund ein.

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

Verwenden Sie die view-Funktion, um die neue Anmerkung anzuzeigen und kurz hervorzuheben.

view(a)

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

Live Script öffnen

Erstellen und öffnen Sie ein neues Modell namens CreateAnnotationModel.

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

Verwenden Sie die Simulink.Annotation-Funktion, um eine Anmerkung mit Schriftgröße 18 und einem hellblauen Hintergrund zu erstellen. 

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

Tipps

  • Um eine bestehende Anmerkung programmatisch zu modifizieren, verwenden Sie die find_system-Funktion, um den Anmerkungs-Handle abzurufen und daraufhin die get_param-Funktion, um das Objekt abzurufen. Beispiel:

    h = find_system(gcs,'FindAll','on','Type','annotation');
a1 = get_param(h(1),'Object');

  • Wenn eine Anmerkung eine aktuell ausgeführte Callback-Funktion aufgerufen hat, können Sie mit getCallbackAnnotation ermitteln, welche Anmerkung die Funktion aufgerufen hat. Die Funktion gibt das entsprechende Annotation-Objekt zurück. Diese Funktion ist ebenfalls nützlich, wenn Sie eine Callback-Funktion in einer separaten MATLAB-Datei mit mehreren Callback-Aufrufen schreiben.

Alternative Funktionen

Zudem können Sie über die add_block-Funktion Anmerkungen erstellen. Beispiel:

  • add_block('built-in/Note','model/This is a note.','BackgroundColor','yellow') erstellt eine Hinweis-Anmerkung mit einem gelben Hintergrund.

  • add_block('built-in/Area','model/This is an Area.','Position',[120,100,230,200]) erstellt eine Flächen-Anmerkung an der angegebenen Position.

Weitere Informationen über das interaktive Erstellen von Anmerkungen und die Bearbeitung derer Eigenschaften finden Sie unter Annotate Models.

Versionsverlauf

Eingeführt vor R2006a

Siehe auch

| |

Themen