matlab.diagram.ClassViewer クラス

名前空間: matlab.diagram

クラス ダイアグラム ビューアー アプリでのクラス ダイアグラムの作成

R2021a 以降

説明

matlab.diagram.ClassViewer クラスを使用すると、クラス ダイアグラム ビューアーアプリにコマンド ラインでアクセスできます。このクラスのプロパティとメソッドを使用すると、グラフィカル インターフェイスを使わずにクラス ダイアグラムに入力できます。

matlab.diagram.ClassViewer クラスは handle クラスです。

クラスの属性

Sealed

true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

matlab.diagram.ClassViewer は、クラスを読み込まずにクラス ダイアグラム ビューアー インスタンスを開きます。

matlab.diagram.ClassViewer(Name,Value) は指定されたクラスを [クラス ブラウザー] ペインとキャンバスの両方に追加します。名前と値の引数を使用して、追加する内容を決定します。

viewer = matlab.diagram.ClassViewer(___) は、クラス ダイアグラム ビューアー インスタンスのハンドルを返します。前の入力引数構文のいずれも使用できます。

入力引数

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。ここで Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。

例: matlab.diagram.ClassViewer(Classes="matlab.net.http.RequestMessage")

Classes — ビューアーに追加するクラス

文字ベクトル | string スカラー | string のベクトル | クラス インスタンス

[クラス ブラウザー] とビューアーに追加するクラス。文字ベクトル、string スカラー、または string のベクトルとして指定します。クラス インスタンスも使用できます。

例: matlab.diagram.ClassViewer(Classes="matlab.net.http.ResponseMessage")

例: respMsg = matlab.net.http.RequestMessage; matlab.diagram.ClassViewer(Classes=respMsg)

Folders — ビューアーに追加するクラス フォルダー

文字ベクトル | string スカラー | string のベクトル

[クラス ブラウザー] とビューアーに追加するクラス フォルダー。文字ベクトル、string スカラー、または string のベクトルとして指定します。

IncludeSubfolders — サブフォルダーのクラスを含める

true または 1 (既定値) | false または 0

サブフォルダーのクラスを含めるかどうかを決定します。数値または logical 1 (true) または 0 (false) として指定します。値が 1 の場合は、Folders 引数のサブフォルダー内のクラスが含まれ、0 の場合は除外されます。

Namespaces — ビューアーに追加する名前空間

文字ベクトル | string スカラー | string のベクトル

[クラス ブラウザー] とキャンバスに追加する名前空間。文字ベクトル、string スカラー、または string のベクトルとして指定します。

IncludeInnerNamespaces — 内側の名前空間のクラスを含める

true または 1 (既定値) | false または 0

内側の名前空間のクラスを含めるかどうかを決定します。数値または logical 1 (true) または 0 (false) として指定します。値が 1 の場合は Namespaces 引数の内側の名前空間内のクラスが含まれ、0 の場合は除外されます。

Load — 読み込むクラス ダイアグラムのパス

文字ベクトル | string | string 配列

読み込むクラス ダイアグラムのパス。文字ベクトル、string、または string のベクトルとして指定します。

Visible — クラス ダイアグラム ビューアー インスタンスを表示

true または 1 (既定値) | false または 0

クラス ダイアグラム ビューアー ウィンドウを作成後に表示するかどうかを決定します。数値または logical 0 (false) または 1 (true) として指定します。値が 1 の場合はウィンドウが表示され、0 の場合は非表示になります。

プロパティ

ActiveFile — 最後に読み込んだファイルまたは保存したファイル

string

クラス ダイアグラム ビューアー インスタンスに最後に読み込んだファイルまたは保存したファイル。string として返されます。このプロパティは、load メソッドと save メソッドでのみ設定できます。

属性:

Dependent

true

ClassesInDiagram — 現在ダイアグラムにあるクラスのリスト

string のベクトル

ダイアグラムに現在表示されているクラスのリスト。string のベクトルとして返されます。このリストには、キャンバスに表示されているクラスが含まれますが、[クラス ブラウザー] にのみリストされているクラスは含まれません。

属性:

Dependent

true

ShowAssociations — 関連付けを表示

false または 0 (既定値) | true または 1

R2024a 以降

クラス ダイアグラム ビューアーに関連付けを表示するかどうかを決定します。数値または logical 0 (false) または 1 (true) として指定します。値が 0 の場合は関連付けが除外されます。true と false の間で切り替えると、ダイアグラムが直ちに更新されます。関連付けの詳細については、ダイアグラムへの関連付けの追加を参照してください。

ShowMixins — mixin クラスの表示

false または 0 (既定値) | true または 1

クラス ダイアグラム ビューアーに mixin クラスを表示するかどうかを決定します。数値または logical 0 (false) または 1 (true) として指定します。値が 0 の場合は、mixin とハンドル クラスが除外され、ダイアグラムがシンプルになります。値が 1 の場合は、スーパークラスの追加時に mixin を追加できますが、自動的に追加されるわけではありません。

ShowNamespace — 名前空間名を表示

true または 1 (既定値) | false または 0

クラス ダイアグラム ビューアーのクラス カードに名前空間名を表示するかどうかを決定します。数値または logical 1 (true) または 0 (false) として指定します。値が 1 の場合は名前空間名が表示され、0 の場合は非表示になります。

Visible — クラス ダイアグラム ビューアー インスタンスを表示

true または 1 (既定値) | false または 0

クラス ダイアグラム ビューアー ウィンドウが現在表示されているかどうかを決定します。数値または logical 0 (false) または 1 (true) として指定します。値が 1 の場合はウィンドウが表示され、0 の場合は非表示になります。

属性:

Transient

true

メソッド

パブリック メソッド

addClass	addClass(viewer,classNames) [クラス ブラウザー] とキャンバスにクラスを追加します。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 classNames。文字ベクトル、string、または string のベクトルとして指定します。クラス インスタンス、クラス インスタンスの cell 配列、異種混合配列、またはメタクラス インスタンスの配列も指定できます。
removeClass	removeClass(viewer,classNames) クラスをキャンバスから削除します。クラスは [クラス ブラウザー] からは削除されません。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 classNames。文字ベクトル、string、または string のベクトルとして指定します。クラス インスタンス、クラス インスタンスの cell 配列、異種混合配列、またはメタクラス インスタンスの配列も指定できます。
removeAllClasses	removeAllClasses(viewer) すべてのクラスをキャンバスから削除します。クラスは [クラス ブラウザー] からは削除されません。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。
importClassesFrom	importClassesFrom(viewer,Name=Value) [クラス ブラウザー] とキャンバスにクラスを追加します。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 名前と値の引数 Classes。文字ベクトル、string スカラー、または string のベクトルとして指定します。クラス インスタンス、クラス インスタンスの cell 配列、またはメタクラス インスタンスの配列も指定できます。 Folders。string スカラーまたは string のベクトルとして指定します。 IncludeSubfolders。既定値は logical 1 です。このプロパティを logical 0 に設定すると、サブフォルダー内のクラスが除外されます。 Namespaces。名前を string スカラーまたは string のベクトルとして指定します。 IncludeInnerNamespaces。既定値は logical 1 です。この引数を logical 0 として指定すると、内側の名前空間内のクラスが除外されます。
expandClass	expandClass(viewer,className,status) キャンバスでクラス カードのすべてのセクションを展開するか折りたたみます。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 className。文字ベクトル、string スカラー、または string のベクトルとして指定します。クラス インスタンス、異種混合配列、またはメタクラス インスタンスの配列も指定できます。 status。すべてのセクションを展開するには数値または logical 1、すべてのセクションを折りたたむには 0 として指定します。この引数はオプションで、既定値は 1 です。
expandAll	expandAll(viewer,status) キャンバスでクラス カードのすべてのセクションを展開するか折りたたみます。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 status。すべてのセクションを展開するには数値または logical 1、すべてのセクションを折りたたむには 0 として指定します。この引数はオプションで、既定値は 1 です。
expandSection	expandSection(viewer,className,sectionName,status) キャンバスでクラス カードの指定したセクションを展開するか折りたたみます。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 className。文字ベクトル、string スカラー、またはメタクラス インスタンスとして指定します。 sectionName。"Properties"、"Methods" または "Events" として指定します。 status。セクションを展開するには数値または logical 1、セクションを折りたたむには 0 として指定します。 現在折りたたまれているクラス カードのセクションを 1 つ展開すると、そのカードのすべてのセクションが展開されます。
importCurrentProject	importCurrentProject(viewer) 現在のプロジェクトからクラスをインポートします。 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。
export	export(viewer,filePath,Name=Value) クラス ダイアグラムをイメージとしてエクスポートします。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 filePath。文字ベクトルまたは string スカラーとして指定します。絶対パスとファイル名を含めて、オプションで、必要なファイルのタイプの拡張子も含めます。あるいは、オプションの名前と値の引数 Format を使用して指定します。 名前と値の引数 Format。"PDF" または "PNG" として指定します。この引数は、filePath にファイル拡張子が含まれていない場合は必須です。 Size。整数の 2 要素ベクトルとして指定します。整数は、エクスポートされるファイルのピクセル次元です。この引数はオプションです。
load	load(viewer,filePath) MLDATX ファイルとして保存されたダイアグラムを読み込みます。読み込まれたダイアグラムが、現在クラス ダイアグラム ビューアー インスタンスにある内容の代わりに表示されます。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 filePath。文字ベクトルまたは string スカラーとして指定します。絶対パスとファイル名を含めます。
save	save(viewer,filePath) ダイアグラムを MLDATX ファイルとして保存します。 入力引数 viewer。クラス ダイアグラム ビューアー インスタンスとして指定します。 filePath。文字ベクトルまたは string スカラーとして指定します。絶対パスとファイル名を含めます。
getVisibleViewers	matlab.diagram.classviewer.getVisibleViewers 静的メソッド Visible プロパティが true に設定されているすべての現在の ClassViewer インスタンスの配列を返します。

例

クラス ダイアグラムの作成と保存

1 つのクラスがプリロードされたクラス ダイアグラム ビューアー インスタンスを作成します。このクラスは、[クラス ブラウザー] とキャンバスの両方に表示されます。

httpViewer = matlab.diagram.ClassViewer(Classes="matlab.net.http.RequestMessage")

addClass メソッドを使用して、2 つのクラスをダイアグラムに追加します。matlab.net.http.Message はその他 2 つのクラスのスーパークラスなので、クラス ダイアグラム ビューアーはこれらを自動的に接続します。

addClass(httpViewer,["matlab.net.http.Message",...
"matlab.net.http.ResponseMessage"])

ResponseMessage のクラス カードを展開します。

expandClass(httpViewer,"matlab.net.http.ResponseMessage",1)

ResponseMessage のクラス カードの [プロパティ] セクションを折りたたみます。

expandSection(httpViewer,"matlab.net.http.ResponseMessage","Properties",0)

ダイアグラムを MLDATX ファイルとして保存します。

save(httpViewer,"filepath/httpMessages.mldatx")

バージョン履歴

R2021a で導入

R2024a: 関連付けを表示するための新しいプロパティ

クラス ダイアグラム ビューアーで、クラス間の関連付けを識別して表示できるようになりました。ShowAssociations プロパティを使用して、ダイアグラムでの関連付けのオンとオフを切り替えます。

R2024a: パッケージから名前空間に名前を変更

MATLAB^® で、パッケージを名前空間と呼ぶようになりました。この変更を反映するために、いくつかのクラス メンバーの名前が変更されています。それらの動作は同じままです。

R2023b 以前のメンバー名	R2024a 以降の新しい名前
コンストラクター: 名前と値の引数 Packages	Namespaces
コンストラクター: 名前と値の引数 IncludeSubpackages	IncludeInnerNamespaces
プロパティ: ShowPackageNames	ShowNamespace
メソッド: importClassesFrom の名前と値の引数 Packages	Namespaces
メソッド: importClassesFrom の名前と値の引数 IncludeSubpackages	IncludeInnerNamespaces

参考

クラス ダイアグラム ビューアー