mlreportgen.report. Класс MATLABVariable
Пакет: mlreportgen.report
Суперклассы:
Генератор отчетов переменной MATLAB
Описание
Создайте генератор отчетов, который сообщает относительно переменной MATLAB®.
Конструкция
rptr = mlreportgen.report.MATLABVariable()
rptr = mlreportgen.report.MATLABVariable(variable) создает генератор отчетов переменной MATLAB для заданного MATLAB variable. Чтобы задать локальную переменную, задайте ее имя, например, MATLABVariable(x). Чтобы задать переменную рабочего пространства MATLAB, задайте ее имя как строку или символьный массив, например, MATLABVariable('x'). Чтобы задать другие опции отчета, используйте свойства этого генератора отчетов.
rptr = mlreportgen.report.MATLABVariable(Name,Value)Name,Value. Name является именем свойства, и Value является соответствующим значением. Name должен появиться в одном ('') или двойной ("") кавычки. Можно задать несколько аргументов пары "имя-значение" в любом порядке как Name1,Value1,...,NameN,ValueN.
Вместо того, чтобы задать переменную MATLAB с помощью ее Name, пары Value, можно задать его с помощью только ее значение, но это должен быть первый входной параметр. Например, для глобальной переменной MATLAB под названием x, можно использовать или mlreportgen.report.MATLABVariable(x,"Location","Global") или mlreportgen.report.MATLABVariable("Variable","x","Location","Global").
Входные параметры
развернуть все
variable — Имя переменной MATLAB
представьте в виде строки | символьный массив | имя локальной переменной
Имя переменной MATLAB, заданное как строка, символьный массив или имя локальной переменной. Чтобы задать локальную переменную, задайте ее имя, например, MATLABVariable(x). Чтобы задать переменную рабочего пространства MATLAB, задайте ее имя как строку или символьный массив, например, MATLABVariable('x'). Для получения дополнительной информации о входе смотрите свойство Variable.
Свойства
развернуть все
Variable — Имя переменной MATLAB
представьте в виде строки | символьный массив
Имя переменной MATLAB, заданное как строка или символьный массив. Заданная переменная может быть любым из этих типов данных:
Символ или символьный массив
Строка
Векторный массив ячейки или массив ячеек
Логический скаляр, логический вектор или логический массив
Числовой скаляр, числовой массив или числовой вектор
Таблица MATLAB
Вектор объекта MATLAB или объектный массив
Объект Simulink®
Stateflow®object
Графический объект
Структура MATLAB, вектор структуры или массив структур
Местоположение Местоположение переменной
"MATLAB" (значение по умолчанию) | "MAT-File" | "Global" | "Local" | "Model"
Местоположение переменной, заданной как одна из этих строк или как символьные массивы:
MATLAB Базовое рабочее пространство
matfile MAT-файл задан в свойстве FileName этого генератора отчетов
глобальная переменная Глобальное пространство имен
"Local" — Локальное пространство имен, обычно пространство имен функциональной или рабочей области, в которой был создан этот генератор отчетов
"Model" — Рабочая область модели Simulink Report Generator™ задана в свойстве FileName этого генератора отчетов
FileName Имя файла или модели, которая содержит переменную
представьте в виде строки | символьный массив
Имя модели MAT-файл или Simulink, которая содержит переменную, заданную как строка или как символьный массив. Это свойство применяется, только если значением свойства Location является MAT-File или Model. Если Location является MAT-File, имя файла является именем MAT-файла, из которого можно получить переменную. Если Location является Model, FileName является именем файла модели Simulink, который содержит переменную.
FormatPolicy — Формат для значений переменных
"Auto" (значение по умолчанию) | "Table" | "Paragraph" | "Inline Text"
Формат для значений переменных, заданных как одна из этих строк или символьных массивов:
'auto' Форматирует значения переменных как таблицу или абзац, в зависимости от типа данных значения.
Типы данных, отформатированные как таблица:
Типы данных, отформатированные как абзац:
Вектор ячейки
Логический скаляр или вектор
Числовой скаляр или вектор
Символ или символьный массив
Строка
Вектор структуры MATLAB
Вектор объекта MATLAB
Таблица Форматирует значения переменных в таблице. Переменные, которые по умолчанию появляются как абзацы, отформатированы вместо этого как записи таблицы. Переменные, которые иерархически структурированы объекты, такие как структура MATLAB, объект MATLAB, объект Simulink, объект Stateflow или графический объект, могут иметь свойства, которые являются самостоятельно объектами. В этом случае иерархия сглажена, и значение свойства отображено как гиперссылка на таблицу свойств того объекта. Таблица свойства объекта также имеет гиперссылку назад на исходную таблицу.
"Paragraph" — Отформатируйте значения переменных как абзац. Переменные, которые по умолчанию отформатированы как таблицы, сглажены и отформатированы как абзац.
"Inline Text" — Форматирует переменную, встроенную с сопроводительным текстом.
TableReporter — Табличный генератор отчетов для значений переменных
mlreportgen.report.BaseTable
Табличный генератор отчетов, используемый этим генератором отчетов MATLABVariable, чтобы отформатировать значения переменных, заданные как объект mlreportgen.report.BaseTable. Чтобы настроить внешний вид таблицы, измените свойства генератора отчетов BaseTable по умолчанию или замените его на индивидуально настраиваемый генератор отчетов BaseTable. Если вы добавляете содержимое в свойство Title значения по умолчанию или настроенного генератора отчетов, то содержимое появляется перед табличным заголовком в сгенерированном отчете.
ParagraphFormatter — Средство форматирования абзаца для переменной MATLAB
Объект mlreportgen.dom.Paragraph
Средство форматирования абзаца возражает, чтобы отформатировать значение переменной MATLAB, заданной как объект mlreportgen.dom.Paragraph. Чтобы настроить внешний вид абзаца, измените свойства объектов Paragraph DOM или замените объект на индивидуально настраиваемый объект Paragraph. Если вы добавляете содержимое в значение по умолчанию или заменяющий объект абзаца, то содержимое появляется перед переменным содержимым в сгенерированном отчете.
TextFormatter — Текстовое средство форматирования для переменной MATLAB
Объект mlreportgen.dom.Text
Текстовое средство форматирования возражает, чтобы отформатировать текстовые значения переменной MATLAB в таблицах или абзацах, заданных как объект mlreportgen.dom.Text. Чтобы настроить внешний вид текста, измените свойства объектов Text DOM или замените объект на индивидуально настраиваемый объект Text. Если вы добавляете содержимое в объект или текста замены по умолчанию, то содержимое появляется перед переменным содержимым в сгенерированном отчете.
MaxCols — Максимальное количество столбцов таблицы, чтобы отобразиться
32 (значения по умолчанию) | положительное целое число
Максимальное количество столбцов таблицы, чтобы отобразиться, заданный как положительное целое число. Поскольку переменные типа массив сообщили об использовании таблицы, если количество столбцов больше, чем это значение свойства, таблица нарезана вертикально. Разрезание делит таблицу на несколько таблиц размера MaxCols.
DepthLimit — Максимальное количество уровней структуры, чтобы сообщить
10 (значений по умолчанию) | целое число
Максимальное количество уровней структуры в MATLAB иерархическая структура, чтобы сообщить, заданный как целое число, больше, чем или равный 0. Если вы устанавливаете это свойство на 0, только о полях верхнего уровня структуры сообщают. Уровни структуры, меньше чем или равные DepthLimit, сглажены в последовательность связанных таблиц (см. свойство FormatPolicy). Об уровнях, больше, чем предел глубины, не сообщают.
ObjectLimit — Максимальное количество вложенных объектов, чтобы сообщить
200 (значений по умолчанию) | положительное целое число
Максимальное количество объектов в иерархии объектов, чтобы сообщить, заданный как положительное целое число.
IncludeTitle — Включать ли заголовок
1 (значение по умолчанию) | 0
Включать ли заголовок, заданный как логическое. Заголовок содержит имя переменной и опционально, тип данных. Если IncludeTitle является 1 (true), заголовок включен. По умолчанию заголовок включает только имя переменной. Чтобы включать тип данных переменной, установите свойство ShowDataType на 1 (true).
ShowDataType — Показать ли тип данных переменной в заголовке
0 (значение по умолчанию) | 1
Показать ли тип данных переменной в заголовке, заданном как логическое. Если ShowDataType является 0 (false), тип данных не показывают. Если 1 (true), тип данных показывают.
ShowEmptyValues — Ли к переменным отчета с пустыми значениями свойств
1 (значение по умолчанию) | 0
Ли к свойствам переменной отчета с пустыми значениями, заданными как логическое. ShowEmptyValues применяется только к объекту MATLAB, объекту Simulink и переменным объекта Stateflow. Если ShowEmptyValues является 1 (true), о свойствах с пустыми значениями сообщают. Если 0 (false), о пустых свойствах, передаваемых по значению, не сообщают.
ShowDefaultValues — Показать ли свойства со значениями по умолчанию
1 (значение по умолчанию) | 0
Показать ли свойства со значениями по умолчанию, заданными как логическое. ShowDefaultValues применяется только к объекту MATLAB, объекту Simulink и переменным объекта Stateflow. Если ShowDefaultValues является 1 (true), свойства, которые используют значения по умолчанию, показывают. Если 0 (false), те свойства не показывают.
TemplateSrc — Источник шаблона для этого генератора отчетов
представьте в виде строки | символьный массив | генератор отчетов или отчет | документ DOM или часть документа
Источник шаблона для этого генератора отчетов, заданного как одно из этих значений:
Строка или символьный массив, задающий путь файла, содержащего шаблон для этого генератора отчетов
Генератор отчетов или отчет, шаблон которого используется в качестве шаблона для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов
Документ DOM или часть документа, шаблон которой используется в качестве шаблона для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов
Заданный шаблон должен иметь тот же тип как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word, TemplateSrc должен быть шаблоном генератора отчетов Word. Если свойство TemplateSrc пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию для выходного типа отчета.
TemplateName — Имя шаблона для этого генератора отчетов
представьте в виде строки | символьный массив
Имя шаблона для этого генератора отчетов, заданного как строка или символьный массив. Шаблон для этого генератора отчетов находится в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.
LinkTarget — Цель гиперссылки для этого генератора отчетов
представьте в виде строки | символьный массив | объект mlreportgen.dom.LinkTarget
Цель гиперссылки для этого генератора отчетов, заданного как строка или символьный массив, который задает ID цели ссылки или объект mlreportgen.dom.LinkTarget. Значение строки или символьного массива преобразовано в объект LinkTarget. Объект цели ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.
Копировать семантику
Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).
Примеры
Переменные отчета Используя прямые имена или строки
Этот пример показывает, как сообщить относительно переменных MATLAB. Локальная переменная использует только свое имя, как введено к классу MATLABVariable, и переменная рабочей области использует строку. Первая часть использования в качестве примера настройки свойства по умолчанию и вторая часть изменяет отображение на таблицу.
Примечание
Прежде чем вы запустите этот пример, создадите эту переменную в основном рабочем пространстве MATLAB:
workspace_var = ['Workspace variable input ',...
'specified as a string'];
rpt = mlreportgen.report.Report("MyReport","pdf");
local_var = ['Local variable input specified ',...
'using its variable name'];
chapter = mlreportgen.report.Chapter();
chapter.Title = "MATLAB Variable Reporter Example";
% Format using default paragraphs
rptr_local1 = mlreportgen.report.MATLABVariable...
(local_var);
rptr_workspace1 = mlreportgen.report.MATLABVariable...
("workspace_var");
add(chapter,rptr_local1)
add(chapter,rptr_workspace1)
% Format as a table
rptr_local2 = mlreportgen.report.MATLABVariable...
(local_var);
rptr_workspace2 = mlreportgen.report.MATLABVariable...
("workspace_var");
rptr_local2.FormatPolicy = 'Table';
rptr_workspace2.FormatPolicy = 'Table';
add(chapter,rptr_local2)
add(chapter,rptr_workspace2)
add(rpt,chapter)
close(rpt)
rptview(rpt)Введенный в R2018b
