Stateflow.Annotation

チャート、ステート、ボックス、または関数内の注釈

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

    説明

    Stateflow.Annotation オブジェクトは、チャートに説明のコメントを含めるために使用します。注釈には、次のものを任意に組み合わせて含めることができます。

    • テキスト

    • イメージ

    • TeX コマンドを使用した方程式

    • Web サイトを開くか MATLAB® 関数を実行するハイパーリンク

    詳細については、チャート内への説明コメントの追加を参照してください。

    作成

    構文

    annotation = Stateflow.Annotation(parent)

    説明

    annotation = Stateflow.Annotation(parent) は、親であるチャート、ステート、ボックス、またはグラフィカル関数内に Stateflow.Annotation オブジェクトを作成します。

    例

    入力引数

    すべて展開する

    新しい注釈の親。次のいずれかのタイプの Stateflow® API オブジェクトとして指定します。

    プロパティ

    すべて展開する

    Stateflow API オブジェクトには、Stateflow エディターで設定した値に対応するプロパティがあります。プロパティにアクセスするかプロパティを変更するには、ドット表記を使用します。複数の API オブジェクトの複数のプロパティにアクセスするか、それらを変更するには、関数 get および関数 set をそれぞれ使用します。詳細については、Stateflow オブジェクトのプロパティの変更と関数の呼び出しを参照してください。

    内容

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

    注釈テキストの配置。"LEFT"、"CENTER"、または "RIGHT" として指定します。

    注釈テキストの形式。"OFF"、"RICH"、または "TEX" として指定します。

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

    書式なしの注釈テキスト。文字ベクトルとして指定します。

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

    注釈にイメージを含めるかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

    グラフィカルな外観

    注釈ボックスの位置とサイズ。[left top width height] 形式の 4 要素数値ベクトルとして指定します。

    テキストと注釈ボックスの境界の間のスペース。[left top right bottom] 形式の 4 要素数値ベクトルとして指定します。

    注釈ボックスの周りに影を表示するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

    注釈ボックスの高さを固定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

    • true — 注釈ボックスの高さを固定し、ボックスより長い内容は非表示にします。

    • false — 内容の追加に合わせて注釈ボックスを縦方向にサイズ変更します。

    注釈ボックスの幅を固定するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

    • true — 注釈ボックスの幅を固定し、ボックスより長いテキストは折り返します。

    • false — 内容の追加に合わせて注釈ボックスを横方向にサイズ変更します。

    注釈の背景色。赤、緑、青の値を指定する [red green blue] 形式の 3 要素数値ベクトルとして指定します。各要素は 0 ～ 1 の範囲とする必要があります。このプロパティは、AutoBackgroundColor プロパティが false である場合にのみ適用されます。

    注釈の前景色。赤、緑、青の値を指定する [red green blue] 形式の 3 要素数値ベクトルとして指定します。各要素は 0 ～ 1 の範囲とする必要があります。このプロパティは、AutoForegroundColor プロパティが false である場合にのみ適用されます。

    既定の背景色を使用するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

    • true — 注釈を含むチャートの ChartColor プロパティで指定された既定の色を使用します。

    • false — 注釈の BackgroundColor プロパティで指定された色を使用します。

    既定の前景色を使用するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。

    • true — 注釈を含むチャートの StateLabelColor プロパティで指定された既定の色を使用します。

    • false — 注釈の ForegroundColor プロパティで指定された色を使用します。

    注釈テキストのフォント。次のプロパティをもつ Stateflow.NoteFont オブジェクトとして指定します。

    • Name — フォント名。文字ベクトルとして指定します。このプロパティは読み取り専用です。このプロパティの値は、注釈を含むチャートの StateFont.Name プロパティで設定されます。

    • Angle — フォントの角度。"NORMAL" または "ITALIC" として指定します。

    • Weight — フォントの太さ。"NORMAL" または "BOLD" として指定します。

    • Size — フォント サイズ。スカラーとして指定します。

    例: annotation.Font.Angle = "ITALIC";

    例: annotation.Font.Weight = "BOLD";

    例: annotation.Font.Size = 8;

    コールバック

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

    モデル読み込み時のコールバック。string スカラーまたは文字ベクトルとして指定します。このコールバックには、注釈を含むモデルを読み込むときに実行する MATLAB コードが含まれます。

    削除時のコールバック。string スカラーまたは文字ベクトルとして指定します。このコールバックには、注釈を削除する前に実行する MATLAB コードが含まれます。

    注釈テキストをコールバックとして使用するかどうか。数値あるいは logical の 1 (true) または 0 (false) として指定します。このプロパティが有効な場合、注釈をクリックしたときに Text プロパティの内容がコールバックとして使用されます。

    階層

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

    注釈を含むチャート。Stateflow.Chart オブジェクトとして指定します。

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

    注釈のサブビューアー。Stateflow.Chart、Stateflow.State、Stateflow.Box、Stateflow.Function のいずれかのオブジェクトとして指定します。サブビューアーは、注釈をグラフィカルに表示できるチャートまたはサブチャートです。

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

    注釈を含むマシン。Stateflow.Machine オブジェクトとして指定します。

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

    モデルの階層構造における注釈の親の場所。文字ベクトルとして指定します。

    識別

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

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

    注釈のユーザー定義のタグ。任意の型のデータとして指定します。

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

    一意の識別子。整数スカラーとして指定します。このプロパティを使用して、注釈をモデル内の他のオブジェクトと区別します。このプロパティの値は、新しい MATLAB セッションを開始するたびに再割り当てされ、オブジェクトが削除されるとリサイクルされる場合があります。

    オブジェクト関数

    getParentオブジェクトの親の特定
    dialogプロパティ ダイアログ ボックスを開く
    view編集環境でオブジェクトを表示
    fitToViewグラフィカル オブジェクトの拡大表示
    setImage注釈にイメージを挿入

    例

    すべて折りたたむ

    チャート ch に注釈を追加します。内容は "This is an annotation." に設定します。

    annotation = Stateflow.Annotation(ch);
annotation.Text = "This is an annotation";

    チャート ch に注釈を追加します。フォルダー myfolder/annotation_images にあるファイル myImageFile.png を、注釈のイメージとして使用します。

    annotation = Stateflow.Annotation(ch);
setImage(annotation, ...
    fullfile("myfolder","annotation_images","myImageFile.png"));

    バージョン履歴

    R2017b で導入

    参考

    | | |

    トピック