mlreportgen.report.Figure class

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

Изобразите генератор отчетов

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

Описание

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

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

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

HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса (MATLAB).

Создание

Описание

пример

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:

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

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

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

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

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

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

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

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

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

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

  • 'pdf' — Изображение PDF.

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

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

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

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

Примечание

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

Высота снимка состояния отображает для пользовательского масштабирования, заданного как скаляр строки или вектор символов. Это свойство применяется только если Scaling установлен в 'custom'.

Height форматом является valueUnits, где Units сокращение от единиц высоты и value количество модулей. Таблица показывает допустимый Units сокращения.

МодулиМодульное сокращение
'pixels'px
'centimeters'cm
'inches'in
миллиметрыmm
цицероpc
'points'pt

Пример: '3in'

Ширина снимка состояния отображает для пользовательского масштабирования, заданного как скаляр строки или вектор символов. Это свойство применяется только если Scaling установлен в custom.

Width форматом является valueUnits, где Units сокращение от единиц ширины и value количество модулей. Смотрите Height свойство для таблицы допустимого Units сокращения.

Пример: '3in'

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

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

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

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

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

Заданный шаблон должен быть тем же типом как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word Microsoft®, 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);

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

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

Поведение изменяется в R2019b

Смотрите также

| | | |

Темы

Введенный в R2017b

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