mlreportgen.report.Figure class

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

Репортер фигуры

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

Описание

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

The 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 класс reporter. Репортер использует gcf для получения текущей фигуры MATLAB. Он использует формального репортера изображений, чтобы вставить рисунок в отчет. Чтобы задать размер моментального снимка или подписи, используйте свойства FormalImage объект.

Примечание

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

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

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

  • Допустимый указатель на графику

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

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

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

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

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

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

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

  • 'tif' - Тег Image File формат, не поддерживается в HTML выходных данных.

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

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

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

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

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

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

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

Примечание

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

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

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

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

  • in - дюймы

  • mm - миллиметры

  • pc - picas

  • pt - точки

Пример: '2in'

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

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

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

  • in - дюймы

  • mm - миллиметры

  • pc - picas

  • pt - точки

Пример: '3in'

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

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

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

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

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

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

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

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

Методы

расширить все

Примеры

свернуть все

Открыть Live Script

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

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);
Открыть Live Script

Добавьте два рисунков к отчету. Чтобы разместить их рядом друг с другом на странице, используйте объект 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);
Открыть Live Script

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

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

  • Первый Figure reporter не изменяет размер рисунка.

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

  • The третий Figure reporter использует Snapshot reporter, чтобы изменить размер рисунка.

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

MATLAB Report Generator

Поддержка

Для просмотра документации необходимо авторизоваться на сайте