класс matlab.diagram.ClassViewer

Пакет: matlab.diign

Создание диаграмм классов в средстве просмотра диаграмм классов

Описание

matlab.diagram.ClassViewer обеспечивает доступ командной строки к средству просмотра схем классов. Свойства и методы этого класса можно использовать для заполнения диаграммы классов без использования графического инструмента.

matlab.diagram.ClassViewer класс является handle класс.

Атрибуты класса

Sealed true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

matlab.diagram.ClassViewer открывает экземпляр средства просмотра схем классов без загруженных классов.

matlab.diagram.ClassViewer(Name,Value) добавляет классы, указанные как на панели «Обозреватель классов», так и на холсте. Использовать Name,Value аргументы для определения добавляемого содержимого.

пример

viewer = matlab.diagram.ClassViewer(___) возвращает дескриптор для экземпляра средства просмотра классов. Можно использовать любой из предыдущих входных синтаксисов.

Входные аргументы

развернуть все

Аргументы «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

Пример: 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 опускает их.

`'Packages'` - Пакеты для добавления в средство просмотра
символьный вектор | строка | строковый массив

Пакеты для добавления в обозреватель классов и средство просмотра, указанные как символьный вектор, строка или вектор строк.

`'IncludeSubpackages'` - Включить классы из подпакетов
`true` или `1` (по умолчанию) | `false` или `0`

Определяет, следует ли включать классы из подпакетов, указанных как числовые или логические 1 (true) или 0 (false). Значение 1 включает классы в подпакеты Packages аргумент, и 0 опускает их.

`'Load'` - Путь схемы класса к нагрузке
символьный вектор | строка | строковый массив

Путь загружаемой диаграммы класса, определяемый как символьный вектор, строка или вектор строк.

`'Visible'` - Экземпляр средства просмотра классов отображения
`true` или `1` (по умолчанию) | `false` или `0`

Определяет, отображается ли окно «Просмотр классов» после создания, указанное как числовое или логическое 0 (false) или 1 (true). Значение 1 делает окно видимым, и 0 скрывает это.

Свойства

развернуть все

`ActiveFile` - Последний загруженный или сохраненный файл
последовательность

Последний файл, загруженный или сохраненный в экземпляре Class Viewer, указан как строка. Это свойство может быть установлено только load и save методы.

Атрибуты:

Dependent true

`ClassesInDiagram` - Перечень классов, находящихся в настоящее время на схеме
строковый массив

Список классов, отображаемых в настоящее время на диаграмме, указанный как строковый массив. Список включает классы, отображаемые на холсте, но не включает классы, перечисленные только в браузере классов.

Атрибуты:

Dependent true

`ShowMixins` - Отображение классов миксина
`false` или `0` (по умолчанию) | `true` или `1`

Определяет, отображает ли средство просмотра классов смешанные классы, указанные как числовые или логические 0 (false) или 1 (true). Значение 0 исключает миксины и класс дескриптора для более простой схемы. Значение 1 позволяет добавлять миксины при добавлении суперклассов, но не делает этого автоматически.

`ShowPackageNames` - Отображение имен пакетов
`true` или `1` (по умолчанию) | `false` или `0`

Определяет, отображает ли средство просмотра классов имена пакетов на карточках классов, указанные как числовые или логические 1 (true) или 0 (false). Значение 1 отображает имена пакетов и 0 скрывает их.

`Visible` - Экземпляр средства просмотра классов отображения
`true` или `1` (по умолчанию) | `false` или `0`

Определяет, отображается ли в данный момент окно Class Viewer, указанное как числовое или логическое 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` исключает классы во вложенных папках. `Packages`, с именами, указанными как строка, строковый массив или массив ячеек строк. `IncludeSubpackages`, со значением по умолчанию логическое `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`, указано как `'FIG'`, `'GIF'`, `'JPG'`, `'PDF'`, или `'PNG'`. Этот аргумент необходим, если расширение файла не включено в `filePath`. `Size`, задается как двухэлементный вектор целых чисел. Целые числа - это пиксельные размеры импорта. Этот аргумент необязателен.
`load`	`load(viewer,filePath)` Загрузите схему, сохраненную как файл MLDATX. Загруженная диаграмма заменяет любое содержимое, находящееся в данный момент в экземпляре Class Viewer. Входные аргументы `viewer`, указан как экземпляр средства просмотра классов. `filePath`, указанный как символьный вектор или строка.
`save`	`save(viewer,filePath)` Сохраните схему в виде файла MLDATX. Входные аргументы `viewer`, указан как экземпляр средства просмотра классов. `filePath`, указанный как символьный вектор или строка.

Примеры

свернуть все

Создать и сохранить схему классов

Создайте экземпляр Class Viewer с одним предварительно загруженным классом. Класс отображается как в браузере классов, так и на холсте.

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

Class Viewer showing RequestMessage

Используйте addClass для добавления двух дополнительных классов к диаграмме. Поскольку matlab.net.http.Message является суперклассом двух других классов, к которым автоматически подключается средство просмотра классов.

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

Class Viewer showing three classes

Разверните карту класса для ResponseMessage.

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

Class Viewer showing three classes, ResponseMessage expanded

Свернуть раздел Свойства на карте класса для ResponseMessage.

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

Class Viewer showing three classes, ResponseMessage proeprties collapsed

Сохраните схему в виде файла MLDATX.

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

Документация

класс matlab.diagram.ClassViewer

Описание

Атрибуты класса

Создание

Описание

Входные аргументы

`'Classes'` - Классы для добавления в средство просмотра
вектор символов | строка | строковый массив | экземпляр класса

`'Folders'` - Папки классов для добавления в средство просмотра
символьный вектор | строка | строковый массив

`'IncludeSubfolders'` - Включить классы из подпапок
`true` или `1` (по умолчанию) | `false` или `0`

`'Packages'` - Пакеты для добавления в средство просмотра
символьный вектор | строка | строковый массив

`'IncludeSubpackages'` - Включить классы из подпакетов
`true` или `1` (по умолчанию) | `false` или `0`

`'Load'` - Путь схемы класса к нагрузке
символьный вектор | строка | строковый массив

`'Visible'` - Экземпляр средства просмотра классов отображения
`true` или `1` (по умолчанию) | `false` или `0`

Свойства

`ActiveFile` - Последний загруженный или сохраненный файл
последовательность

Атрибуты:

`ClassesInDiagram` - Перечень классов, находящихся в настоящее время на схеме
строковый массив

Атрибуты:

`ShowMixins` - Отображение классов миксина
`false` или `0` (по умолчанию) | `true` или `1`

`ShowPackageNames` - Отображение имен пакетов
`true` или `1` (по умолчанию) | `false` или `0`

`Visible` - Экземпляр средства просмотра классов отображения
`true` или `1` (по умолчанию) | `false` или `0`

Атрибуты:

Методы

Общедоступные методы

Примеры

Создать и сохранить схему классов

См. также

Документация MATLAB

Поддержка

Документация

класс matlab.diagram.ClassViewer

Описание

Атрибуты класса

Создание

Описание

Входные аргументы

'Classes' - Классы для добавления в средство просмотра вектор символов | строка | строковый массив | экземпляр класса

'Folders' - Папки классов для добавления в средство просмотра символьный вектор | строка | строковый массив

'IncludeSubfolders' - Включить классы из подпапок true или 1 (по умолчанию) | false или 0

'Packages' - Пакеты для добавления в средство просмотра символьный вектор | строка | строковый массив

'IncludeSubpackages' - Включить классы из подпакетов true или 1 (по умолчанию) | false или 0

'Load' - Путь схемы класса к нагрузке символьный вектор | строка | строковый массив

'Visible' - Экземпляр средства просмотра классов отображения true или 1 (по умолчанию) | false или 0

Свойства

ActiveFile - Последний загруженный или сохраненный файл последовательность

Атрибуты:

ClassesInDiagram - Перечень классов, находящихся в настоящее время на схеме строковый массив

Атрибуты:

ShowMixins - Отображение классов миксина false или 0 (по умолчанию) | true или 1

ShowPackageNames - Отображение имен пакетов true или 1 (по умолчанию) | false или 0

Visible - Экземпляр средства просмотра классов отображения true или 1 (по умолчанию) | false или 0

Атрибуты:

Методы

Общедоступные методы

Примеры

Создать и сохранить схему классов

См. также

Документация MATLAB

Поддержка

`'Classes'` - Классы для добавления в средство просмотра
вектор символов | строка | строковый массив | экземпляр класса

`'Folders'` - Папки классов для добавления в средство просмотра
символьный вектор | строка | строковый массив

`'IncludeSubfolders'` - Включить классы из подпапок
`true` или `1` (по умолчанию) | `false` или `0`

`'Packages'` - Пакеты для добавления в средство просмотра
символьный вектор | строка | строковый массив

`'IncludeSubpackages'` - Включить классы из подпакетов
`true` или `1` (по умолчанию) | `false` или `0`

`'Load'` - Путь схемы класса к нагрузке
символьный вектор | строка | строковый массив

`'Visible'` - Экземпляр средства просмотра классов отображения
`true` или `1` (по умолчанию) | `false` или `0`

`ActiveFile` - Последний загруженный или сохраненный файл
последовательность

`ClassesInDiagram` - Перечень классов, находящихся в настоящее время на схеме
строковый массив

`ShowMixins` - Отображение классов миксина
`false` или `0` (по умолчанию) | `true` или `1`

`ShowPackageNames` - Отображение имен пакетов
`true` или `1` (по умолчанию) | `false` или `0`

`Visible` - Экземпляр средства просмотра классов отображения
`true` или `1` (по умолчанию) | `false` или `0`