exponenta event banner

mlreportgen.report.Класс фигур

Пакет: mlreportgen.report
Суперклассы: mlreportgen.report.Reporter

Репортер рисунков

Описание

Создайте репортер фигур с заголовком, рисунком и подписью.

mlreportgen.report.Figure класс является handle класс.

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

HandleCompatible
true

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

Создание

Описание

пример

fig = mlreportgen.report.Figure() создает репортер, который создает снимок фигуры, открытой в настоящий момент в MATLAB ®, и добавляет его в отчет. Используйте свойства фигуры для добавления подписи или изменения размера фигуры. Изображение моментального снимка хранится во временной папке отчета. Когда отчет закрыт, изображение снимка копируется в отчет, и изображение удаляется из временной папки. Чтобы предотвратить удаление файлов изображений моментальных снимков, используйте Debug свойство отчета. Посмотрите mlreportgen.report.Report.

Примечание

Рисунок должен оставаться открытым до тех пор, пока репортер рисунков не будет добавлен в отчет.

fig = mlreportgen.report.Figure(source) создает репортер, который добавляет фигуру, указанную source и задает свойству Source значение source.

fig = mlreportgen.report.Figure(Name,Value) задает свойства, используя пары имя-значение. Можно указать несколько аргументов пары имя-значение в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

Свойства

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

Рисунок, указанный как объект mlreportgen.report.FormalImage класс репортера. Репортер использует gcf для получения текущего значения MATLAB. Он использует формальный репортер изображений для вставки фигуры в отчет. Чтобы указать размер снимка или подписи, используйте свойства FormalImage объект.

Примечание

Репортер рисунков инициализирует Snapshot собственность. Не сбрасывайте это свойство.

Источник рисунка, указанный как:

  • Вектор символов или строковый скаляр, указывающий путь к действительному файлу фигуры

  • Допустимый графический дескриптор

Формат снимка, заданный как вектор символа или скаляр строки. Поддерживаются следующие форматы:

  • 'bmp' - Растровое изображение.

  • 'gif' - Формат обмена графикой.

  • 'jpg' - изображение JPEG.

  • 'png' - Изображение PNG.

  • 'emf' - Улучшенный метафайл, поддерживается только в выходных данных DOCX на платформах Windows ®.

  • 'svg' - Масштабируемая векторная графика.

  • 'tif' - Формат файла изображения тега, не поддерживаемый в выходных данных HTML.

  • 'pdf' - изображение PDF (поддерживается только в выходных данных PDF).

См. раздел Вопросы совместимости.

Параметры масштабирования изображения снимка фигуры, заданные как вектор символа или скаляр строки. Scaling управляет размером изображения снимка фигуры в файле изображения. Поддерживаются следующие параметры масштабирования:

  • 'auto' - Для вывода в формате PDF или Word (DOCX) масштабируйте изображение снимка рисунка в соответствии с текущим макетом страницы, сохраняя соотношение сторон. Сначала изображение снимка рисунка масштабируется до ширины страницы. Если высота изображения превышает высоту страницы, изображение снова масштабируется. Это дополнительное масштабирование гарантирует соответствие изображения текущей странице с дополнительным интервалом в один дюйм. Масштабирование не применяется к выводимым данным HTML.

  • 'custom' - Масштабирует изображение снимка фигуры на основе значений Height и Width свойства.

    При установке Scaling кому custom и имеют большие значения для Height и Width свойства, a java.lang.OutOfMemoryError может происходить во время создания PDF. Чтобы избежать этой ошибки и убедиться, что рисунок помещается на странице, используйте меньше Height и Width значения.

  • 'none' - Калибровка не выполняется

Примечание

'auto' и 'custom' параметры используют MATLAB print для изменения размера фигуры. Если фигура слишком велика для разборчивого размещения в указанном пространстве, print команда выполняет кадрирование снимка. Чтобы избежать обрезки, можно указать 'none' как значение Scaling и использовать репортер, указанный Snapshot для определения размера изображения фигуры. Этот репортер уменьшает размер текста вместе с остальной частью изображения, и пользователю может потребоваться увеличить изображение в средстве просмотра, чтобы различить точные детали. См. раздел Изменение размера изображения снимка фигуры.

Высота снимка, заданная как вектор символов или строковый скаляр, состоящий из числа, за которым следует сокращение единицы измерения. Например, '2in' задает два дюйма. Допустимые сокращения:

  • px - пикселы (по умолчанию)

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

Пример: '2in'

Ширина снимка, заданная как вектор символов или строковый скаляр, состоящий из числа, за которым следует сокращение единицы измерения. Например, '2in' задает два дюйма. Допустимые сокращения:

  • px - пикселы (по умолчанию)

  • cm - сантиметров

  • in - дюймы

  • mm - миллиметров

  • pc - пикас

  • pt - точки

Пример: '3in'

Сохранить цвет фона фигуры в снимке, указанный как true или false. Если PreserveBackgroundColor является trueцвет фона снимка совпадает с цветом фона фигуры. Если PreserveBackgroundColor является false, цвет фона снимка - белый.

Источник шаблона для этого репортера, указанный одним из следующих способов:

  • Вектор символов или строковый скаляр, указывающий путь к файлу, содержащему шаблон для этого репортера

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • Документ DOM или деталь документа, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

Указанный шаблон должен быть того же типа, что и отчет, к которому добавлен этот репортер. Например, для отчета Microsoft ® Word :TemplateSrc должен быть шаблоном репортера Word. Если TemplateSrc пустое свойство, этот репортер использует шаблон репортера по умолчанию для типа вывода отчета.

Имя шаблона для этого репортера, указанного как вектор символов или скаляр строки. Шаблон для этого репортера должен находиться в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.

Цель гиперссылки для этого репортера, указанная как вектор символов или скаляр строки, указывающий идентификатор цели связи, или mlreportgen.dom.LinkTarget объект. Вектор символов или строковое скалярное значение преобразуется в LinkTarget объект. Цель ссылки непосредственно предшествует содержимому этого репортера в выходном отчете.

Методы

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

Примеры

свернуть все

Добавьте фигуру графика поверхности в отчет и задайте заголовок фигуры и высоту.

import mlreportgen.report.*
surf(peaks);
rpt = Report('peaks');
chapter = Chapter();
chapter.Title = 'Figure Example';
add(rpt,chapter);

fig = Figure();
fig.Snapshot.Caption = '3-D shaded surface plot';
fig.Snapshot.Height = '5in';

add(rpt,fig);
delete(gcf);
rptview(rpt);

Добавьте две фигуры в отчет. Чтобы разместить их рядом друг с другом на странице, используйте объект DOM Table.

import mlreportgen.report.*
import mlreportgen.dom.*
rpt = Report('peaks');

surf(peaks(20));
figure = Figure();
peaks20 = Image(getSnapshotImage(figure,rpt));
peaks20.Width = '3in';
peaks20.Height = [];
delete(gcf);

surf(peaks(40));
figure = Figure();
peaks40 = Image(getSnapshotImage(figure,rpt));
peaks40.Width = '3in';
peaks40.Height = [];
delete(gcf);

t = Table({peaks20,peaks40;'peaks(20)','peaks(40)'});
add(rpt,t);
close(rpt);
rptview(rpt);

В этом примере создается отчет PDF, иллюстрирующий разницу между размерами изображения снимка фигуры с помощью print и изменение размера с помощью репортера, указанного Snapshot имущества Figure репортер.

Создайте широкий рисунок MATLAB ®. Создать триmlreportgen.report.Figure репортеры из рисунка и добавить их в отчет.

  • Первое Figure reporter не изменяет размер фигуры.

  • Второе Figure репортер использует print для изменения размера фигуры.

  • The треть Figure репортер использует Snapshot для изменения размера фигуры.

import mlreportgen.report.*

fig = figure();
ax = axes(fig);
plot(ax, rand(1,100));

pos = fig.Position;
fig.Position = [pos(1) pos(2) 2*pos(3) pos(4)];

rpt = Report('example','pdf');

add(rpt, "Intrinsic figure size");
figReporter0 = Figure(fig);
figReporter0.Scaling = 'none';
add(rpt,figReporter0);

add(rpt, "Resized by print command");
figReporter1 = Figure(fig);
add(rpt,figReporter1);

add(rpt, "Resized by snapshot reporter");
figReporter2 = Figure(fig);
figReporter2.Scaling = 'none';
figReporter2.Snapshot.ScaleToFit = true;
add(rpt,figReporter2);

close(rpt);
delete(fig)
rptview(rpt);

Вот цифры в созданном отчете:

Вопросы совместимости

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

В R2019b изменилось поведение

Представлен в R2017b