mlreportgen.report.Figure class

Пакет: 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 свойство. Не сбрасывайте это свойство.

Изобразите источник в виде a:

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

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

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

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

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

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

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

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

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

  • 'pdf' — Изображение PDF (поддерживаемый только в PDF выход).

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

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

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

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

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

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

Примечание

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

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

Пример: '2in'

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

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

  • cm 'centimeters'

  • in 'inches'

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

  • pc — цицеро

  • pt 'points'

Пример: '3in'

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open 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);
Скрипт Open Live Script

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

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);
Скрипт Open Live Script

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

Создайте широкую фигуру MATLAB®. Создайте три mlreportgen.report.Figure генераторы отчетов от фигуры и добавляют их в отчет.

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

  • Второй 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

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

Поддержка

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