ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Simulink.Annotation

モデルの注釈プロパティの指定

説明

このクラスのインスタンスは、注釈のプロパティを指定します。注釈コールバック関数の getCallbackAnnotation を使って、コールバック関数に関連する注釈の Simulink.Annotation インスタンスを取得します。find_systemget_param を使用すると、モデル内の任意の注釈に関連する Simulink.Annotation インスタンスを取得できます。たとえば、次のコードは現在選択されているモデル内の最初の注釈の注釈オブジェクトを取得し、そのドロップ シャドウを on にします。

ah = find_system(gcs, 'FindAll', 'on', 'type', 'annotation');
ao = get_param(ah(1), 'Object');
ao.DropShadow = 'on';

なし

プロパティのまとめ

プロパティ説明
Text

注釈のテキストを指定する文字列で、Name と同じです。

文字列

ClickFcn

注釈をシングルクリックすると実行される MATLAB® コードを指定します。Simulink® はモデルと一緒にこのフィールドに入力されたコードを保存します。詳細は、「クリック関数と注釈の関連付け」を参照してください。

文字列

Description

注釈を記述する文字列です。

文字列

FontAngle

注釈のフォントの書体を指定する文字列です。既定値 'auto' は、モデル設定のフォントの書体の使用を指定します。

'normal' | 'italic' | 'oblique' | {'auto'}

FontName

注釈のフォント名を指定する文字列です。既定値 'auto' は、モデル設定のフォントの使用を指定します。

文字列

FontSize

注釈のフォント サイズをポイント数で指定する整数です。既定値 -1 は、モデル設定のフォント サイズの使用を指定します。

real {'-1'}

FontWeight

注釈のフォントの太さを指定する文字列です。既定値 'auto' は、モデル設定のフォントの太さの使用を指定します。

'light' | 'normal' | 'demi' | 'bold' | {'auto'}

Handle

注釈のハンドルです。

実数

HiliteAncestors

内部で使用。

 
Name

注釈のテキストを指定する文字列で、Text と同じです。

文字列

Selected

注釈が選択されているか ('on')、選択されていない ('off') かを指定する文字列です。

'on' | 'off'

Parent

注釈オブジェクトの親の名前を指定する文字列です。

文字列

Path

注釈のパスです。

文字列

Position

注釈の場所を指定する配列です。

1 行 4 列の配列 [left top right bottom]

座標の最大値は、32767 です。

HorizontalAlignment

注釈の水平方向の位置を指定する文字列 (たとえば、'center') です。

'center' | {'left'}|'right'

VerticalAlignment

注釈の垂直方向の位置を指定する文字列 (たとえば、'middle') です。

'middle' | {'top'}|'cap'|'baseline'|'bottom'

ForegroundColor

注釈の前景色を指定する文字列です。

RGB 値の文字列配列 [r,g,b,a] です。各文字はコンマで区切られ、r, g, b, は、赤、緑、青、a は、0.0 から 1.0 までの正規化された色成分のアルファ値です。アルファ値はオプションで、省略可能です。

注釈の背景色は 'black''white''red''green''blue''cyan''magenta''yellow' 'gray' 'lightBlue' 'orange''darkGreen' にもできます。

BackgroundColor

注釈の背景色を指定する文字列です。

RGB 値の文字列配列 [r,g,b,a] です。各文字はコンマで区切られ、r, g, b, は、赤、緑、青、a は、0.0 から 1.0 までの正規化された色成分のアルファ値です。アルファ値はオプションで、省略可能です。

注釈の背景色は 'black''white''red''green''blue''cyan''magenta''yellow' 'gray' 'lightBlue' 'orange''darkGreen' にもできます。

DropShadow

ドロップ シャドウを表示するかどうかを指定する文字列です。オプションは 'on' または 'off' です。

'on' | {'off'}

TeXMode

TeX の表示を行うかどうかを指定する文字列です。オプションは 'on' または 'off' です。

'on' | {'off'}

Type

注釈のタイプです。常に 'annotation' になります。

文字列

LoadFcn

注釈を含むモデルを読み込むときに実行される MATLAB コードを指定する文字列です。「注釈コールバック関数」を参照してください。

文字列

DeleteFcnこの注釈の削除前に実行される MATLAB コードを指定する文字列です。「注釈コールバック関数」を参照してください。

文字列

RequirementInfo

内部で使用。

文字列

Tag

注釈の Tag パラメーターに割り当てられるユーザー指定のテキストで、注釈と共に保存されます。

文字列

UseDisplayTextAsClickCallback

注釈のクリック関数として Text プロパティの内容を使用するかどうかを指定する文字列です。オプションは 'on' または 'off' です。

'on' に設定した場合、注釈のテキストは有効な MATLAB 表現として解釈され、実行されます。'off' に設定した場合、注釈をクリックしたときにクリック関数があれば、その関数を実行します。クリック関数がなければ、注釈をクリックしても何も処理されません。

詳細は、「クリック関数と注釈の関連付け」を参照してください。

'on' | {'off'}

UserData

注釈に関連付ける任意のデータです。

ベクトル

Interpreter

注釈のタイプ

'rich' | 'tex' | {'off'}

IsImage

注釈がイメージ注釈の場合にのみ 'on'

'on' | {'off'}

InternalMargins

テキストの境界ボックスから注釈の境界までのスペースを指定する配列です。

1 行 4 列の配列 [left top right bottom] です。既定の設定は [1 1 1 1] です。

座標の最大値は、32767 です。

PlainText

書式設定のない、注釈内のテキストの読み取り専用の表示

ベクトル

FixedHeight

コンテンツを追加したときに注釈の下部境界のサイズが変更されるかどうかを指定する文字列

'on' | {'off'}'off' は、コンテンツを追加したときに下部境界のサイズが変更されることを意味します。

FixedWidth

ワードラップを使用するかどうか、つまりテキストに対応して注釈の幅を拡大するかどうかを指定する文字列

'on' | {'off'}'off' は、ワードラップの使用を意味します。

メソッドのまとめ

メソッド

説明

delete

Simulink モデルからこの注釈を削除します。

dialog

[注釈プロパティ] ダイアログ ボックスが表示されます。

disp

この注釈オブジェクトのプロパティ名と設定を表示します。

fitToView

この注釈を拡大し、モデル内で強調表示します。

get

この注釈に指定されたプロパティ設定を返します。

help

この注釈オブジェクトのプロパティのリストを短い説明と共に表示します。

insertImage

クリップボードまたはイメージ ファイルから注釈にイメージを挿入します。

methods

この注釈オブジェクトのグローバルでないすべてのメソッドを表示します。

set

この注釈オブジェクトの指定のプロパティを指定の値で設定します。

struct

この注釈オブジェクトのプロパティ設定を含む MATLAB 構造体を返して表示します。

view

Simulink エディターでこの注釈を強調して表示します。

この情報は役に立ちましたか?