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` — 要添加到查看器的类
字符向量 | 字符串标量 | 字符串向量 | 类实例

要添加到类浏览器和查看器的类，指定为字符向量、字符串标量或字符串向量。您也可以使用类实例。

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

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

`Folders` — 要添加到查看器的类文件夹
字符向量 | 字符串标量 | 字符串向量

要添加到类浏览器和查看器的类文件夹，指定为字符向量、字符串标量或字符串向量。

`IncludeSubfolders` — 包含子文件夹中的类
`true` 或 `1` (默认) | `false` 或 `0`

确定是否包含子文件夹中的类，指定为数值或逻辑值 1 (true) 或 0 (false)。值 1 表示包含 Folders 参量的子文件夹中的类，0 表示省略它们。

`Namespaces` — 要添加到查看器的命名空间
字符向量 | 字符串标量 | 字符串向量

要添加到类浏览器和画布的命名空间，指定为字符向量、字符串标量或字符串向量。

`IncludeInnerNamespaces` — 包含来自内部命名空间的类
`true` 或 `1` (默认) | `false` 或 `0`

确定是否包含内部命名空间中的类，指定为数值或逻辑值 1 (true) 或 0 (false)。值 1 表示包含 Namespaces 参量的内部命名空间中的类，0 表示省略它们。

`Load` — 要加载的类图的路径
字符向量 | 字符串 | 字符串数组

要加载的类图的路径，指定为字符向量、字符串或字符串向量。

`Packages` — 要添加到查看器的包
字符向量 | 字符串标量 | 字符串向量

自 R2024b 起

要添加到类浏览器和画布的包，指定为字符向量、字符串标量或字符串向量。

`Visible` — 显示类图查看器实例
`true` 或 `1` (默认) | `false` 或 `0`

确定类图查看器窗口在创建后是否可见，指定为数值或逻辑值 0 (false) 或 1 (true)。值 1 表示使窗口可见，0 表示隐藏该窗口。

属性

全部展开

`ActiveFile` — 最后加载或保存的文件
字符串

加载或保存到类图查看器实例的最后一个文件，以字符串形式返回。此属性只能由 load 和 save 方法设置。

属性：

Dependent true

`ClassesInDiagram` — 图中当前类的列表
字符串向量

图中当前显示的类的列表，以字符串向量形式返回。该列表包含在画布中显示的类，但不包含仅在类浏览器中列出的类。

属性：

Dependent true

`ShowAssociations` — 显示关联
`false` 或 `0` (默认) | `true` 或 `1`

自 R2024a 起

确定类图查看器是否显示关联，指定为数值或逻辑值 0 (false) 或 1 (true)。值 0 表示不包括关联。在 true 和 false 之间切换会立即更新图。有关关联的详细信息，请参阅向图中添加关联。

`ShowMixins` — 显示 mixin 类
`false` 或 `0` (默认) | `true` 或 `1`

确定类图查看器是否显示 mixin 类，指定为数值或逻辑值 0 (false) 或 1 (true)。值 0 表示不包含 mixin 和句柄类，以获得更简单的图。值 1 表示允许在添加超类时添加 mixin，但添加不是自动的。

`ShowNamespace` — 显示命名空间名称
`true` 或 `1` (默认) | `false` 或 `0`

确定类图查看器是否在类卡上显示命名空间名称，指定为数值或逻辑值 1 (true) 或 0 (false)。值 1 显示命名空间名称，而 0 隐藏它们。

`Visible` — 显示类图查看器实例
`true` 或 `1` (默认) | `false` 或 `0`

确定当前是否显示类图查看器窗口，指定为数值或逻辑值 0 (false) 或 1 (true)。值 1 表示使窗口可见，0 表示隐藏该窗口。

属性：

Transient true

方法

全部展开

公共方法

`addClass`	`addClass(viewer,classNames)` 将类添加到类浏览器和画布中。输入参量 `viewer`，指定为类图查看器实例。 `classNames`，指定为字符向量、字符串或字符串向量。您还可以指定类实例、类实例的元胞数组、异构数组或元类实例数组。
`removeClass`	`removeClass(viewer,classNames)` 从画布中删除类。类不会从类浏览器中删除。输入参量 `viewer`，指定为类图查看器实例。 `classNames`，指定为字符向量、字符串或字符串向量。您还可以指定类实例、类实例的元胞数组、异构数组或元类实例数组。
`removeAllClasses`	`removeAllClasses(viewer)` 从画布中删除所有类。类不会从类浏览器中删除。输入参量 `viewer`，指定为类图查看器实例。
`importClassesFrom`	`importClassesFrom(viewer,Name=Value)` 将类添加到类浏览器和画布中。输入参量 `viewer`，指定为类图查看器实例。名称-值参量 `Classes`，指定为字符向量、字符串标量或字符串向量。您还可以指定类实例、类实例的元胞数组或元类实例的数组。 `Folders`，指定为字符串标量或字符串向量。 `IncludeSubfolders`，默认值为逻辑值 `1`。将此属性设置为逻辑值 `0` 会排除子文件夹中的类。 `Namespaces`，其名称指定为字符串标量或字符串向量。 `Packages`，其名称指定为字符串标量或字符串向量。 (自 R2024b 起) `IncludeInnerNamespaces`，默认值为逻辑值 `1`。将此参量指定为逻辑值 `0` 会排除内部命名空间中的类。
`expandClass`	`expandClass(viewer,className,status)` 展开或全部折叠画布上类卡的所有部分。输入参量 `viewer`，指定为类图查看器实例。 `className`，指定为字符向量、字符串标量或字符串向量。您还可以指定类实例、异构数组或元类实例数组。 `status`，指定为数值或逻辑值 `1` 以展开所有部分，或指定为 `0` 以折叠所有部分。此参量是可选参量，默认值为 `1`。
`expandAll`	`expandAll(viewer,status)` 展开或折叠画布上类卡的所有部分。输入参量 `viewer`，指定为类图查看器实例。 `status`，指定为数值或逻辑值 `1` 以展开所有部分，或指定为 `0` 以折叠所有部分。此参量是可选参量，默认值为 `1`。
`expandSection`	`expandSection(viewer,className,sectionName,status)` 展开或折叠画布上类卡的指定部分。输入参量 `viewer`，指定为类图查看器实例。 `className`，指定为字符向量、字符串标量或元类实例。 `sectionName`，指定为 `"Properties"`、`"Methods"` 或 `"Events"`。 `status`，指定为数值或逻辑值 `1` 以展开该部分，或指定为 `0` 以折叠该部分。展开当前折叠的类卡中的某个部分会展开该卡的所有部分。
`importCurrentProject`	`importCurrentProject(viewer)` 从当前工程导入类。 `viewer`，指定为类图查看器实例。
`export`	`export(viewer,filePath,Name=Value)` 将类图导出为图像。输入参量 `viewer`，指定为类图查看器实例。 `filePath`，指定为字符向量或字符串标量。包括完整路径和文件名，（可选）以及所需文件类型的扩展名。或者，使用可选的 `Format` 名称-值参量指定它。名称-值参量 `Format`，指定为 `"PDF"` 或 `"PNG"`。如果文件扩展名不包含在 `filePath` 中，则需要此参量。 `Size`，指定为由整数组成的二元素向量。整数是导出文件的像素维度。此参量为可选参量。
`load`	`load(viewer,filePath)` 加载一个另存为 MLDATX 文件的图。加载的图将替换类图查看器实例中的全部当前内容。输入参量 `viewer`，指定为类图查看器实例。 `filePath`，指定为字符向量或字符串标量。包括完整路径和文件名。
`save`	`save(viewer,filePath)` 将图另存为 MLDATX 文件。输入参量 `viewer`，指定为类图查看器实例。 `filePath`，指定为字符向量或字符串标量。包括完整路径和文件名。
`getVisibleViewers`	`matlab.diagram.classviewer.getVisibleViewers` 静态方法返回一个数组，其中包含其 `Visible` 属性设置为 `true` 的所有当前 `ClassViewer` 实例。

示例

全部折叠

创建和保存类图

构造一个预加载了一个类的类图查看器实例。该类同时出现在类浏览器和画布中。

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

Class Diagram Viewer showing RequestMessage

使用 addClass 方法向图中添加两个类。由于 matlab.net.http.Message 是其他两个类的超类，类图查看器会自动连接它们。

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

Class Diagram Viewer showing three classes

展开 ResponseMessage 的类卡。

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

Class Diagram Viewer showing three classes, ResponseMessage expanded

折叠 ResponseMessage 的类卡上的属性部分。

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

Class Diagram Viewer showing three classes, ResponseMessage properties collapsed

将图另存为 MLDATX 文件。

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

版本历史记录

在 R2021a 中推出

全部展开

R2024b: 导入 MATLAB 包

类图查看器现在可以从 MATLAB^® 包中导入类。将 importClassesFrom 方法与 Packages 名称-值参量结合使用。有关包的详细信息，请参阅Organize and Distribute Code Using MATLAB Package Manager。

R2024a: 用于显示关联的新属性

类图查看器现在可以识别和显示类之间的关联。使用 ShowAssociations 属性可在图中打开和关闭关联。

R2024a: 包现在称为命名空间

MATLAB 现在将包称为命名空间。几个类成员已重命名以反映此变更。其行为保持不变。

R2023b 及更早版本中的成员名称	自 R2024a 起的新名称
构造函数：`Packages` 名称-值参量	`Namespaces`
构造函数：`IncludeSubpackages` 名称-值参量	`IncludeInnerNamespaces`
属性：`ShowPackageNames`	`ShowNamespace`
方法：`importClassesFrom`、`Packages` 名称-值参量	`Namespaces`
方法：`importClassesFrom`、`IncludeSubpackages` 名称-值参量	`IncludeInnerNamespaces`

另请参阅

类图查看器

matlab.diagram.ClassViewer 类

描述

类属性

创建对象

描述

名称-值参数

Classes — 要添加到查看器的类 字符向量 | 字符串标量 | 字符串向量 | 类实例

Folders — 要添加到查看器的类文件夹 字符向量 | 字符串标量 | 字符串向量

IncludeSubfolders — 包含子文件夹中的类 true 或 1 (默认) | false 或 0

Namespaces — 要添加到查看器的命名空间 字符向量 | 字符串标量 | 字符串向量

IncludeInnerNamespaces — 包含来自内部命名空间的类 true 或 1 (默认) | false 或 0

Load — 要加载的类图的路径 字符向量 | 字符串 | 字符串数组

Packages — 要添加到查看器的包 字符向量 | 字符串标量 | 字符串向量

Visible — 显示类图查看器实例 true 或 1 (默认) | false 或 0

属性

ActiveFile — 最后加载或保存的文件 字符串

属性：

ClassesInDiagram — 图中当前类的列表 字符串向量

属性：

ShowAssociations — 显示关联 false 或 0 (默认) | true 或 1

ShowMixins — 显示 mixin 类 false 或 0 (默认) | true 或 1

ShowNamespace — 显示命名空间名称 true 或 1 (默认) | false 或 0

Visible — 显示类图查看器实例 true 或 1 (默认) | false 或 0

属性：

方法

公共方法

示例

创建和保存类图

版本历史记录

R2024b: 导入 MATLAB 包

R2024a: 用于显示关联的新属性

R2024a: 包现在称为命名空间

另请参阅

`Classes` — 要添加到查看器的类
字符向量 | 字符串标量 | 字符串向量 | 类实例

`Folders` — 要添加到查看器的类文件夹
字符向量 | 字符串标量 | 字符串向量

`IncludeSubfolders` — 包含子文件夹中的类
`true` 或 `1` (默认) | `false` 或 `0`

`Namespaces` — 要添加到查看器的命名空间
字符向量 | 字符串标量 | 字符串向量

`IncludeInnerNamespaces` — 包含来自内部命名空间的类
`true` 或 `1` (默认) | `false` 或 `0`

`Load` — 要加载的类图的路径
字符向量 | 字符串 | 字符串数组

`Packages` — 要添加到查看器的包
字符向量 | 字符串标量 | 字符串向量

`Visible` — 显示类图查看器实例
`true` 或 `1` (默认) | `false` 或 `0`

`ActiveFile` — 最后加载或保存的文件
字符串

`ClassesInDiagram` — 图中当前类的列表
字符串向量

`ShowAssociations` — 显示关联
`false` 或 `0` (默认) | `true` 或 `1`

`ShowMixins` — 显示 mixin 类
`false` 或 `0` (默认) | `true` 或 `1`

`ShowNamespace` — 显示命名空间名称
`true` 或 `1` (默认) | `false` 或 `0`

`Visible` — 显示类图查看器实例
`true` 或 `1` (默认) | `false` 或 `0`