Main Content

Simulink.Annotation

テキスト、イメージ、領域の注釈の作成とプロパティ指定

このページをすべて展開する

説明

注釈は、モデルにメモやコールアウトを追加するために使用できる視覚的要素です。注釈を Simulink.Annotation オブジェクトとしてプログラムによってアクセスおよび変更できます。

既存の Simulink.Annotation オブジェクトを取得するには、注釈を選択します。その後、関数 getCurrentAnnotation を使用します。

作成

Simulink.Annotation オブジェクトは複数の方法で作成できます。

  • Annotation オブジェクトをプログラムによって作成するには、このページで説明する関数 Simulink.Annotation を使用します。

  • Annotation オブジェクトを対話的に作成するには、メモと注釈を使用したモデルの説明を使用します。

構文

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

説明

例

a = Simulink.Annotation(sys,name) は、指定された名前と既定のプロパティを使用して、指定されたシステムまたはサブシステムに注釈を作成します。

例

a = Simulink.Annotation(path,Name,Value) は、名前と値のペアを使用して指定されたプロパティを使って注釈を作成します。たとえば、Simulink.Annotation('model/annotation','BackgroundColor','yellow') は黄色の背景をもつ注釈を作成します。複数の名前と値のペアを指定できます。各プロパティ名を引用符で囲みます。

入力引数

すべて展開する

注釈を含むシステムまたはサブシステム。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

新しい注釈の名前。文字ベクトルとして指定します。

データ型: char

新しい注釈へのパス。システム名と注釈名で構成される、文字ベクトルまたは string スカラーとして指定します。

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

データ型: char | string

プロパティ

すべて展開する

操作

注釈を選択または選択解除するオプション。'on' または 'off'、あるいは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — 注釈を選択する。

  • 'off' — 注釈から選択を削除する。

データ型: logical | char | string

テキスト

注釈のテキスト。文字ベクトルまたは string スカラーとして指定します。

Text と同じです。

データ型: char | string

注釈のテキスト。文字ベクトルまたは string スカラーとして指定します。

Name と同じです。

データ型: char | string

テキスト スタイルを書式設定するオプション。プレーン テキストの場合は 'off'、リッチ テキストの場合は 'rich'、LaTeX コマンドを含むテキストの場合は 'tex' として指定します。書式設定ツール バーを使用してプレーン テキストの注釈を書式設定する場合、注釈はリッチ テキストの注釈になります。

TeX マークアップをレンダリングするオプション。'on' または 'off'、あるいは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — TeX マークアップをレンダリングする。

  • 'off' — TeX マークアップをレンダリングしない。

マークアップ注釈を作成するオプション。'model' または 'markup' として指定します。

メモ

マークアップ注釈を表示するには 'ShowMarkup' モデル パラメーターを 'on' に設定し、マークアップ注釈を非表示にするには 'off' に設定します。

フォント

このプロパティはプレーン テキストの注釈にのみ影響します。

フォント名。文字ベクトルまたは string スカラーとして指定します。既定値 'auto' では、[フォント スタイル] ダイアログ ボックスで注釈に対して指定された既定のフォントが使用されます。[フォント スタイル] ダイアログ ボックスを開くには、[書式設定] タブで [フォント プロパティ] ボタンの矢印をクリックし、[モデルのフォント] をクリックします。

データ型: char | string

このプロパティはプレーン テキストの注釈にのみ影響します。

フォント サイズ (ポイント単位)。数値スカラーとして指定します。既定値 -1 では、[フォント スタイル] ダイアログ ボックスで注釈に対して指定された既定のフォント サイズが使用されます。[フォント スタイル] ダイアログ ボックスを開くには、[書式設定] タブで [フォント プロパティ] ボタンの矢印をクリックし、[モデルのフォント] をクリックします。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

このプロパティはプレーン テキストの注釈にのみ影響します。

文字の太さ。表にリストされている値のいずれかとして指定します。

値説明
'auto' [フォント スタイル] ダイアログ ボックスで指定された注釈の既定の太さ。[フォント スタイル] ダイアログ ボックスを開くには、[書式設定] タブで [フォント プロパティ] ボタンの矢印をクリックし、[モデルのフォント] をクリックします。
'normal'標準フォントの太さ。
'bold'太字フォントの太さ。
'light'推奨されません。
'demi'推奨されません。

このプロパティはプレーン テキストの注釈にのみ影響します。

注釈のフォントの角度。表にリストされている値のいずれかとして指定します。

値説明
'auto' [フォント スタイル] ダイアログ ボックスで注釈に対して指定された既定のフォントの角度。[フォント スタイル] ダイアログ ボックスを開くには、[書式設定] タブで [フォント プロパティ] ボタンの矢印をクリックし、[モデルのフォント] をクリックします。
'normal'標準フォント。
'italic'イタリック フォント。
'oblique'斜体フォント (通常はイタリック フォントと同じ)。

色と効果

注釈の背景色。次の表にリストされている値のいずれかとして指定します。

値説明
'automatic'透明
'black'黒
'white'白
'red'赤
'green'緑
'blue'青
'cyan'シアン
'magenta'マゼンタ
'yellow'黄
'gray'グレー
'lightBlue'薄い青
'orange'オレンジ
'darkGreen'濃い緑
RGB 値の配列。'[r,g,b]' として指定します。ここで、r、g および b は、0.0 から 1.0 の範囲に正規化された色の赤、緑および青の値です。完全に不透明なカスタム色

データ型: char | string

注釈の前景色。次の表にリストされている値のいずれかとして指定します。

値説明
'black'黒
'white'白
'red'赤
'green'緑
'blue'青
'cyan'シアン
'magenta'マゼンタ
'yellow'黄
'gray'グレー
'lightBlue'薄い青
'orange'オレンジ
'darkGreen'濃い緑
RGB 値の配列。'[r,g,b]' として指定します。ここで、r、g および b は、0.0 から 1.0 の範囲に正規化された色の赤、緑および青の値です。完全に不透明なカスタム色

データ型: char | string

影を表示するオプション。'on' または 'off'、あるいは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — 影を表示する。

  • 'off' — 影を表示しない。

サイズと位置

注釈の高さを制御するオプション。'on' または 'off'、あるいは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — テキストの変更に合わせるために注釈のサイズが変更されない。表示されているテキストは切り捨てられる可能性があります。

  • 'off' — テキストの変更に合わせるために注釈のサイズが自動的に変更される。

注釈のサイズを対話的に変更する場合はこのパラメーターを 'on' に設定します。

注釈の垂直アンカー ポイント。次の表にリストされている値のいずれかとして指定します。

値説明
'top'

注釈が拡大または縮小されるとき、注釈の上部が固定されたままです。

'middle'

注釈が拡大または縮小されるとき、注釈の中央が固定されたままです。

'bottom'

注釈が拡大または縮小されるとき、注釈の下部が固定されたままです。

'cap'

推奨されません。

'baseline'

推奨されません。

依存関係

VerticalAlignment を有効にするには、FixedHeight を 'off' に設定します。

注釈の幅を制御するオプション。'on' または 'off'、あるいは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — テキストの変更に合わせるために注釈のサイズが変更されない。注釈の範囲内にテキストを収めることができない場合、次の行の上にラップします。

  • 'off' — テキストの変更に合わせるために注釈のサイズが自動的に変更される。

注釈のサイズを対話的に変更する場合はこのパラメーターを 'on' に設定します。

注釈内のテキストの水平方向の配置。表にリストされている値のいずれかとして指定します。

値結果
'left' 注釈内のテキストが左揃えになる。
'center'注釈内のテキストが中央に配置される。
'right'注釈内のテキストが右揃えになる。

テキストの境界ボックスと注釈の境界の間のスペース。1 行 4 列の配列として指定します。配列は、テキストと注釈の両側との間のスペースを指定します。この配列の要素は、左側、上側、右側、下側のスペースを順番に指定します ([left top right bottom])。

サポートされる座標の範囲は -1073740824 以上 1073740823 以下です。

データ型: double

注釈の位置。1 行 4 列の配列として指定します。配列は注釈の辺の位置をピクセル単位で指定します。この配列の要素は、左側、上側、右側、下側の位置を順番に指定します ([left top right bottom])。

いずれかのキャンバスがサイズ変更される前は、原点は Simulink® エディターのキャンバスの左上隅にあります。原点より右および下が正の値です。原点より左および上が負の値です。サポートされる座標の範囲は -1073740824 以上 1073740823 以下です。

依存関係

  • 左側を同じだけ移動させることなく、右側の位置をプログラムによって移動させるには、FixedWidth を 'on' に設定しなければなりません。

  • 上側を同じだけ移動させることなく、下側の位置をプログラムによって移動させるには、FixedHeight を 'on' に設定しなければなりません。

データ型: double

MetaData

注釈の説明。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

注釈のテキスト タグ。文字ベクトルまたは string スカラーとして指定します。

データ型: char | string

注釈に関連付けるデータ。

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

コールバック関数

注釈をクリックしたときに実行される MATLAB コード。文字ベクトルまたは string スカラーとして指定します。

詳細については、注釈の対話型への変更を参照してください。

依存関係

UseDisplayTextAsClickCallback が 'on' に設定されている場合、ClickFcn の値は Name および Text の値と一致します。

データ型: char | string

テキストをクリック関数として使用するオプション。'on' または 'off'、あるいは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は OnOffSwitchState 型の on/off logical 値として格納されます。

  • 'on' — 注釈をクリックすると Text で指定された注釈テキストが実行され、有効な MATLAB 式として解釈される。

  • 'off' — 注釈をクリックすると ClickFcn で指定された関数が実行される (利用可能な場合)。クリック関数が指定されていない場合、注釈をクリックしても関数は実行されません。

詳細については、注釈の対話型への変更を参照してください。

注釈を含むモデルを読み込むときに実行される MATLAB コード。文字ベクトルまたは string スカラーとして指定します。詳細については、注釈の対話型への変更を参照してください。

データ型: char | string

注釈をプログラムによって削除する前に実行される MATLAB コード。文字ベクトルまたは string スカラーとして指定します。

詳細については、注釈の対話型への変更を参照してください。

データ型: char | string

情報 (読み取り専用)

この プロパティ は読み取り専用です。

注釈のタイプ。'annotation' として返されます。

この プロパティ は読み取り専用です。

注釈のタイプ。テキストベースのメモの場合は 'note_annotation'、領域の場合は 'area_annotation'、イメージの場合は 'image_annotation' として指定します。

領域をプログラムによって作成するには、プログラムによる領域の作成を参照してください。

イメージのみの注釈をプログラムによって作成するには、setImageを参照してください。

この プロパティ は読み取り専用です。

注釈がイメージのみの注釈であるかどうかのチェック。'on' または 'off' として返されます。

この プロパティ は読み取り専用です。

書式設定のない、注釈内のテキスト。ベクトルとして返されます。

この プロパティ は読み取り専用です。

注釈ハンドル。double として返されます。

この プロパティ は読み取り専用です。

注釈を含むシステム。文字ベクトルとして返されます。

この プロパティ は読み取り専用です。

注釈へのパス。文字ベクトルとして返されます。

オブジェクト関数

view注釈の検索
setImage注釈として表示するようにイメージを指定
delete注釈の削除

例

すべて折りたたむ

ライブ スクリプトを開く

プログラムによって注釈を作成、変更、表示します。

新しいモデルを開きます。

open_system(new_system)

関数Simulink.Annotationを使用して、既定のプロパティで注釈を作成します。

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

注釈の作成後、ドット表記を使用してプロパティの値を設定します。たとえば、18 ポイントのフォントと薄い青色の背景を注釈に適用します。

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

新しい注釈を表示して、一時的に強調表示するには、関数 view を使用します。

view(a)
ライブ スクリプトを開く

カスタム プロパティを使用して、注釈をプログラムによって作成します。

モデルを開きます。

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

関数Simulink.Annotationを使用して、プロパティと値で構成されるコンマ区切りのペアとして指定されたカスタム プロパティを使って注釈を作成します。たとえば、18 ポイントのフォントと薄い青色の背景を注釈に適用します。 

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

ヒント

  • 既存の注釈をプログラムによって変更するには、関数 find_system を使用して注釈ハンドルを取得してから、関数 get_param を使用してオブジェクトを取得します。以下に例を示します。

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

  • 現在実行中のコールバック関数が注釈によって実行された場合、getCallbackAnnotation を使用して関数を呼び出した注釈を特定します。関数によって対応する Annotation オブジェクトが返されます。この関数は、複数のコールバックを含んだ別個の MATLAB ファイルにコールバック関数を書き込む場合にも役立ちます。

代替機能

関数 add_block を使用して注釈を作成することもできます。次に例を示します。

  • add_block('built-in/Note','model/This is a note.','BackgroundColor','yellow') は、黄色の背景をもつノート注釈を作成する。

  • add_block('built-in/Area','model/This is an Area.','Position',[120,100,230,200]) は、指定された位置に領域の注釈を作成する。

注釈を対話的に作成し、そのプロパティを編集するには、メモと注釈を使用したモデルの説明を参照してください。

バージョン履歴

R2006a より前に導入

参考

| |

トピック