La traduzione di questa pagina non è aggiornata. Fai clic qui per vedere l'ultima versione in inglese.

Simulink.Annotation

Creare e specificare le proprietà di testo, immagine e annotazioni di area

espandi tutto nella pagina

Descrizione

Le annotazioni sono elementi visivi che è possibile utilizzare per aggiungere note descrittive e didascalie al modello. È possibile accedervi e modificarli in modo programmatico come oggetti Simulink.Annotation.

Per acquisire un oggetto Simulink.Annotation esistente, selezionare l'annotazione. Quindi, utilizzare la funzione getCurrentAnnotation.

Creazione

È possibile creare un oggetto Simulink.Annotation in diversi modi.

  • Per creare un oggetto Annotation in modo programmatico, utilizzare la funzione Simulink.Annotation descritta in questa pagina.

  • Per creare un oggetto Annotation in modo interattivo, vedere Annotate Models.

Sintassi

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

Descrizione

a = Simulink.Annotation(sys,name) crea un'annotazione con il nome specificato e le proprietà predefinite nel sistema o sottosistema specificato.

esempio

a = Simulink.Annotation(path,Name,Value) crea un'annotazione con le proprietà specificate utilizzando le coppie nome-valore. Ad esempio, Simulink.Annotation('model/annotation','BackgroundColor','yellow') crea un'annotazione con uno sfondo giallo. È possibile specificare più coppie nome-valore. Racchiudere tra virgolette ogni nome di proprietà.

esempio

Argomenti di input

espandi tutto

Sistema o sottosistema in cui inserire l'annotazione, specificato come vettore di caratteri o scalare stringa.

Tipi di dati: char | string

Nome della nuova annotazione, specificato come vettore di caratteri.

Tipi di dati: char

Percorso alla nuova annotazione, specificato come vettore di caratteri o scalare stringa composto dal nome del sistema e dal nome dell'annotazione.

Esempio Simulink.Annotation('model/annotation')

Tipi di dati: char | string

Proprietà

espandi tutto

Interazione

Opzione per selezionare o deselezionare l'annotazione, specificata come 'on' o 'off', oppure 1 (true) o 0 (false) numerico o logico. Un valore di 'on' equivale a true e 'off' equivale a false. Quindi, è possibile utilizzare il valore di questa proprietà come valore logico. Il valore è memorizzato come valore logico on/off di tipo OnOffSwitchState.

  • 'on': selezionare l'annotazione.

  • 'off': rimuovere la selezione dall'annotazione.

Tipi di dati: logical | char | string

Testo

Testo dell'annotazione, specificato come vettore di caratteri o scalare stringa.

Come per Text.

Tipi di dati: char | string

Testo dell'annotazione, specificato come vettore di caratteri o scalare stringa.

Come per Name.

Tipi di dati: char | string

Opzione per formattare lo stile del testo, specificata come 'off' per testo normale, 'rich' per rich text o 'tex' per testo che contiene comandi LaTex. Quando si formatta un'annotazione in testo normale utilizzando la barra degli strumenti di formattazione, l'annotazione diventa un'annotazione in rich text.

Opzione per il rendering del markup TeX, specificata come 'on' o 'off', oppure 1 (true) o 0 (false) numerico o logico. Un valore di 'on' equivale a true e 'off' equivale a false. Quindi, è possibile utilizzare il valore di questa proprietà come valore logico. Il valore è memorizzato come valore logico on/off di tipo OnOffSwitchState.

  • 'on': effettuare il rendering del markup TeX.

  • 'off': non effettuare il rendering del markup TeX.

Opzione per creare l'annotazione del markup, specificata come 'model' o 'markup'.

Nota

Impostare il parametro del modello 'ShowMarkup' su 'on' per mostrare le annotazioni del markup o su 'off' per nasconderle.

Carattere

Questa proprietà influisce solo sulle annotazioni in testo normale.

Nome del carattere, specificato come vettore di caratteri o scalare stringa. Il valore predefinito 'auto', utilizza il carattere predefinito per le annotazioni specificato nella finestra di dialogo Font Styles (Stili di carattere). Per aprire la finestra di dialogo Font Styles (Stili di carattere), nella scheda Format, fare clic sulla freccia del pulsante Font Properties, quindi su Fonts for Model.

Tipi di dati: char | string

Questa proprietà influisce solo sulle annotazioni in testo normale.

Dimensione del carattere, in punti, specificata come scalare numerico. Il valore predefinito -1, utilizza la dimensione predefinita del carattere per le annotazioni specificata nella finestra di dialogo Font Styles (Stili di carattere). Per aprire la finestra di dialogo Font Styles (Stili di carattere), nella scheda Format, fare clic sulla freccia del pulsante Font Properties, quindi su Fonts for Model.

Tipi di dati: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Questa proprietà influisce solo sulle annotazioni in testo normale.

Spessore del carattere, specificato come uno dei valori elencati nella tabella.

ValoreDescrizione
'auto' Lo spessore predefinito per le annotazioni specificato nella finestra di dialogo Font Styles (Stili di carattere). Per aprire la finestra di dialogo Font Styles (Stili di carattere), nella scheda Format, fare clic sulla freccia del pulsante Font Properties, quindi su Fonts for Model.
'normal'Spessore normale del carattere.
'bold'Spessore in grassetto del carattere.
'light'Non consigliato.
'demi'Non consigliato.

Questa proprietà influisce solo sulle annotazioni in testo normale.

Inclinazione del carattere dell'annotazione, specificata come uno dei valori elencati nella tabella.

ValoreDescrizione
'auto' L'inclinazione predefinita del carattere per le annotazioni specificata nella finestra di dialogo Font Styles (Stili di carattere). Per aprire la finestra di dialogo Font Styles (Stili di carattere), nella scheda Format, fare clic sulla freccia del pulsante Font Properties, quindi su Fonts for Model.
'normal'Carattere normale.
'italic'Carattere corsivo.
'oblique'Carattere obliquo (di solito uguale al carattere corsivo).

Colori ed effetti

Colore di sfondo dell'annotazione, specificato come uno dei valori elencati in questa tabella.

ValoreDescrizione
'automatic'Trasparente
'black'Nero
'white'Bianco
'red'Rosso
'green'Verde
'blue'Blu
'cyan'Ciano
'magenta'Magenta
'yellow'Giallo
'gray'Grigio
'lightBlue'Azzurro
'orange'Arancione
'darkGreen'Verde scuro
Array di valori RGB, specificato come '[r,g,b]', dove r, g e b sono i valori rosso, verde e blu del colore normalizzato sull'intervallo da 0.0 a 1.0.Colore personalizzato completamente opaco

Tipi di dati: char | string

Colore in primo piano dell'annotazione, specificato come uno dei valori elencati in questa tabella.

ValoreDescrizione
'black'Nero
'white'Bianco
'red'Rosso
'green'Verde
'blue'Blu
'cyan'Ciano
'magenta'Magenta
'yellow'Giallo
'gray'Grigio
'lightBlue'Azzurro
'orange'Arancione
'darkGreen'Verde scuro
Array di valori RGB, specificato come '[r,g,b]', dove r, g e b sono i valori rosso, verde e blu del colore normalizzato sull'intervallo da 0.0 a 1.0.Colore personalizzato completamente opaco

Tipi di dati: char | string

Opzione per visualizzare l'ombra proiettata, specificata come 'on' o 'off', oppure 1 (true) o 0 (false) numerico o logico. Un valore di 'on' equivale a true e 'off' equivale a false. Quindi, è possibile utilizzare il valore di questa proprietà come valore logico. Il valore è memorizzato come valore logico on/off di tipo OnOffSwitchState.

  • 'on': visualizzare l'ombra proiettata.

  • 'off': non visualizzare l'ombra proiettata.

Grandezza e posizione

Opzione per controllare l'altezza dell'annotazione, specificata come 'on' o 'off', oppure 1 (true) o 0 (false) numerico o logico. Un valore di 'on' equivale a true e 'off' equivale a false. Quindi, è possibile utilizzare il valore di questa proprietà come valore logico. Il valore è memorizzato come valore logico on/off di tipo OnOffSwitchState.

  • 'on': l'annotazione non si ridimensiona per adattarsi alle modifiche del testo. Il testo visibile potrebbe essere troncato.

  • 'off': l'annotazione si ridimensiona automaticamente per adattarsi alle modifiche del testo.

Il ridimensionamento in modo interattivo dell'annotazione imposta questo parametro su 'on'.

Punto di ancoraggio verticale dell'annotazione, specificato come uno dei valori elencati in questa tabella.

ValoreDescrizione
'top'

La parte superiore dell'annotazione rimane fissa mentre l'annotazione si espande o si riduce.

'middle'

La parte centrale dell'annotazione rimane fissa mentre l'annotazione si espande o si riduce.

'bottom'

La parte inferiore dell'annotazione rimane fissa mentre l'annotazione si espande o si riduce.

'cap'

Non consigliato.

'baseline'

Non consigliato.

Dipendenze

Per abilitare VerticalAlignment, impostare FixedHeight su 'off'.

Opzione per controllare la larghezza dell'annotazione, specificata come 'on' o 'off', oppure 1 (true) o 0 (false) numerico o logico. Un valore di 'on' equivale a true e 'off' equivale a false. Quindi, è possibile utilizzare il valore di questa proprietà come valore logico. Il valore è memorizzato come valore logico on/off di tipo OnOffSwitchState.

  • 'on': l'annotazione non si ridimensiona per adattarsi alle modifiche del testo. Quando il testo non può essere contenuto entro i limiti dell'annotazione, va a capo sulla riga successiva.

  • 'off': l'annotazione si ridimensiona automaticamente per adattarsi alle modifiche del testo.

Il ridimensionamento in modo interattivo dell'annotazione imposta questo parametro su 'on'.

Allineamento orizzontale del testo all'interno dell'annotazione, specificato come uno dei valori elencati nella tabella.

ValoreRisultato
'left' Il testo nell'annotazione è giustificato a sinistra.
'center'Il testo nell'annotazione è centrato.
'right'Il testo nell'annotazione è giustificato a destra.

Spazio tra il riquadro di delimitazione del testo e i bordi dell'annotazione, specificato come array 1x4. L'array fornisce lo spazio tra il testo e ciascun lato dell'annotazione. Gli elementi dell'array specificano lo spazio sui lati sinistro, superiore, destro e inferiore nel seguente ordine ([left top right bottom]).

Le coordinate supportate vanno da -1073740824 a 1073740823, estremi inclusi.

Tipi di dati: double

Posizione dell'annotazione, specificata come array 1x4. L'array fornisce le posizioni dei lati dell'annotazione, in pixel. Gli elementi dell'array specificano le posizioni dei lati sinistro, superiore, destro e inferiore nel seguente ordine ([left top right bottom]).

L'origine è l'angolo superiore sinistro dell'area di disegno dell'Editor di Simulink® prima di qualsiasi ridimensionamento dell'area di disegno. I valori positivi si trovano a destra e in basso rispetto all'origine. I valori negativi si trovano a sinistra e in alto rispetto all'origine. Le coordinate supportate vanno da -1073740824 a 1073740823, estremi inclusi.

Dipendenze

  • Per spostare in modo programmatico la posizione del lato destro senza spostare il lato sinistro nella stessa misura, FixedWidth deve essere impostato su 'on'.

  • Per spostare in modo programmatico la posizione del lato inferiore senza spostare il lato superiore nella stessa misura, FixedHeight deve essere impostato su 'on'.

Tipi di dati: double

Metadati

Descrizione dell'annotazione, specificata come vettore di caratteri o scalare stringa.

Tipi di dati: char | string

Etichetta di testo per l'annotazione, specificata come vettore di caratteri o scalare stringa.

Tipi di dati: char | string

Dati da associare all'annotazione.

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

Funzioni di richiamo

Codice MATLAB che viene eseguito quando si fa clic sull'annotazione, specificato come vettore di caratteri o scalare stringa.

Per ulteriori informazioni, vedere Add Hyperlinks to Annotations.

Dipendenze

Quando UseDisplayTextAsClickCallback è impostato su 'on', il valore ClickFcn corrisponde ai valori Name e Text.

Tipi di dati: char | string

Opzione per utilizzare il testo come funzione clic, specificata come 'on' o 'off', oppure 1 (true) o 0 (false) numerico o logico. Un valore di 'on' equivale a true e 'off' equivale a false. Quindi, è possibile utilizzare il valore di questa proprietà come valore logico. Il valore è memorizzato come valore logico on/off di tipo OnOffSwitchState.

  • 'on': facendo clic sull'annotazione viene eseguito il testo dell'annotazione specificato da Text, che viene interpretato come un'espressione valida di MATLAB.

  • 'off': facendo clic sull'annotazione viene eseguita la funzione specificata da ClickFcn, se disponibile. Se non è specificata una funzione clic, facendo clic sull'annotazione non viene eseguita alcuna funzione.

Per ulteriori informazioni, vedere Add Hyperlinks to Annotations.

Codice MATLAB da eseguire quando viene caricato il modello contenente l'annotazione, specificato come vettore di caratteri o scalare stringa. Per ulteriori informazioni, vedere Add Hyperlinks to Annotations.

Tipi di dati: char | string

Codice MATLAB da eseguire prima di eliminare l'annotazione in modo programmatico, specificato come vettore di caratteri o scalare stringa.

Per ulteriori informazioni, vedere Add Hyperlinks to Annotations.

Tipi di dati: char | string

Informazioni (sola lettura)

proprietà è di sola lettura.

Tipo annotazione, restituito come 'annotation'.

proprietà è di sola lettura.

Tipo di annotazione, specificato come 'note_annotation' per una nota basata su testo, 'area_annotation' per un'area o 'image_annotation' per un'immagine.

Per creare un'area in modo programmatico, vedere Create Area.

Per creare un'annotazione consistente solo in un'immagine in modo programmatico, vedere setImage.

proprietà è di sola lettura.

Conferma se l'annotazione consiste solo in un'immagine, restituita come 'on' o 'off'.

proprietà è di sola lettura.

Testo nell'annotazione, senza formattazione, restituito come vettore.

proprietà è di sola lettura.

Handle dell'annotazione, restituito come doppio.

proprietà è di sola lettura.

Sistema che contiene l'annotazione, restituito come vettore di caratteri.

proprietà è di sola lettura.

Percorso all'annotazione, restituito come vettore di caratteri.

Funzioni oggetto

viewFind annotation
setImageSpecify image to display as annotation
deleteDelete annotation

Esempi

comprimi tutto

Apri live script

Questo esempio mostra come creare, modificare e visualizzare un'annotazione in modo programmatico.

Aprire un nuovo modello.

open_system(new_system)

Creare un'annotazione con le proprietà predefinite utilizzando la funzione Simulink.Annotation.

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

Annotation with the text "This is an annotation"

Dopo aver creato l'annotazione, utilizzare la notazione a punti per impostare i valori delle proprietà. Ad esempio, utilizzare nell'annotazione un carattere a 18 punti e uno sfondo giallo.

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

Per visualizzare ed evidenziare brevemente la nuova annotazione, utilizzare la funzione view.

view(a)

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

Apri live script

Creare e aprire un nuovo modello denominato CreateAnnotationModel.

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

Utilizzare la funzione Simulink.Annotation per creare un'annotazione con una dimensione del carattere a 18 punti e uno sfondo azzurro. 

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

Suggerimenti

  • Per modificare un'annotazione esistente in modo programmatico, utilizzare la funzione find_system per acquisire l'handle dell'annotazione, quindi la funzione get_param per acquisire l'oggetto. Ad esempio:

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

  • Se un'annotazione ha invocato una funzione di richiamo attualmente in esecuzione, utilizzare getCallbackAnnotation per determinare quale annotazione l'ha invocata. La funzione restituisce l'oggetto Annotation corrispondente. Questa funzione è inoltre utile se si scrive una funzione di richiamo in un file MATLAB separato che contiene più chiamate di richiamo.

Funzionalità alternative

È inoltre possibile creare annotazioni utilizzando la funzione add_block. Ad esempio:

  • add_block('built-in/Note','model/This is a note.','BackgroundColor','yellow') crea un'annotazione di nota con uno sfondo giallo.

  • add_block('built-in/Area','model/This is an Area.','Position',[120,100,230,200]) crea un'annotazione di area nella posizione specificata.

Per creare un'annotazione in modo interattivo e modificarne le proprietà, vedere Annotate Models.

Cronologia versioni

Introduzione prima di R2006a

Vedi anche

| |

Argomenti